Proton / Client / get_service_instance_sync_status

get_service_instance_sync_status

Proton.Client.get_service_instance_sync_status(**kwargs)

Get the status of the synced service instance.

See also: AWS API Documentation

Request Syntax

response = client.get_service_instance_sync_status(
    serviceInstanceName='string',
    serviceName='string'
)

Parameters:

• serviceInstanceName (string) –

  [REQUIRED]

  The name of the service instance that you want the sync status input for.

• serviceName (string) –

  [REQUIRED]

  The name of the service that the service instance belongs to.

Return type:

dict

Returns:

Response Syntax

{
    'desiredState': {
        'branch': 'string',
        'directory': 'string',
        'repositoryName': 'string',
        'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        'sha': 'string'
    },
    'latestSuccessfulSync': {
        'events': [
            {
                'event': 'string',
                'externalId': 'string',
                'time': datetime(2015, 1, 1),
                'type': 'string'
            },
        ],
        'initialRevision': {
            'branch': 'string',
            'directory': 'string',
            'repositoryName': 'string',
            'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
            'sha': 'string'
        },
        'startedAt': datetime(2015, 1, 1),
        'status': 'INITIATED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
        'target': 'string',
        'targetRevision': {
            'branch': 'string',
            'directory': 'string',
            'repositoryName': 'string',
            'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
            'sha': 'string'
        }
    },
    'latestSync': {
        'events': [
            {
                'event': 'string',
                'externalId': 'string',
                'time': datetime(2015, 1, 1),
                'type': 'string'
            },
        ],
        'initialRevision': {
            'branch': 'string',
            'directory': 'string',
            'repositoryName': 'string',
            'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
            'sha': 'string'
        },
        'startedAt': datetime(2015, 1, 1),
        'status': 'INITIATED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
        'target': 'string',
        'targetRevision': {
            'branch': 'string',
            'directory': 'string',
            'repositoryName': 'string',
            'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
            'sha': 'string'
        }
    }
}

Response Structure

• (dict) –

  • desiredState (dict) –

    The service instance sync desired state that’s returned by Proton

    • branch (string) –

      The repository branch.

    • directory (string) –

      The repository directory changed by a commit and push that activated the sync attempt.

    • repositoryName (string) –

      The repository name.

    • repositoryProvider (string) –

      The repository provider.

    • sha (string) –

      The secure hash algorithm (SHA) hash for the revision.

  • latestSuccessfulSync (dict) –

    The detailed data of the latest successful sync with the service instance.

    • events (list) –

      An array of events with detail data.

      • (dict) –

        Detail data for a resource sync event.

        • event (string) –

          A resource sync event.

        • externalId (string) –

          The external ID for the event.

        • time (datetime) –

          The time when the event occurred.

        • type (string) –

          The type of event.

    • initialRevision (dict) –

      Detail data for the initial repository commit, path and push.

      • branch (string) –

        The repository branch.

      • directory (string) –

        The repository directory changed by a commit and push that activated the sync attempt.

      • repositoryName (string) –

        The repository name.

      • repositoryProvider (string) –

        The repository provider.

      • sha (string) –

        The secure hash algorithm (SHA) hash for the revision.

    • startedAt (datetime) –

      The time when the sync attempt started.

    • status (string) –

      The status of the sync attempt.

    • target (string) –

      The resource that is synced to.

    • targetRevision (dict) –

      Detail data for the target revision.

      • branch (string) –

        The repository branch.

      • directory (string) –

        The repository directory changed by a commit and push that activated the sync attempt.

      • repositoryName (string) –

        The repository name.

      • repositoryProvider (string) –

        The repository provider.

      • sha (string) –

        The secure hash algorithm (SHA) hash for the revision.

  • latestSync (dict) –

    The detailed data of the latest sync with the service instance.

    • events (list) –

      An array of events with detail data.

      • (dict) –

        Detail data for a resource sync event.

        • event (string) –

          A resource sync event.

        • externalId (string) –

          The external ID for the event.

        • time (datetime) –

          The time when the event occurred.

        • type (string) –

          The type of event.

    • initialRevision (dict) –

      Detail data for the initial repository commit, path and push.

      • branch (string) –

        The repository branch.

      • directory (string) –

        The repository directory changed by a commit and push that activated the sync attempt.

      • repositoryName (string) –

        The repository name.

      • repositoryProvider (string) –

        The repository provider.

      • sha (string) –

        The secure hash algorithm (SHA) hash for the revision.

    • startedAt (datetime) –

      The time when the sync attempt started.

    • status (string) –

      The status of the sync attempt.

    • target (string) –

      The resource that is synced to.

    • targetRevision (dict) –

      Detail data for the target revision.

      • branch (string) –

        The repository branch.

      • directory (string) –

        The repository directory changed by a commit and push that activated the sync attempt.

      • repositoryName (string) –

        The repository name.

      • repositoryProvider (string) –

        The repository provider.

      • sha (string) –

        The secure hash algorithm (SHA) hash for the revision.

Exceptions

• Proton.Client.exceptions.ValidationException

• Proton.Client.exceptions.AccessDeniedException

• Proton.Client.exceptions.ThrottlingException

• Proton.Client.exceptions.ResourceNotFoundException

• Proton.Client.exceptions.InternalServerException