UpdateAccountSettings - AWS Proton

UpdateAccountSettings

Update AWS Proton settings that are used for multiple services in the AWS account.

Request Syntax

{ "deletePipelineProvisioningRepository": boolean, "pipelineProvisioningRepository": { "branch": "string", "name": "string", "provider": "string" }, "pipelineServiceRoleArn": "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.

deletePipelineProvisioningRepository

Set to true to remove a configured pipeline repository from the account settings. Don't set this field if you are updating the configured pipeline repository.

Type: Boolean

Required: No

pipelineProvisioningRepository

A linked repository for pipeline provisioning. Specify it if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with AWS Proton. For more information, see CreateRepository.

To remove a previously configured repository, set deletePipelineProvisioningRepository to true, and don't set pipelineProvisioningRepository.

Type: RepositoryBranchInput object

Required: No

pipelineServiceRoleArn

The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by AWS Proton for AWS-managed provisioning, and by customer-owned automation for self-managed provisioning.

To remove a previously configured ARN, specify an empty string.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: (^$)|(^arn:[a-zA-Z-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d*:[\w+=\/:,\.@-]*)

Required: No

Response Syntax

{ "accountSettings": { "pipelineProvisioningRepository": { "arn": "string", "branch": "string", "name": "string", "provider": "string" }, "pipelineServiceRoleArn": "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.

accountSettings

The AWS Proton pipeline service role and repository data shared across the AWS account.

Type: AccountSettings 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

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: