PrepareAgent
Creates a DRAFT version of the agent that can be used for internal testing.
Request Syntax
POST /agents/agentId/ HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- agentId
-
The unique identifier of the agent for which to create a
DRAFTversion.Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"agentId": "string",
"agentStatus": "string",
"agentVersion": "string",
"preparedAt": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- agentId
-
The unique identifier of the agent for which the
DRAFTversion was created.Type: String
Pattern:
^[0-9a-zA-Z]{10}$ - agentStatus
-
The status of the
DRAFTversion and whether it is ready for use.Type: String
Valid Values:
CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATING - agentVersion
-
The version of the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$ - preparedAt
-
The time at which the
DRAFTversion of the agent was last prepared.Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- ConflictException
-
There was a conflict performing an operation.
HTTP Status Code: 409
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
Examples
Example request
This example illustrates one usage of PrepareAgent.
POST /agents/ABCDEFGHIJ/ HTTP/1.1See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
