DeleteAgentAlias
Deletes an alias of an agent.
Request Syntax
DELETE /agents/agentId/agentaliases/agentAliasId/ HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- agentAliasId
-
The unique identifier of the alias to delete.
Length Constraints: Fixed length of 10.
Pattern:
^(\bTSTALIASID\b|[0-9a-zA-Z]+)$Required: Yes
- agentId
-
The unique identifier of the agent that the alias belongs to.
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
{
"agentAliasId": "string",
"agentAliasStatus": "string",
"agentId": "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.
- agentAliasId
-
The unique identifier of the alias that was deleted.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^(\bTSTALIASID\b|[0-9a-zA-Z]+)$ - agentAliasStatus
-
The status of the alias.
Type: String
Valid Values:
CREATING | PREPARED | FAILED | UPDATING | DELETING - agentId
-
The unique identifier of the agent that the alias belongs to.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$
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
- 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
- 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 DeleteAgentAlias.
DELETE /agents/ABCDEFGHIJ/agentaliases/ABCDEFGHIJ/ HTTP/1.1
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
