com.amazonaws.services.cognitosync

Class AmazonCognitoSyncAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cognitosync.AmazonCognitoSyncClient

com.amazonaws.services.cognitosync.AmazonCognitoSyncAsyncClient

All Implemented Interfaces:

AmazonCognitoSync, AmazonCognitoSyncAsync

public class AmazonCognitoSyncAsyncClient
extends AmazonCognitoSyncClient
implements AmazonCognitoSyncAsync

Asynchronous client for accessing AmazonCognitoSync. All asynchronous calls made using this client are non-blocking. Callers could either process the result and handle the exceptions in the worker thread by providing a callback handler when making the call, or use the returned Future object to check the result of the call in the calling thread. Amazon Cognito Sync

Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.

With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service .

If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS .

Field Summary

Fields inherited from class com.amazonaws.services.cognitosync.AmazonCognitoSyncClient

jsonErrorUnmarshallers

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonCognitoSyncAsyncClient() Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync.
AmazonCognitoSyncAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials.
AmazonCognitoSyncAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials, executor service, and client configuration options.
AmazonCognitoSyncAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials and executor service.
AmazonCognitoSyncAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials provider.
AmazonCognitoSyncAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials provider and client configuration options.
AmazonCognitoSyncAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials provider, executor service, and client configuration options.
AmazonCognitoSyncAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials provider and executor service.
AmazonCognitoSyncAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync.

Method Summary

Methods

