Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetEnvironment

Returns a description of the specified environment.

Request Syntax


{
   "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.

Note

In the following list, the required parameters are described first.

environmentId

A unique ID for the environment.

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 requested 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