ListEnvironments
List environments with detail data summaries.
Request Syntax
{
"environmentTemplates": [
{
"majorVersion": "string",
"templateName": "string"
}
],
"maxResults": number,
"nextToken": "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.
- environmentTemplates
-
An array of the versions of the environment template.
Type: Array of EnvironmentTemplateFilter objects
Required: No
- maxResults
-
The maximum number of environments to list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
A token that indicates the location of the next environment in the array of environments, after the list of environments that was previously requested.
Type: String
Pattern:
^[A-Za-z0-9+=/]+$Required: No
Response Syntax
{
"environments": [
{
"arn": "string",
"componentRoleArn": "string",
"createdAt": number,
"deploymentStatus": "string",
"deploymentStatusMessage": "string",
"description": "string",
"environmentAccountConnectionId": "string",
"environmentAccountId": "string",
"lastAttemptedDeploymentId": "string",
"lastDeploymentAttemptedAt": number,
"lastDeploymentSucceededAt": number,
"lastSucceededDeploymentId": "string",
"name": "string",
"protonServiceRoleArn": "string",
"provisioning": "string",
"templateMajorVersion": "string",
"templateMinorVersion": "string",
"templateName": "string"
}
],
"nextToken": "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.
- environments
-
An array of environment detail data summaries.
Type: Array of EnvironmentSummary objects
- nextToken
-
A token that indicates the location of the next environment in the array of environments, after the current requested list of environments.
Type: String
Pattern:
^[A-Za-z0-9+=/]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
There isn't sufficient access for performing this action.
HTTP Status Code: 400
- InternalServerException
-
The request failed to register with the service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource wasn't found.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
