DeleteAgent
Deletes an agent.
Request Syntax
DELETE /agents/agentId/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- agentId
-
The unique identifier of the agent to delete.
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
- skipResourceInUseCheck
-
By default, this value is
falseand deletion is stopped if the resource is in use. If you set it totrue, the resource will be deleted even if the resource is in use.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"agentId": "string",
"agentStatus": "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 that was deleted.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$ - agentStatus
-
The status of the agent.
Type: String
Valid Values:
CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATING
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
- 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 DeleteAgent.
DELETE /agents/ABCDEFGHIJ/ HTTP/1.1See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