Modifier and Type	Method and Description
Future<BulkPublishResult>	bulkPublishAsync(BulkPublishRequest bulkPublishRequest) Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream.
Future<BulkPublishResult>	bulkPublishAsync(BulkPublishRequest bulkPublishRequest, AsyncHandler<BulkPublishRequest,BulkPublishResult> asyncHandler) Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream.
Future<DeleteDatasetResult>	deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest) Deletes the specific dataset.
Future<DeleteDatasetResult>	deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest, AsyncHandler<DeleteDatasetRequest,DeleteDatasetResult> asyncHandler) Deletes the specific dataset.
Future<DescribeDatasetResult>	describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest) Gets meta data about a dataset by identity and dataset name.
Future<DescribeDatasetResult>	describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest, AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler) Gets meta data about a dataset by identity and dataset name.
Future<DescribeIdentityPoolUsageResult>	describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest) Gets usage details (for example, data storage) about a particular identity pool.
Future<DescribeIdentityPoolUsageResult>	describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest, AsyncHandler<DescribeIdentityPoolUsageRequest,DescribeIdentityPoolUsageResult> asyncHandler) Gets usage details (for example, data storage) about a particular identity pool.
Future<DescribeIdentityUsageResult>	describeIdentityUsageAsync(DescribeIdentityUsageRequest describeIdentityUsageRequest) Gets usage information for an identity, including number of datasets and data usage.
Future<DescribeIdentityUsageResult>	describeIdentityUsageAsync(DescribeIdentityUsageRequest describeIdentityUsageRequest, AsyncHandler<DescribeIdentityUsageRequest,DescribeIdentityUsageResult> asyncHandler) Gets usage information for an identity, including number of datasets and data usage.
Future<GetBulkPublishDetailsResult>	getBulkPublishDetailsAsync(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest) Get the status of the last BulkPublish operation for an identity pool.
Future<GetBulkPublishDetailsResult>	getBulkPublishDetailsAsync(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest, AsyncHandler<GetBulkPublishDetailsRequest,GetBulkPublishDetailsResult> asyncHandler) Get the status of the last BulkPublish operation for an identity pool.
Future<GetCognitoEventsResult>	getCognitoEventsAsync(GetCognitoEventsRequest getCognitoEventsRequest) Gets the events and the corresponding Lambda functions associated with an identity pool.
Future<GetCognitoEventsResult>	getCognitoEventsAsync(GetCognitoEventsRequest getCognitoEventsRequest, AsyncHandler<GetCognitoEventsRequest,GetCognitoEventsResult> asyncHandler) Gets the events and the corresponding Lambda functions associated with an identity pool.
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<GetIdentityPoolConfigurationResult>	getIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest) Gets the configuration settings of an identity pool.
Future<GetIdentityPoolConfigurationResult>	getIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest, AsyncHandler<GetIdentityPoolConfigurationRequest,GetIdentityPoolConfigurationResult> asyncHandler) Gets the configuration settings of an identity pool.
Future<ListDatasetsResult>	listDatasetsAsync(ListDatasetsRequest listDatasetsRequest) Lists datasets for an identity.
Future<ListDatasetsResult>	listDatasetsAsync(ListDatasetsRequest listDatasetsRequest, AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler) Lists datasets for an identity.
Future<ListIdentityPoolUsageResult>	listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest) Gets a list of identity pools registered with Cognito.
Future<ListIdentityPoolUsageResult>	listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest, AsyncHandler<ListIdentityPoolUsageRequest,ListIdentityPoolUsageResult> asyncHandler) Gets a list of identity pools registered with Cognito.
Future<ListRecordsResult>	listRecordsAsync(ListRecordsRequest listRecordsRequest) Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
Future<ListRecordsResult>	listRecordsAsync(ListRecordsRequest listRecordsRequest, AsyncHandler<ListRecordsRequest,ListRecordsResult> asyncHandler) Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
Future<RegisterDeviceResult>	registerDeviceAsync(RegisterDeviceRequest registerDeviceRequest) Registers a device to receive push sync notifications.
Future<RegisterDeviceResult>	registerDeviceAsync(RegisterDeviceRequest registerDeviceRequest, AsyncHandler<RegisterDeviceRequest,RegisterDeviceResult> asyncHandler) Registers a device to receive push sync notifications.
Future<Void>	setCognitoEventsAsync(SetCognitoEventsRequest setCognitoEventsRequest) Sets the AWS Lambda function for a given event type for an identity pool.
Future<Void>	setCognitoEventsAsync(SetCognitoEventsRequest setCognitoEventsRequest, AsyncHandler<SetCognitoEventsRequest,Void> asyncHandler) Sets the AWS Lambda function for a given event type for an identity pool.
Future<SetIdentityPoolConfigurationResult>	setIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest) Sets the necessary configuration for push sync.
Future<SetIdentityPoolConfigurationResult>	setIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest, AsyncHandler<SetIdentityPoolConfigurationRequest,SetIdentityPoolConfigurationResult> asyncHandler) Sets the necessary configuration for push sync.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<SubscribeToDatasetResult>	subscribeToDatasetAsync(SubscribeToDatasetRequest subscribeToDatasetRequest) Subscribes to receive notifications when a dataset is modified by another device.
Future<SubscribeToDatasetResult>	subscribeToDatasetAsync(SubscribeToDatasetRequest subscribeToDatasetRequest, AsyncHandler<SubscribeToDatasetRequest,SubscribeToDatasetResult> asyncHandler) Subscribes to receive notifications when a dataset is modified by another device.
Future<UnsubscribeFromDatasetResult>	unsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest) Unsubscribes from receiving notifications when a dataset is modified by another device.
Future<UnsubscribeFromDatasetResult>	unsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest, AsyncHandler<UnsubscribeFromDatasetRequest,UnsubscribeFromDatasetResult> asyncHandler) Unsubscribes from receiving notifications when a dataset is modified by another device.
Future<UpdateRecordsResult>	updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest) Posts updates to records and adds and deletes records for a dataset and user.
Future<UpdateRecordsResult>	updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest, AsyncHandler<UpdateRecordsRequest,UpdateRecordsResult> asyncHandler) Posts updates to records and adds and deletes records for a dataset and user.

Methods inherited from class com.amazonaws.services.cognitosync.AmazonCognitoSyncClient

bulkPublish, deleteDataset, describeDataset, describeIdentityPoolUsage, describeIdentityUsage, getBulkPublishDetails, getCachedResponseMetadata, getCognitoEvents, getIdentityPoolConfiguration, listDatasets, listIdentityPoolUsage, listRecords, registerDevice, setCognitoEvents, setEndpoint, setEndpoint, setIdentityPoolConfiguration, subscribeToDataset, unsubscribeFromDataset, updateRecords

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cognitosync.AmazonCognitoSync

