Proton / Client / get_environment_account_connection

get_environment_account_connection#

Proton.Client.get_environment_account_connection(**kwargs)#

In an environment account, get the detailed data for an environment account connection.

For more information, see Environment account connections in the Proton User guide.

See also: AWS API Documentation

Request Syntax

response = client.get_environment_account_connection(
    id='string'
)
Parameters:

id (string) –

[REQUIRED]

The ID of the environment account connection that you want to get the detailed data for.

Return type:

dict

Returns:

Response Syntax

{
    'environmentAccountConnection': {
        'arn': 'string',
        'codebuildRoleArn': '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'
    }
}

Response Structure

  • (dict) –

    • environmentAccountConnection (dict) –

      The detailed data of the requested environment account connection.

      • arn (string) –

        The Amazon Resource Name (ARN) of the environment account connection.

      • codebuildRoleArn (string) –

        The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

      • 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 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.

Exceptions