SageMaker / Client / describe_workforce

describe_workforce

SageMaker.Client.describe_workforce(**kwargs)

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.

Warning

This operation applies only to private workforces.

See also: AWS API Documentation

Request Syntax

response = client.describe_workforce(
    WorkforceName='string'
)

Parameters:

WorkforceName (string) –

[REQUIRED]

The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

Return type:

dict

Returns:

Response Syntax

{
    'Workforce': {
        'WorkforceName': 'string',
        'WorkforceArn': 'string',
        'LastUpdatedDate': datetime(2015, 1, 1),
        'SourceIpConfig': {
            'Cidrs': [
                'string',
            ]
        },
        'SubDomain': 'string',
        'CognitoConfig': {
            'UserPool': 'string',
            'ClientId': 'string'
        },
        'OidcConfig': {
            'ClientId': 'string',
            'Issuer': 'string',
            'AuthorizationEndpoint': 'string',
            'TokenEndpoint': 'string',
            'UserInfoEndpoint': 'string',
            'LogoutEndpoint': 'string',
            'JwksUri': 'string'
        },
        'CreateDate': datetime(2015, 1, 1),
        'WorkforceVpcConfig': {
            'VpcId': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'Subnets': [
                'string',
            ],
            'VpcEndpointId': 'string'
        },
        'Status': 'Initializing'|'Updating'|'Deleting'|'Failed'|'Active',
        'FailureReason': 'string'
    }
}

Response Structure

• (dict) –

  • Workforce (dict) –

    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 (datetime) –

      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 (dict) –

      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 (dict) –

      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 (dict) –

      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 (datetime) –

      The date that the workforce is created.

    • WorkforceVpcConfig (dict) –

      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.

        • (string) –

      • Subnets (list) –

        The ID of the subnets in the VPC that you want to connect.

        • (string) –

      • 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.