bulkPublish, deleteDataset, describeDataset, describeIdentityPoolUsage, describeIdentityUsage, getBulkPublishDetails, getCachedResponseMetadata, getCognitoEvents, getIdentityPoolConfiguration, listDatasets, listIdentityPoolUsage, listRecords, registerDevice, setCognitoEvents, setEndpoint, setIdentityPoolConfiguration, setRegion, subscribeToDataset, unsubscribeFromDataset, updateRecords

Constructor Detail

AmazonCognitoSyncAsyncClient

public AmazonCognitoSyncAsyncClient()

Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonCognitoSyncAsyncClient

public AmazonCognitoSyncAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonCognitoSync (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonCognitoSyncAsyncClient

public AmazonCognitoSyncAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonCognitoSyncAsyncClient

public AmazonCognitoSyncAsyncClient(AWSCredentials awsCredentials,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonCognitoSyncAsyncClient

public AmazonCognitoSyncAsyncClient(AWSCredentials awsCredentials,
                            ClientConfiguration clientConfiguration,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AmazonCognitoSyncAsyncClient

public AmazonCognitoSyncAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials provider. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonCognitoSyncAsyncClient

public AmazonCognitoSyncAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials provider and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonCognitoSyncAsyncClient

public AmazonCognitoSyncAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials provider and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

AmazonCognitoSyncAsyncClient

public AmazonCognitoSyncAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials provider, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonCognitoSync

Overrides:

shutdown in class AmazonWebServiceClient

updateRecordsAsync

public Future<UpdateRecordsResult> updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Posts updates to records and adds and deletes records for a dataset and user.

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Specified by:

updateRecordsAsync in interface AmazonCognitoSyncAsync

Parameters:

updateRecordsRequest - Container for the necessary parameters to execute the UpdateRecords operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the UpdateRecords service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

updateRecordsAsync

public Future<UpdateRecordsResult> updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest,
                                             AsyncHandler<UpdateRecordsRequest,UpdateRecordsResult> asyncHandler)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Posts updates to records and adds and deletes records for a dataset and user.

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Specified by:

updateRecordsAsync in interface AmazonCognitoSyncAsync

Parameters:

updateRecordsRequest - Container for the necessary parameters to execute the UpdateRecords operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the UpdateRecords service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

setCognitoEventsAsync

public Future<Void> setCognitoEventsAsync(SetCognitoEventsRequest setCognitoEventsRequest)
                                   throws AmazonServiceException,
                                          AmazonClientException

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Specified by:

setCognitoEventsAsync in interface AmazonCognitoSyncAsync

Parameters:

setCognitoEventsRequest - Container for the necessary parameters to execute the SetCognitoEvents operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the SetCognitoEvents service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

setCognitoEventsAsync

public Future<Void> setCognitoEventsAsync(SetCognitoEventsRequest setCognitoEventsRequest,
                                 AsyncHandler<SetCognitoEventsRequest,Void> asyncHandler)
                                   throws AmazonServiceException,
                                          AmazonClientException

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Specified by:

setCognitoEventsAsync in interface AmazonCognitoSyncAsync

Parameters:

setCognitoEventsRequest - Container for the necessary parameters to execute the SetCognitoEvents operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the SetCognitoEvents service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

getCognitoEventsAsync

public Future<GetCognitoEventsResult> getCognitoEventsAsync(GetCognitoEventsRequest getCognitoEventsRequest)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

Gets the events and the corresponding Lambda functions associated with 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.

Specified by:

getCognitoEventsAsync in interface AmazonCognitoSyncAsync

Parameters:

getCognitoEventsRequest - Container for the necessary parameters to execute the GetCognitoEvents operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the GetCognitoEvents service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

getCognitoEventsAsync

public Future<GetCognitoEventsResult> getCognitoEventsAsync(GetCognitoEventsRequest getCognitoEventsRequest,
                                                   AsyncHandler<GetCognitoEventsRequest,GetCognitoEventsResult> asyncHandler)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

Gets the events and the corresponding Lambda functions associated with 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.

Specified by:

getCognitoEventsAsync in interface AmazonCognitoSyncAsync

Parameters:

getCognitoEventsRequest - Container for the necessary parameters to execute the GetCognitoEvents operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the GetCognitoEvents service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeIdentityUsageAsync

public Future<DescribeIdentityUsageResult> describeIdentityUsageAsync(DescribeIdentityUsageRequest describeIdentityUsageRequest)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Gets usage information for an identity, including number of datasets and data usage.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Specified by:

describeIdentityUsageAsync in interface AmazonCognitoSyncAsync

Parameters:

describeIdentityUsageRequest - Container for the necessary parameters to execute the DescribeIdentityUsage operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the DescribeIdentityUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeIdentityUsageAsync

public Future<DescribeIdentityUsageResult> describeIdentityUsageAsync(DescribeIdentityUsageRequest describeIdentityUsageRequest,
                                                             AsyncHandler<DescribeIdentityUsageRequest,DescribeIdentityUsageResult> asyncHandler)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Gets usage information for an identity, including number of datasets and data usage.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Specified by:

describeIdentityUsageAsync in interface AmazonCognitoSyncAsync

Parameters:

describeIdentityUsageRequest - Container for the necessary parameters to execute the DescribeIdentityUsage operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeIdentityUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

unsubscribeFromDatasetAsync

public Future<UnsubscribeFromDatasetResult> unsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest)
                                                                 throws AmazonServiceException,
                                                                        AmazonClientException

Unsubscribes from receiving notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Specified by:

unsubscribeFromDatasetAsync in interface AmazonCognitoSyncAsync

Parameters:

unsubscribeFromDatasetRequest - Container for the necessary parameters to execute the UnsubscribeFromDataset operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the UnsubscribeFromDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

unsubscribeFromDatasetAsync

public Future<UnsubscribeFromDatasetResult> unsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest,
                                                               AsyncHandler<UnsubscribeFromDatasetRequest,UnsubscribeFromDatasetResult> asyncHandler)
                                                                 throws AmazonServiceException,
                                                                        AmazonClientException

