DeleteEnvironment
Deletes an AWS Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first delete any applications and services within the environment.
Request Syntax
DELETE /environments/EnvironmentIdentifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- EnvironmentIdentifier
-
The ID of the environment.
Length Constraints: Fixed length of 14.
Pattern:
^env-[0-9A-Za-z]{10}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"EnvironmentId": "string",
"LastUpdatedTime": number,
"Name": "string",
"State": "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.
- Arn
-
The Amazon Resource Name (ARN) of the environment.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+$ - EnvironmentId
-
The unique identifier of the environment.
Type: String
Length Constraints: Fixed length of 14.
Pattern:
^env-[0-9A-Za-z]{10}$ - LastUpdatedTime
-
A timestamp that indicates when the environment was last updated.
Type: Timestamp
- Name
-
The name of the environment.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$ - State
-
The current state of the environment.
Type: String
Valid Values:
CREATING | ACTIVE | DELETING | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The user does not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
An unexpected error occurred while processing the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource that does not exist.
HTTP Status Code: 404
- ThrottlingException
-
Request was denied because the request was throttled.
HTTP Status Code: 429
- ValidationException
-
The input does not satisfy the constraints specified by an AWS 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:
