CodeStarconnections / Client / get_sync_blocker_summary

get_sync_blocker_summary#

CodeStarconnections.Client.get_sync_blocker_summary(**kwargs)#

Returns a list of the most recent sync blockers.

See also: AWS API Documentation

Request Syntax

response = client.get_sync_blocker_summary(
    SyncType='CFN_STACK_SYNC',
    ResourceName='string'
)
Parameters:

  • SyncType (string) –

    [REQUIRED]

    The sync type for the sync blocker summary.

  • ResourceName (string) –

    [REQUIRED]

    The name of the Amazon Web Services resource currently blocked from automatically being synced from a Git repository.

Return type:

dict

Returns:

Response Syntax

{
    'SyncBlockerSummary': {
        'ResourceName': 'string',
        'ParentResourceName': 'string',
        'LatestBlockers': [
            {
                'Id': 'string',
                'Type': 'AUTOMATED',
                'Status': 'ACTIVE'|'RESOLVED',
                'CreatedReason': 'string',
                'CreatedAt': datetime(2015, 1, 1),
                'Contexts': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'ResolvedReason': 'string',
                'ResolvedAt': datetime(2015, 1, 1)
            },
        ]
    }
}

Response Structure

  • (dict) –

    • SyncBlockerSummary (dict) –

      The list of sync blockers for a specified resource.

      • ResourceName (string) –

        The resource name for sync blocker summary.

      • ParentResourceName (string) –

        The parent resource name for a sync blocker summary.

      • LatestBlockers (list) –

        The latest events for a sync blocker summary.

        • (dict) –

          Information about a blocker for a sync event.

          • Id (string) –

            The ID for a specific sync blocker.

          • Type (string) –

            The sync blocker type.

          • Status (string) –

            The status for a specific sync blocker.

          • CreatedReason (string) –

            The provided reason for a specific sync blocker.

          • CreatedAt (datetime) –

            The creation time for a specific sync blocker.

          • Contexts (list) –

            The contexts for a specific sync blocker.

            • (dict) –

              The context for a specific sync blocker.

              • Key (string) –

                The key provided for a context key-value pair for a specific sync blocker.

              • Value (string) –

                The value provided for a context key-value pair for a specific sync blocker.

          • ResolvedReason (string) –

            The resolved reason for a specific sync blocker.

          • ResolvedAt (datetime) –

            The time that a specific sync blocker was resolved.

Exceptions

  • CodeStarconnections.Client.exceptions.AccessDeniedException

  • CodeStarconnections.Client.exceptions.InternalServerException

  • CodeStarconnections.Client.exceptions.InvalidInputException

  • CodeStarconnections.Client.exceptions.ResourceNotFoundException

  • CodeStarconnections.Client.exceptions.ThrottlingException