Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeWorkforce

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.

Important

This operation applies only to private workforces.

Request Syntax


{
   "WorkforceName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

WorkforceName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-]){0,62}$

Required: Yes

Response Syntax


{
   "Workforce": { 
      "CognitoConfig": { 
         "ClientId": "string",
         "UserPool": "string"
      },
      "CreateDate": number,
      "FailureReason": "string",
      "LastUpdatedDate": number,
      "OidcConfig": { 
         "AuthenticationRequestExtraParams": { 
            "string" : "string" 
         },
         "AuthorizationEndpoint": "string",
         "ClientId": "string",
         "Issuer": "string",
         "JwksUri": "string",
         "LogoutEndpoint": "string",
         "Scope": "string",
         "TokenEndpoint": "string",
         "UserInfoEndpoint": "string"
      },
      "SourceIpConfig": { 
         "Cidrs": [ "string" ]
      },
      "Status": "string",
      "SubDomain": "string",
      "WorkforceArn": "string",
      "WorkforceName": "string",
      "WorkforceVpcConfig": { 
         "SecurityGroupIds": [ "string" ],
         "Subnets": [ "string" ],
         "VpcEndpointId": "string",
         "VpcId": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Workforce

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

Type: Workforce object

Errors

For information about the errors that are common to all actions, see Common Errors.