ListEnvironments
Provides the list of all Environment objects known to the service.
When creating a Connection, the selected Environment is used to determine the partner and location the resulting connectivity provides access to.
Request Parameters
- location
-
Filter results to only include Environment objects that connect to a given location distiguisher.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Required: No
- maxResults
-
The max number of list results in a single paginated response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
A pagination token from a previous paginated response indicating you wish to get the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- provider
-
Filter results to only include Environment objects that connect to the Provider.
Type: Provider object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
Response Elements
The following elements are returned by the service.
- environments
-
The list of matching Environment objects.
Type: Array of Environment objects
- nextToken
-
A pagination token for use in subsequent calls to fetch the next page of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
The calling principal is not allowed to access the specified resource, or the resource does not exist.
HTTP Status Code: 403
- InterconnectClientException
-
The request was denied due to incorrect client supplied parameters.
HTTP Status Code: 400
- InterconnectServerException
-
The request resulted in an exception internal to the service.
HTTP Status Code: 500
- InterconnectValidationException
-
The input fails to satisfy the constraints specified.
HTTP Status Code: 400
- ResourceNotFoundException
-
The request specifies a resource that does not exist on the server.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The requested operation would result in the calling principal exceeding their allotted quota.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
