bulk_publish_details
Creates, updates, deletes, gets or lists a bulk_publish_details resource.
Overview
| Name | bulk_publish_details |
| Type | Resource |
| Id | aws.cognito_sync.bulk_publish_details |
Fields
The following fields are returned by SELECT queries:
- get_bulk_publish_details
| Name | Datatype | Description |
|---|---|---|
bulk_publish_complete_time | string (date-time) | If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed. |
bulk_publish_start_time | string (date-time) | The date/time at which the last bulk publish was initiated. |
bulk_publish_status | string | 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. (NOT_STARTED, IN_PROGRESS, FAILED, SUCCEEDED) |
failure_message | string | If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail. |
identity_pool_id | string | 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. (pattern: <code>[\w-]+:[0-9a-f-]+</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_bulk_publish_details | select | identity_pool_id, region | Get the status of the last BulkPublish operation for an identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
identity_pool_id | string | 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. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_bulk_publish_details
Get the status of the last BulkPublish operation for an identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
SELECT
bulk_publish_complete_time,
bulk_publish_start_time,
bulk_publish_status,
failure_message,
identity_pool_id
FROM aws.cognito_sync.bulk_publish_details
WHERE identity_pool_id = '{{ identity_pool_id }}' -- required
AND region = '{{ region }}' -- required
;