AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginBulkPublish and EndBulkPublish.

Namespace: Amazon.CognitoSync
Assembly: AWSSDK.CognitoSync.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<BulkPublishResponse> BulkPublishAsync(
         BulkPublishRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CognitoSync.Model.BulkPublishRequest

Container for the necessary parameters to execute the BulkPublish service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the BulkPublish service method, as returned by CognitoSync.

Exceptions

ExceptionCondition
AlreadyStreamedException An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully.
DuplicateRequestException An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool.
InternalErrorException Indicates an internal service error.
InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
ResourceNotFoundException Thrown if the resource doesn't exist.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also