Proton / Paginator / ListRepositorySyncDefinitions

ListRepositorySyncDefinitions

class Proton.Paginator.ListRepositorySyncDefinitions

paginator = client.get_paginator('list_repository_sync_definitions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Proton.Client.list_repository_sync_definitions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    repositoryName='string',
    repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
    syncType='TEMPLATE_SYNC',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

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

  • NextToken (string) –

    A token to resume pagination.