ListEnvironmentAccountConnections
View a list of environment account connections.
For more information, see Environment account connections in the AWS Proton User guide.
Request Syntax
{
"environmentName": "string",
"maxResults": number,
"nextToken": "string",
"requestedBy": "string",
"statuses": [ "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.
- environmentName
-
The environment name that's associated with each listed environment account connection.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[0-9A-Za-z]+[0-9A-Za-z_\-]*$Required: No
- maxResults
-
The maximum number of environment account connections 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 account connection in the array of environment account connections, after the list of environment account connections that was previously requested.
Type: String
Pattern:
^[A-Za-z0-9+=/]+$Required: No
- requestedBy
-
The type of account making the
ListEnvironmentAccountConnectionsrequest.Type: String
Valid Values:
MANAGEMENT_ACCOUNT | ENVIRONMENT_ACCOUNTRequired: Yes
- statuses
-
The status details for each listed environment account connection.
Type: Array of strings
Valid Values:
PENDING | CONNECTED | REJECTEDRequired: No
Response Syntax
{
"environmentAccountConnections": [
{
"arn": "string",
"componentRoleArn": "string",
"environmentAccountId": "string",
"environmentName": "string",
"id": "string",
"lastModifiedAt": number,
"managementAccountId": "string",
"requestedAt": number,
"roleArn": "string",
"status": "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.
- environmentAccountConnections
-
An array of environment account connections with details that's returned by AWS Proton.
Type: Array of EnvironmentAccountConnectionSummary objects
- nextToken
-
A token that indicates the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.
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
- 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:
