Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListWorkerConfigurations

Returns a list of all of the worker configurations in this account and Region.

Request Syntax


GET /v1/worker-configurations?maxResults=maxResults&namePrefix=namePrefix&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of worker configurations to list in one response.

Valid Range: Minimum value of 1. Maximum value of 100.

namePrefix

Lists worker configuration names that start with the specified text string.

nextToken

If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "workerConfigurations": [ 
      { 
         "creationTime": "string",
         "description": "string",
         "latestRevision": { 
            "creationTime": "string",
            "description": "string",
            "revision": number
         },
         "name": "string",
         "workerConfigurationArn": "string",
         "workerConfigurationState": "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.

nextToken

Type: String

workerConfigurations

An array of worker configuration descriptions.

Type: Array of WorkerConfigurationSummary objects

Errors

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

BadRequestException

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

HTTP Status Code: 400

ForbiddenException

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

HTTP Status Code: 403

InternalServerErrorException

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

HTTP Status Code: 500

NotFoundException

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

HTTP Status Code: 404

ServiceUnavailableException

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

HTTP Status Code: 503

TooManyRequestsException

HTTP Status Code 429: Limit exceeded. Resource limit reached.

HTTP Status Code: 429

UnauthorizedException

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

HTTP Status Code: 401