Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
Parameters:
-
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.
Raises:
Source code in docs_src/capo_cognito_sync/_services/async_cognito_sync.py
| async def bulk_publish(
self,
identity_pool_id: "capo_cognito_sync.types.identity_pool_id.IdentityPoolId",
*,
config_overrides: Optional[AsyncCognitoSyncClientConfig] = None,
) -> "capo_cognito_sync.types.bulk_publish_response.BulkPublishResponse":
"""<p>Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
Args:
identity_pool_id: 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.
Raises:
capo_cognito_sync.errors.already_streamed_exception.AlreadyStreamedException: An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully.
capo_cognito_sync.errors.duplicate_request_exception.DuplicateRequestException: An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool.
capo_cognito_sync.errors.internal_error_exception.InternalErrorException: Indicates an internal service error.
capo_cognito_sync.errors.invalid_parameter_exception.InvalidParameterException: Thrown when a request parameter does not comply with the associated constraints.
capo_cognito_sync.errors.not_authorized_exception.NotAuthorizedException: Thrown when a user is not authorized to access the requested resource.
capo_cognito_sync.errors.resource_not_found_exception.ResourceNotFoundException: Thrown if the resource doesn't exist.
capo_cognito_sync.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_cognito_sync.types.bulk_publish_request.BulkPublishRequest]",
) -> AsyncOperationResponse[
"capo_cognito_sync.types.bulk_publish_response.BulkPublishResponse"
]:
import capo_cognito_sync._operations.aws_cognito_sync_service.bulk_publish
(
output,
http_response,
) = await capo_cognito_sync._operations.aws_cognito_sync_service.bulk_publish.async_bulk_publish(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("BulkPublish")
)
input_: capo_cognito_sync.types.bulk_publish_request.BulkPublishRequest = {
"identity_pool_id": identity_pool_id
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|