[ aws . sagemaker ]

list-workforces

Description

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-workforces is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Workforces

Synopsis

  list-workforces
[--sort-by <value>]
[--sort-order <value>]
[--name-contains <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--sort-by (string)

Sort workforces using the workforce name or creation date.

Possible values:

• Name

• CreateDate

--sort-order (string)

Sort workforces in ascending or descending order.

Possible values:

• Ascending

• Descending

--name-contains (string)

A filter you can use to search for workforces using part of the workforce name.

--cli-input-json | --cli-input-yaml (string) 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 --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) 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.

See ‘aws help’ for descriptions of global parameters.

Output

Workforces -> (list)

A list containing information about your 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

Note

The following Length Constraints apply to individual CIDR values in the CIDR value list.

(string)

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.

NextToken -> (string)

A token to resume pagination.