Proton / Paginator / ListEnvironmentAccountConnections
ListEnvironmentAccountConnections#
- class Proton.Paginator.ListEnvironmentAccountConnections#
paginator = client.get_paginator('list_environment_account_connections')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
Proton.Client.list_environment_account_connections()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( environmentName='string', requestedBy='MANAGEMENT_ACCOUNT'|'ENVIRONMENT_ACCOUNT', statuses=[ 'PENDING'|'CONNECTED'|'REJECTED', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
environmentName (string) – The environment name that’s associated with each listed environment account connection.
requestedBy (string) –
[REQUIRED]
The type of account making the
ListEnvironmentAccountConnections
request.statuses (list) –
The status details for each listed environment account connection.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'environmentAccountConnections': [ { 'arn': 'string', 'componentRoleArn': 'string', 'environmentAccountId': 'string', 'environmentName': 'string', 'id': 'string', 'lastModifiedAt': datetime(2015, 1, 1), 'managementAccountId': 'string', 'requestedAt': datetime(2015, 1, 1), 'roleArn': 'string', 'status': 'PENDING'|'CONNECTED'|'REJECTED' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
environmentAccountConnections (list) –
An array of environment account connections with details that’s returned by Proton.
(dict) –
Summary data of an Proton environment account connection resource.
arn (string) –
The Amazon Resource Name (ARN) of the environment account connection.
componentRoleArn (string) –
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a
componentRoleArn
to allow directly defined components to be associated with any environments running in the account.For more information about components, see Proton components in the Proton User Guide.
environmentAccountId (string) –
The ID of the environment account that’s connected to the environment account connection.
environmentName (string) –
The name of the environment that’s associated with the environment account connection.
id (string) –
The ID of the environment account connection.
lastModifiedAt (datetime) –
The time when the environment account connection was last modified.
managementAccountId (string) –
The ID of the management account that’s connected to the environment account connection.
requestedAt (datetime) –
The time when the environment account connection request was made.
roleArn (string) –
The IAM service role that’s associated with the environment account connection.
status (string) –
The status of the environment account connection.
NextToken (string) –
A token to resume pagination.