In an environment account, update an environment account connection to use a new IAM role.
For more information, see Environment account connections in the AWS Proton User guide.
Request Syntax
{
"codebuildRoleArn": "string",
"componentRoleArn": "string",
"id": "string",
"roleArn": "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.
- codebuildRoleArn
-
The Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$Required: No
- componentRoleArn
-
The Amazon Resource Name (ARN) of the IAM service role that AWS 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
componentRoleArnto allow directly defined components to be associated with any environments running in the account.For more information about components, see AWS Proton components in the AWS Proton User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$Required: No
- id
-
The ID of the environment account connection to update.
Type: String
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Required: Yes
- roleArn
-
The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$Required: No
Response Syntax
{
"environmentAccountConnection": {
"arn": "string",
"codebuildRoleArn": "string",
"componentRoleArn": "string",
"environmentAccountId": "string",
"environmentName": "string",
"id": "string",
"lastModifiedAt": number,
"managementAccountId": "string",
"requestedAt": number,
"roleArn": "string",
"status": "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.
- environmentAccountConnection
-
The environment account connection detail data that's returned by AWS Proton.
Type: EnvironmentAccountConnection object
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
- ConflictException
-
The request couldn't be made due to a conflicting operation or resource.
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:
