Proton / Client / get_repository_sync_status

get_repository_sync_status#

Proton.Client.get_repository_sync_status(**kwargs)#

Get the sync status of a repository used for Proton template sync. For more information about template sync, see .

Note

A repository sync status isn’t tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can’t use these tags to control access to this action using Attribute-based access control (ABAC).

For more information about ABAC, see ABAC in the Proton User Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_repository_sync_status(
    branch='string',
    repositoryName='string',
    repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
    syncType='TEMPLATE_SYNC'
)
Parameters:

  • branch (string) –

    [REQUIRED]

    The repository branch.

  • repositoryName (string) –

    [REQUIRED]

    The repository name.

  • repositoryProvider (string) –

    [REQUIRED]

    The repository provider.

  • syncType (string) –

    [REQUIRED]

    The repository sync type.

Return type:

dict

Returns:

Response Syntax

{
    'latestSync': {
        'events': [
            {
                'event': 'string',
                'externalId': 'string',
                'time': datetime(2015, 1, 1),
                'type': 'string'
            },
        ],
        'startedAt': datetime(2015, 1, 1),
        'status': 'INITIATED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'QUEUED'
    }
}

Response Structure

  • (dict) –

    • latestSync (dict) –

      The repository sync status detail data that’s returned by Proton.

      • events (list) –

        Detail data for sync attempt events.

        • (dict) –

          Repository sync event detail data for a sync attempt.

          • event (string) –

            Event detail for a repository sync attempt.

          • externalId (string) –

            The external ID of the sync event.

          • time (datetime) –

            The time that the sync event occurred.

          • type (string) –

            The type of event.

      • startedAt (datetime) –

        The time when the sync attempt started.

      • status (string) –

        The sync attempt status.

Exceptions

  • Proton.Client.exceptions.ValidationException

  • Proton.Client.exceptions.AccessDeniedException

  • Proton.Client.exceptions.ThrottlingException

  • Proton.Client.exceptions.ResourceNotFoundException

  • Proton.Client.exceptions.InternalServerException