CodeStarconnections / Client / get_repository_sync_status

get_repository_sync_status#

CodeStarconnections.Client.get_repository_sync_status(**kwargs)#

Returns details about the sync status for a repository. A repository sync uses Git sync to push and pull changes from your remote repository.

See also: AWS API Documentation

Request Syntax

response = client.get_repository_sync_status(
    Branch='string',
    RepositoryLinkId='string',
    SyncType='CFN_STACK_SYNC'
)
Parameters:

  • Branch (string) –

    [REQUIRED]

    The branch of the repository link for the requested repository sync status.

  • RepositoryLinkId (string) –

    [REQUIRED]

    The repository link ID for the requested repository sync status.

  • SyncType (string) –

    [REQUIRED]

    The sync type of the requested sync status.

Return type:

dict

Returns:

Response Syntax

{
    'LatestSync': {
        'StartedAt': datetime(2015, 1, 1),
        'Status': 'FAILED'|'INITIATED'|'IN_PROGRESS'|'SUCCEEDED'|'QUEUED',
        'Events': [
            {
                'Event': 'string',
                'ExternalId': 'string',
                'Time': datetime(2015, 1, 1),
                'Type': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • LatestSync (dict) –

      The status of the latest sync returned for a specified repository and branch.

      • StartedAt (datetime) –

        The start time of a specific sync attempt.

      • Status (string) –

        The status of a specific sync attempt. The following are valid statuses:

        • INITIATED - A repository sync attempt has been created and will begin soon.

        • IN_PROGRESS - A repository sync attempt has started and work is being done to reconcile the branch.

        • SUCCEEDED - The repository sync attempt has completed successfully.

        • FAILED - The repository sync attempt has failed.

        • QUEUED - The repository sync attempt didn’t execute and was queued.

      • Events (list) –

        The events associated with a specific sync attempt.

        • (dict) –

          Information about a repository sync event.

          • Event (string) –

            A description of a repository sync event.

          • ExternalId (string) –

            The ID for a repository sync event.

          • Time (datetime) –

            The time that a repository sync event occurred.

          • Type (string) –

            The event type for a repository sync event.

Exceptions