DeleteGateway
Deletes a Gateway.
Request Syntax
DELETE /gateways/gatewayIdentifier
/ HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- gatewayIdentifier
-
The identifier of the gateway to delete. This can be either the gateway ID or the gateway ARN.
Pattern:
([0-9a-z][-]?){1,100}-[0-9a-z]{10}
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"gatewayId": "string",
"status": "string",
"statusReasons": [ "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.
- gatewayId
-
The unique identifier of the deleted Gateway.
Type: String
Pattern:
([0-9a-z][-]?){1,100}-[0-9a-z]{10}
- status
-
The current status of the Gateway deletion.
Type: String
Valid Values:
CREATING | UPDATING | UPDATE_UNSUCCESSFUL | DELETING | READY | FAILED
- statusReasons
-
The reasons for the current status of the Gateway deletion.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
This exception is thrown when a request is denied per access permissions
HTTP Status Code: 403
- ConflictException
-
This exception is thrown when there is a conflict performing an operation
HTTP Status Code: 409
- InternalServerException
-
This exception is thrown if there was an unexpected error during processing of request
HTTP Status Code: 500
- ResourceNotFoundException
-
This exception is thrown when a resource referenced by the operation does not exist
HTTP Status Code: 404
- ThrottlingException
-
This exception is thrown when the number of requests exceeds the limit
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by the service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: