StartOutpostDecommission
Starts the decommission process to return the Outposts racks or servers.
Request Syntax
POST /outposts/OutpostId
/decommission HTTP/1.1
Content-type: application/json
{
"ValidateOnly": boolean
}
URI Request Parameters
The request uses the following URI parameters.
- OutpostId
-
The ID or ARN of the Outpost that you want to decommission.
Length Constraints: Minimum length of 1. Maximum length of 180.
Pattern:
^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$
Required: Yes
Request Body
The request accepts the following data in JSON format.
- ValidateOnly
-
Validates the request without starting the decommission process.
Type: Boolean
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"BlockingResourceTypes": [ "string" ],
"Status": "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.
- BlockingResourceTypes
-
The resources still associated with the Outpost that you are decommissioning.
Type: Array of strings
Valid Values:
EC2_INSTANCE | OUTPOST_RAM_SHARE | LGW_ROUTING_DOMAIN | LGW_ROUTE_TABLE | LGW_VIRTUAL_INTERFACE_GROUP | OUTPOST_ORDER_CANCELLABLE | OUTPOST_ORDER_INTERVENTION_REQUIRED
- Status
-
The status of the decommission request.
Type: String
Valid Values:
SKIPPED | BLOCKED | REQUESTED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have permission to perform this operation.
HTTP Status Code: 403
- ConflictException
-
Updating or deleting this resource can cause an inconsistent state.
- ResourceId
-
The ID of the resource causing the conflict.
- ResourceType
-
The type of the resource causing the conflict.
HTTP Status Code: 409
- InternalServerException
-
An internal error has occurred.
HTTP Status Code: 500
- NotFoundException
-
The specified request is not valid.
HTTP Status Code: 404
- ValidationException
-
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: