Proton / Client / list_repository_sync_definitions

list_repository_sync_definitions

Proton.Client.list_repository_sync_definitions(**kwargs)

List repository sync definitions with detail data.

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.list_repository_sync_definitions(
    nextToken='string',
    repositoryName='string',
    repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
    syncType='TEMPLATE_SYNC'|'SERVICE_SYNC'
)
Parameters:

  • nextToken (string) – A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.

  • repositoryName (string) –

    [REQUIRED]

    The repository name.

  • repositoryProvider (string) –

    [REQUIRED]

    The repository provider.

  • syncType (string) –

    [REQUIRED]

    The sync type. The only supported value is TEMPLATE_SYNC.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'syncDefinitions': [
        {
            'branch': 'string',
            'directory': 'string',
            'parent': 'string',
            'target': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the current requested list of repository sync definitions.

    • syncDefinitions (list) –

      An array of repository sync definitions.

      • (dict) –

        A repository sync definition.

        • branch (string) –

          The repository branch.

        • directory (string) –

          The directory in the repository.

        • parent (string) –

          The resource that is synced from.

        • target (string) –

          The resource that is synced to.

Exceptions

  • Proton.Client.exceptions.ValidationException

  • Proton.Client.exceptions.AccessDeniedException

  • Proton.Client.exceptions.ThrottlingException

  • Proton.Client.exceptions.InternalServerException