Unsubscribes from receiving notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Specified by:

unsubscribeFromDatasetAsync in interface AmazonCognitoSyncAsync

Parameters:

unsubscribeFromDatasetRequest - Container for the necessary parameters to execute the UnsubscribeFromDataset operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the UnsubscribeFromDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

setIdentityPoolConfigurationAsync

public Future<SetIdentityPoolConfigurationResult> setIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest)
                                                                             throws AmazonServiceException,
                                                                                    AmazonClientException

Sets the necessary configuration for push sync.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Specified by:

setIdentityPoolConfigurationAsync in interface AmazonCognitoSyncAsync

Parameters:

setIdentityPoolConfigurationRequest - Container for the necessary parameters to execute the SetIdentityPoolConfiguration operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the SetIdentityPoolConfiguration service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

setIdentityPoolConfigurationAsync

public Future<SetIdentityPoolConfigurationResult> setIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest,
                                                                           AsyncHandler<SetIdentityPoolConfigurationRequest,SetIdentityPoolConfigurationResult> asyncHandler)
                                                                             throws AmazonServiceException,
                                                                                    AmazonClientException

Sets the necessary configuration for push sync.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Specified by:

setIdentityPoolConfigurationAsync in interface AmazonCognitoSyncAsync

Parameters:

setIdentityPoolConfigurationRequest - Container for the necessary parameters to execute the SetIdentityPoolConfiguration operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the SetIdentityPoolConfiguration service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

getIdentityPoolConfigurationAsync

public Future<GetIdentityPoolConfigurationResult> getIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest)
                                                                             throws AmazonServiceException,
                                                                                    AmazonClientException

Gets the configuration settings of 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.

Specified by:

getIdentityPoolConfigurationAsync in interface AmazonCognitoSyncAsync

Parameters:

getIdentityPoolConfigurationRequest - Container for the necessary parameters to execute the GetIdentityPoolConfiguration operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the GetIdentityPoolConfiguration service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

getIdentityPoolConfigurationAsync

public Future<GetIdentityPoolConfigurationResult> getIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest,
                                                                           AsyncHandler<GetIdentityPoolConfigurationRequest,GetIdentityPoolConfigurationResult> asyncHandler)
                                                                             throws AmazonServiceException,
                                                                                    AmazonClientException

Gets the configuration settings of 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.

Specified by:

getIdentityPoolConfigurationAsync in interface AmazonCognitoSyncAsync

Parameters:

getIdentityPoolConfigurationRequest - Container for the necessary parameters to execute the GetIdentityPoolConfiguration operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the GetIdentityPoolConfiguration service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

subscribeToDatasetAsync

public Future<SubscribeToDatasetResult> subscribeToDatasetAsync(SubscribeToDatasetRequest subscribeToDatasetRequest)
                                                         throws AmazonServiceException,
                                                                AmazonClientException

Subscribes to receive notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Specified by:

subscribeToDatasetAsync in interface AmazonCognitoSyncAsync

Parameters:

subscribeToDatasetRequest - Container for the necessary parameters to execute the SubscribeToDataset operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the SubscribeToDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

subscribeToDatasetAsync

public Future<SubscribeToDatasetResult> subscribeToDatasetAsync(SubscribeToDatasetRequest subscribeToDatasetRequest,
                                                       AsyncHandler<SubscribeToDatasetRequest,SubscribeToDatasetResult> asyncHandler)
                                                         throws AmazonServiceException,
                                                                AmazonClientException

Subscribes to receive notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Specified by:

subscribeToDatasetAsync in interface AmazonCognitoSyncAsync

Parameters:

subscribeToDatasetRequest - Container for the necessary parameters to execute the SubscribeToDataset operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the SubscribeToDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeIdentityPoolUsageAsync

public Future<DescribeIdentityPoolUsageResult> describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest)
                                                                       throws AmazonServiceException,
                                                                              AmazonClientException

Gets usage details (for example, data storage) about a particular 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.

Specified by:

describeIdentityPoolUsageAsync in interface AmazonCognitoSyncAsync

Parameters:

describeIdentityPoolUsageRequest - Container for the necessary parameters to execute the DescribeIdentityPoolUsage operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the DescribeIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeIdentityPoolUsageAsync

public Future<DescribeIdentityPoolUsageResult> describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest,
                                                                     AsyncHandler<DescribeIdentityPoolUsageRequest,DescribeIdentityPoolUsageResult> asyncHandler)
                                                                       throws AmazonServiceException,
                                                                              AmazonClientException

Gets usage details (for example, data storage) about a particular 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.

Specified by:

describeIdentityPoolUsageAsync in interface AmazonCognitoSyncAsync

Parameters:

describeIdentityPoolUsageRequest - Container for the necessary parameters to execute the DescribeIdentityPoolUsage operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listDatasetsAsync

public Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest listDatasetsRequest)
                                             throws AmazonServiceException,
                                                    AmazonClientException

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.

Specified by:

listDatasetsAsync in interface AmazonCognitoSyncAsync

Parameters:

listDatasetsRequest - Container for the necessary parameters to execute the ListDatasets operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the ListDatasets service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listDatasetsAsync

public Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest listDatasetsRequest,
                                           AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler)
                                             throws AmazonServiceException,
                                                    AmazonClientException

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.

Specified by:

listDatasetsAsync in interface AmazonCognitoSyncAsync

Parameters:

listDatasetsRequest - Container for the necessary parameters to execute the ListDatasets operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListDatasets service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listIdentityPoolUsageAsync

public Future<ListIdentityPoolUsageResult> listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Gets a list of identity pools registered with Cognito.

ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.

Specified by:

listIdentityPoolUsageAsync in interface AmazonCognitoSyncAsync

Parameters:

listIdentityPoolUsageRequest - Container for the necessary parameters to execute the ListIdentityPoolUsage operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the ListIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listIdentityPoolUsageAsync

public Future<ListIdentityPoolUsageResult> listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest,
                                                             AsyncHandler<ListIdentityPoolUsageRequest,ListIdentityPoolUsageResult> asyncHandler)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Gets a list of identity pools registered with Cognito.

ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.

Specified by:

listIdentityPoolUsageAsync in interface AmazonCognitoSyncAsync

Parameters:

listIdentityPoolUsageRequest - Container for the necessary parameters to execute the ListIdentityPoolUsage operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listRecordsAsync

