AWS Proton

2022/09/29 - AWS Proton - 1 updated api methods

Changes  This release adds an option to delete pipeline provisioning repositories using the UpdateAccountSettings API

UpdateAccountSettings (updated) Link ΒΆ
Changes (request)
{'deletePipelineProvisioningRepository': 'boolean'}

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

See also: AWS API Documentation

Request Syntax

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

boolean

param 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 pipelineProvisioningRepository:

dict

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

type pipelineServiceRoleArn:

string

param pipelineServiceRoleArn:

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.

rtype:

dict

returns:

Response Syntax

{
    'accountSettings': {
        '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.

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