Proton / Client / update_environment_account_connection
update_environment_account_connection#
- Proton.Client.update_environment_account_connection(**kwargs)#
In an environment account, update an environment account connection to use a new IAM role.
For more information, see Environment account connections in the Proton User guide.
See also: AWS API Documentation
Request Syntax
response = client.update_environment_account_connection( codebuildRoleArn='string', componentRoleArn='string', id='string', roleArn='string' )
- Parameters:
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.
id (string) –
[REQUIRED]
The ID of the environment account connection to update.
roleArn (string) – The Amazon Resource Name (ARN) of the IAM service role that’s associated with the environment account connection to update.
- 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 environment account connection detail data that’s returned by Proton.
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
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException