Proton / Client / get_service_sync_blocker_summary

get_service_sync_blocker_summary#

Proton.Client.get_service_sync_blocker_summary(**kwargs)#

Get detailed data for the service sync blocker summary.

See also: AWS API Documentation

Request Syntax

response = client.get_service_sync_blocker_summary(
    serviceInstanceName='string',
    serviceName='string'
)
Parameters:

  • serviceInstanceName (string) – The name of the service instance that you want to get the service sync blocker summary for. If given bothe the instance name and the service name, only the instance is blocked.

  • serviceName (string) –

    [REQUIRED]

    The name of the service that you want to get the service sync blocker summary for. If given only the service name, all instances are blocked.

Return type:

dict

Returns:

Response Syntax

{
    'serviceSyncBlockerSummary': {
        'latestBlockers': [
            {
                'contexts': [
                    {
                        'key': 'string',
                        'value': 'string'
                    },
                ],
                'createdAt': datetime(2015, 1, 1),
                'createdReason': 'string',
                'id': 'string',
                'resolvedAt': datetime(2015, 1, 1),
                'resolvedReason': 'string',
                'status': 'ACTIVE'|'RESOLVED',
                'type': 'AUTOMATED'
            },
        ],
        'serviceInstanceName': 'string',
        'serviceName': 'string'
    }
}

Response Structure

  • (dict) –

    • serviceSyncBlockerSummary (dict) –

      The detailed data of the requested service sync blocker summary.

      • latestBlockers (list) –

        The latest active blockers for the synced service.

        • (dict) –

          Detailed data of the sync blocker.

          • contexts (list) –

            The contexts for the sync blocker.

            • (dict) –

              Detailed data of the context of the sync blocker.

              • key (string) –

                The key for the sync blocker context.

              • value (string) –

                The value of the sync blocker context.

          • createdAt (datetime) –

            The time when the sync blocker was created.

          • createdReason (string) –

            The reason why the sync blocker was created.

          • id (string) –

            The ID of the sync blocker.

          • resolvedAt (datetime) –

            The time the sync blocker was resolved.

          • resolvedReason (string) –

            The reason the sync blocker was resolved.

          • status (string) –

            The status of the sync blocker.

          • type (string) –

            The type of the sync blocker.

      • serviceInstanceName (string) –

        The name of the service instance that you want sync your service configuration with.

      • serviceName (string) –

        The name of the service that you want to get the sync blocker summary for. If given a service instance name and a service name, it will return the blockers only applying to the instance that is blocked.

        If given only a service name, it will return the blockers that apply to all of the instances. In order to get the blockers for a single instance, you will need to make two distinct calls, one to get the sync blocker summary for the service and the other to get the sync blocker for the service instance.

Exceptions