Proton / Client / get_repository

get_repository

Proton.Client.get_repository(**kwargs)

Get detail data for a linked repository.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.get_repository(
    name='string',
    provider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
)
Parameters:

  • name (string) –

    [REQUIRED]

    The repository name, for example myrepos/myrepo.

  • provider (string) –

    [REQUIRED]

    The repository provider.

Return type:

dict

Returns:

Response Syntax

{
    'repository': {
        'arn': 'string',
        'connectionArn': 'string',
        'encryptionKey': 'string',
        'name': 'string',
        'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
    }
}

Response Structure

  • (dict) –

    • repository (dict) –

      The repository link’s detail data that’s returned by Proton.

      • arn (string) –

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

      • connectionArn (string) –

        The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account.

      • encryptionKey (string) –

        Your customer Amazon Web Services KMS encryption key.

      • name (string) –

        The repository name.

      • provider (string) –

        The repository provider.

Exceptions