Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DeleteEnvironment

Note

Amazon EVS is in public preview release and is subject to change.

Deletes an Amazon EVS environment.

Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the DeleteEnvironmentHost action.

Environment deletion also deletes the associated Amazon EVS VLAN subnets. Other associated AWS resources are not deleted. These resources may continue to incur costs.

Request Syntax


{
   "clientToken": "string",
   "environmentId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

clientToken

Note

This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [!-~]+

Required: No

environmentId

A unique ID associated with the environment to be deleted.

Type: String

Pattern: (env-[a-zA-Z0-9]{10})

Required: Yes

Response Syntax


{
   "environment": { 
      "checks": [ 
         { 
            "impairedSince": number,
            "result": "string",
            "type": "string"
         }
      ],
      "connectivityInfo": { 
         "privateRouteServerPeerings": [ "string" ]
      },
      "createdAt": number,
      "credentials": [ 
         { 
            "secretArn": "string"
         }
      ],
      "environmentArn": "string",
      "environmentId": "string",
      "environmentName": "string",
      "environmentState": "string",
      "environmentStatus": "string",
      "kmsKeyId": "string",
      "licenseInfo": [ 
         { 
            "solutionKey": "string",
            "vsanKey": "string"
         }
      ],
      "modifiedAt": number,
      "serviceAccessSecurityGroups": { 
         "securityGroups": [ "string" ]
      },
      "serviceAccessSubnetId": "string",
      "siteId": "string",
      "stateDetails": "string",
      "termsAccepted": boolean,
      "vcfHostnames": { 
         "cloudBuilder": "string",
         "nsx": "string",
         "nsxEdge1": "string",
         "nsxEdge2": "string",
         "nsxManager1": "string",
         "nsxManager2": "string",
         "nsxManager3": "string",
         "sddcManager": "string",
         "vCenter": "string"
      },
      "vcfVersion": "string",
      "vpcId": "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.

environment

A description of the deleted environment.

Type: Environment object

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.

HTTP Status Code: 400