Skip to content

GetBulkPublishDetailsResponse

Source code in docs_src/capo_cognito_sync/types/get_bulk_publish_details_response.py
class GetBulkPublishDetailsResponse(TypedDict, closed=True):
    identity_pool_id: NotRequired[
        "capo_cognito_sync.types.identity_pool_id.IdentityPoolId"
    ]
    """A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region."""
    bulk_publish_start_time: NotRequired["capo_cognito_sync.types.date.Date"]
    """The date/time at which the last bulk publish was initiated."""
    bulk_publish_complete_time: NotRequired["capo_cognito_sync.types.date.Date"]
    """If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed."""
    bulk_publish_status: NotRequired[
        "capo_cognito_sync.types.bulk_publish_status.BulkPublishStatus"
    ]
    """Status of the last bulk publish operation, valid values are: <p>NOT_STARTED - No bulk publish has been requested for this identity pool</p> <p>IN_PROGRESS - Data is being published to the configured stream</p> <p>SUCCEEDED - All data for the identity pool has been published to the configured stream</p> <p>FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.</p>"""
    failure_message: NotRequired["capo_cognito_sync.types.string.String"]
    """If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail."""

bulk_publish_complete_time instance-attribute

bulk_publish_complete_time: NotRequired[Date]

If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

bulk_publish_start_time instance-attribute

bulk_publish_start_time: NotRequired[Date]

The date/time at which the last bulk publish was initiated.

bulk_publish_status instance-attribute

bulk_publish_status: NotRequired[BulkPublishStatus]

Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

failure_message instance-attribute

failure_message: NotRequired[String]

If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.

identity_pool_id instance-attribute

identity_pool_id: NotRequired[IdentityPoolId]

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.