public Future<ListRecordsResult> listRecordsAsync(ListRecordsRequest listRecordsRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

Specified by:

listRecordsAsync in interface AmazonCognitoSyncAsync

Parameters:

listRecordsRequest - Container for the necessary parameters to execute the ListRecords operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the ListRecords service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listRecordsAsync

public Future<ListRecordsResult> listRecordsAsync(ListRecordsRequest listRecordsRequest,
                                         AsyncHandler<ListRecordsRequest,ListRecordsResult> asyncHandler)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

Specified by:

listRecordsAsync in interface AmazonCognitoSyncAsync

Parameters:

listRecordsRequest - Container for the necessary parameters to execute the ListRecords operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListRecords service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

getBulkPublishDetailsAsync

public Future<GetBulkPublishDetailsResult> getBulkPublishDetailsAsync(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

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.

Specified by:

getBulkPublishDetailsAsync in interface AmazonCognitoSyncAsync

Parameters:

getBulkPublishDetailsRequest - Container for the necessary parameters to execute the GetBulkPublishDetails operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the GetBulkPublishDetails service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

getBulkPublishDetailsAsync

public Future<GetBulkPublishDetailsResult> getBulkPublishDetailsAsync(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest,
                                                             AsyncHandler<GetBulkPublishDetailsRequest,GetBulkPublishDetailsResult> asyncHandler)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

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.

Specified by:

getBulkPublishDetailsAsync in interface AmazonCognitoSyncAsync

Parameters:

getBulkPublishDetailsRequest - Container for the necessary parameters to execute the GetBulkPublishDetails operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the GetBulkPublishDetails service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

bulkPublishAsync

public Future<BulkPublishResult> bulkPublishAsync(BulkPublishRequest bulkPublishRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

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.

Specified by:

bulkPublishAsync in interface AmazonCognitoSyncAsync

Parameters:

bulkPublishRequest - Container for the necessary parameters to execute the BulkPublish operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the BulkPublish service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

bulkPublishAsync

public Future<BulkPublishResult> bulkPublishAsync(BulkPublishRequest bulkPublishRequest,
                                         AsyncHandler<BulkPublishRequest,BulkPublishResult> asyncHandler)
                                           throws AmazonServiceException,
                                                  AmazonClientException

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.

Specified by:

bulkPublishAsync in interface AmazonCognitoSyncAsync

Parameters:

bulkPublishRequest - Container for the necessary parameters to execute the BulkPublish operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the BulkPublish service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeDatasetAsync

public Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

Specified by:

describeDatasetAsync in interface AmazonCognitoSyncAsync

Parameters:

describeDatasetRequest - Container for the necessary parameters to execute the DescribeDataset operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the DescribeDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeDatasetAsync

public Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest,
                                                 AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

Specified by:

describeDatasetAsync in interface AmazonCognitoSyncAsync

Parameters:

describeDatasetRequest - Container for the necessary parameters to execute the DescribeDataset operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

deleteDatasetAsync

public Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Specified by:

deleteDatasetAsync in interface AmazonCognitoSyncAsync

Parameters:

deleteDatasetRequest - Container for the necessary parameters to execute the DeleteDataset operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the DeleteDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

deleteDatasetAsync

public Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest,
                                             AsyncHandler<DeleteDatasetRequest,DeleteDatasetResult> asyncHandler)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Specified by:

deleteDatasetAsync in interface AmazonCognitoSyncAsync

Parameters:

deleteDatasetRequest - Container for the necessary parameters to execute the DeleteDataset operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DeleteDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

registerDeviceAsync

public Future<RegisterDeviceResult> registerDeviceAsync(RegisterDeviceRequest registerDeviceRequest)
                                                 throws AmazonServiceException,
                                                        AmazonClientException

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Specified by:

registerDeviceAsync in interface AmazonCognitoSyncAsync

Parameters:

registerDeviceRequest - Container for the necessary parameters to execute the RegisterDevice operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the RegisterDevice service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

registerDeviceAsync

public Future<RegisterDeviceResult> registerDeviceAsync(RegisterDeviceRequest registerDeviceRequest,
                                               AsyncHandler<RegisterDeviceRequest,RegisterDeviceResult> asyncHandler)
                                                 throws AmazonServiceException,
                                                        AmazonClientException

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Specified by:

registerDeviceAsync in interface AmazonCognitoSyncAsync

Parameters:

registerDeviceRequest - Container for the necessary parameters to execute the RegisterDevice operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the RegisterDevice service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.