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

CreateWorkerConfiguration

Creates a worker configuration using the specified properties.

Request Syntax


POST /v1/worker-configurations HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "propertiesFileContent": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

description

A summary description of the worker configuration.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

name

The name of the worker configuration.

Type: String

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

Required: Yes

propertiesFileContent

Base64 encoded contents of connect-distributed.properties file.

Type: String

Required: Yes

tags

The tags you want to attach to the worker configuration.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "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.

creationTime

The time that the worker configuration was created.

Type: Timestamp

latestRevision

The latest revision of the worker configuration.

Type: WorkerConfigurationRevisionSummary object

name

The name of the worker configuration.

Type: String

workerConfigurationArn

The Amazon Resource Name (ARN) that Amazon assigned to the worker configuration.

Type: String

workerConfigurationState

The state of the worker configuration.

Type: String

Valid Values: ACTIVE | DELETING

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

ConflictException

HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.

HTTP Status Code: 409

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