Proton / Client / get_account_settings

get_account_settings#

Proton.Client.get_account_settings()#

Get detail data for Proton account-wide settings.

Request Syntax

response = client.get_account_settings()

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 detail data that’s returned by Proton.
  - 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.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException