Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs ). Allowable IP address ranges are the IP addresses that workers can use to access tasks.
This operation applies only to private workforces.
See also: AWS API Documentation
describe-workforce --workforce-name <value> [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
The name of the private workforce whose access you want to restrict.
WorkforceNameis automatically set to
defaultwhen a workforce is created and cannot be modified.
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value
input, prints a sample input JSON that can be used as an argument for
--cli-input-json. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
Workforce -> (structure)
A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce .
WorkforceName -> (string)
The name of the private workforce.
WorkforceArn -> (string)
The Amazon Resource Name (ARN) of the private workforce.
LastUpdatedDate -> (timestamp)
The most recent date that was used to successfully add one or more IP address ranges (CIDRs ) to a private workforce’s allow list.
SourceIpConfig -> (structure)
A list of one to ten IP address ranges (CIDRs ) to be added to the workforce allow list. By default, a workforce isn’t restricted to specific IP addresses.
Cidrs -> (list)
A list of one to ten Classless Inter-Domain Routing (CIDR) values.
Maximum: Ten CIDR values
The following Length Constraints apply to individual CIDR values in the CIDR value list.
SubDomain -> (string)
The subdomain for your OIDC Identity Provider.
CognitoConfig -> (structure)
The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool .
UserPool -> (string)
A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.
ClientId -> (string)
The client ID for your Amazon Cognito user pool.
OidcConfig -> (structure)
The configuration of an OIDC Identity Provider (IdP) private workforce.
ClientId -> (string)
The OIDC IdP client ID used to configure your private workforce.
Issuer -> (string)
The OIDC IdP issuer used to configure your private workforce.
AuthorizationEndpoint -> (string)
The OIDC IdP authorization endpoint used to configure your private workforce.
TokenEndpoint -> (string)
The OIDC IdP token endpoint used to configure your private workforce.
UserInfoEndpoint -> (string)
The OIDC IdP user information endpoint used to configure your private workforce.
LogoutEndpoint -> (string)
The OIDC IdP logout endpoint used to configure your private workforce.
JwksUri -> (string)
The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
CreateDate -> (timestamp)
The date that the workforce is created.
WorkforceVpcConfig -> (structure)
The configuration of a VPC workforce.
VpcId -> (string)
The ID of the VPC that the workforce uses for communication.
SecurityGroupIds -> (list)
The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
Subnets -> (list)
The ID of the subnets in the VPC that you want to connect.
VpcEndpointId -> (string)
The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.
Status -> (string)
The status of your workforce.
FailureReason -> (string)
The reason your workforce failed.