Proton / Client / update_account_settings

update_account_settings

Proton.Client.update_account_settings(**kwargs)

Update Proton settings that are used for multiple services in the Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.update_account_settings(
    deletePipelineProvisioningRepository=True|False,
    pipelineCodebuildRoleArn='string',
    pipelineProvisioningRepository={
        'branch': 'string',
        'name': 'string',
        'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
    },
    pipelineServiceRoleArn='string'
)

Parameters:

• deletePipelineProvisioningRepository (boolean) – 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.

• pipelineCodebuildRoleArn (string) – The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.

• pipelineProvisioningRepository (dict) –

  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 Proton. For more information, see CreateRepository.

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

  • branch (string) – [REQUIRED]

    The repository branch.

  • name (string) – [REQUIRED]

    The repository name.

  • provider (string) – [REQUIRED]

    The repository provider.

• pipelineServiceRoleArn (string) –

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

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

Return type:

dict

Returns:

Response Syntax

{
    'accountSettings': {
        'pipelineCodebuildRoleArn': 'string',
        'pipelineProvisioningRepository': {
            'arn': 'string',
            'branch': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
        'pipelineServiceRoleArn': 'string'
    }
}

Response Structure

• (dict) –

  • accountSettings (dict) –

    The Proton pipeline service role and repository data shared across the Amazon Web Services account.

    • pipelineCodebuildRoleArn (string) –

      The Amazon Resource Name (ARN) of the service role that Proton uses for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.

    • pipelineProvisioningRepository (dict) –

      The linked repository for pipeline provisioning. Required 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 Proton. For more information, see CreateRepository.

      • arn (string) –

        The Amazon Resource Name (ARN) of the linked repository.

      • branch (string) –

        The repository branch.

      • name (string) –

        The repository name.

      • provider (string) –

        The repository provider.

    • pipelineServiceRoleArn (string) –

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

Exceptions

• Proton.Client.exceptions.ValidationException

• Proton.Client.exceptions.AccessDeniedException

• Proton.Client.exceptions.ThrottlingException

• Proton.Client.exceptions.ConflictException

• Proton.Client.exceptions.InternalServerException