@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonCognitoSyncAsync extends AbstractAmazonCognitoSync implements AmazonCognitoSyncAsync
AmazonCognitoSyncAsync. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIXbulkPublish, deleteDataset, describeDataset, describeIdentityPoolUsage, describeIdentityUsage, getBulkPublishDetails, getCachedResponseMetadata, getCognitoEvents, getIdentityPoolConfiguration, listDatasets, listIdentityPoolUsage, listRecords, registerDevice, setCognitoEvents, setEndpoint, setIdentityPoolConfiguration, setRegion, shutdown, subscribeToDataset, unsubscribeFromDataset, updateRecordsequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbulkPublish, deleteDataset, describeDataset, describeIdentityPoolUsage, describeIdentityUsage, getBulkPublishDetails, getCachedResponseMetadata, getCognitoEvents, getIdentityPoolConfiguration, listDatasets, listIdentityPoolUsage, listRecords, registerDevice, setCognitoEvents, setEndpoint, setIdentityPoolConfiguration, setRegion, shutdown, subscribeToDataset, unsubscribeFromDataset, updateRecordspublic Future<BulkPublishResult> bulkPublishAsync(BulkPublishRequest request)
AmazonCognitoSyncAsyncInitiates 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.
bulkPublishAsync in interface AmazonCognitoSyncAsyncrequest - The input for the BulkPublish operation.public Future<BulkPublishResult> bulkPublishAsync(BulkPublishRequest request, AsyncHandler<BulkPublishRequest,BulkPublishResult> asyncHandler)
AmazonCognitoSyncAsyncInitiates 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.
bulkPublishAsync in interface AmazonCognitoSyncAsyncrequest - The input for the BulkPublish operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest request)
AmazonCognitoSyncAsyncDeletes 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.
deleteDatasetAsync in interface AmazonCognitoSyncAsyncrequest - A request to delete the specific dataset.public Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest request, AsyncHandler<DeleteDatasetRequest,DeleteDatasetResult> asyncHandler)
AmazonCognitoSyncAsyncDeletes 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.
deleteDatasetAsync in interface AmazonCognitoSyncAsyncrequest - A request to delete the specific dataset.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest request)
AmazonCognitoSyncAsyncGets 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.
describeDatasetAsync in interface AmazonCognitoSyncAsyncrequest - A request for meta data about a dataset (creation date, number of records, size) by owner and dataset
name.public Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest request, AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler)
AmazonCognitoSyncAsyncGets 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.
describeDatasetAsync in interface AmazonCognitoSyncAsyncrequest - A request for meta data about a dataset (creation date, number of records, size) by owner and dataset
name.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeIdentityPoolUsageResult> describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest request)
AmazonCognitoSyncAsyncGets 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.
describeIdentityPoolUsageAsync in interface AmazonCognitoSyncAsyncrequest - A request for usage information about the identity pool.public Future<DescribeIdentityPoolUsageResult> describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest request, AsyncHandler<DescribeIdentityPoolUsageRequest,DescribeIdentityPoolUsageResult> asyncHandler)
AmazonCognitoSyncAsyncGets 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.
describeIdentityPoolUsageAsync in interface AmazonCognitoSyncAsyncrequest - A request for usage information about the identity pool.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeIdentityUsageResult> describeIdentityUsageAsync(DescribeIdentityUsageRequest request)
AmazonCognitoSyncAsyncGets 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.
describeIdentityUsageAsync in interface AmazonCognitoSyncAsyncrequest - A request for information about the usage of an identity pool.public Future<DescribeIdentityUsageResult> describeIdentityUsageAsync(DescribeIdentityUsageRequest request, AsyncHandler<DescribeIdentityUsageRequest,DescribeIdentityUsageResult> asyncHandler)
AmazonCognitoSyncAsyncGets 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.
describeIdentityUsageAsync in interface AmazonCognitoSyncAsyncrequest - A request for information about the usage of an identity pool.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetBulkPublishDetailsResult> getBulkPublishDetailsAsync(GetBulkPublishDetailsRequest request)
AmazonCognitoSyncAsyncGet 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.
getBulkPublishDetailsAsync in interface AmazonCognitoSyncAsyncrequest - The input for the GetBulkPublishDetails operation.public Future<GetBulkPublishDetailsResult> getBulkPublishDetailsAsync(GetBulkPublishDetailsRequest request, AsyncHandler<GetBulkPublishDetailsRequest,GetBulkPublishDetailsResult> asyncHandler)
AmazonCognitoSyncAsyncGet 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.
getBulkPublishDetailsAsync in interface AmazonCognitoSyncAsyncrequest - The input for the GetBulkPublishDetails operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCognitoEventsResult> getCognitoEventsAsync(GetCognitoEventsRequest request)
AmazonCognitoSyncAsyncGets 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.
getCognitoEventsAsync in interface AmazonCognitoSyncAsyncrequest - A request for a list of the configured Cognito Eventspublic Future<GetCognitoEventsResult> getCognitoEventsAsync(GetCognitoEventsRequest request, AsyncHandler<GetCognitoEventsRequest,GetCognitoEventsResult> asyncHandler)
AmazonCognitoSyncAsyncGets 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.
getCognitoEventsAsync in interface AmazonCognitoSyncAsyncrequest - A request for a list of the configured Cognito EventsasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetIdentityPoolConfigurationResult> getIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest request)
AmazonCognitoSyncAsyncGets 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.
getIdentityPoolConfigurationAsync in interface AmazonCognitoSyncAsyncrequest - The input for the GetIdentityPoolConfiguration operation.public Future<GetIdentityPoolConfigurationResult> getIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest request, AsyncHandler<GetIdentityPoolConfigurationRequest,GetIdentityPoolConfigurationResult> asyncHandler)
AmazonCognitoSyncAsyncGets 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.
getIdentityPoolConfigurationAsync in interface AmazonCognitoSyncAsyncrequest - The input for the GetIdentityPoolConfiguration operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest request)
AmazonCognitoSyncAsyncLists 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.
listDatasetsAsync in interface AmazonCognitoSyncAsyncrequest - Request for a list of datasets for an identity.public Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest request, AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler)
AmazonCognitoSyncAsyncLists 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.
listDatasetsAsync in interface AmazonCognitoSyncAsyncrequest - Request for a list of datasets for an identity.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListIdentityPoolUsageResult> listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest request)
AmazonCognitoSyncAsyncGets 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.
listIdentityPoolUsageAsync in interface AmazonCognitoSyncAsyncrequest - A request for usage information on an identity pool.public Future<ListIdentityPoolUsageResult> listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest request, AsyncHandler<ListIdentityPoolUsageRequest,ListIdentityPoolUsageResult> asyncHandler)
AmazonCognitoSyncAsyncGets 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.
listIdentityPoolUsageAsync in interface AmazonCognitoSyncAsyncrequest - A request for usage information on an identity pool.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRecordsResult> listRecordsAsync(ListRecordsRequest request)
AmazonCognitoSyncAsyncGets 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.
listRecordsAsync in interface AmazonCognitoSyncAsyncrequest - A request for a list of records.public Future<ListRecordsResult> listRecordsAsync(ListRecordsRequest request, AsyncHandler<ListRecordsRequest,ListRecordsResult> asyncHandler)
AmazonCognitoSyncAsyncGets 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.
listRecordsAsync in interface AmazonCognitoSyncAsyncrequest - A request for a list of records.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RegisterDeviceResult> registerDeviceAsync(RegisterDeviceRequest request)
AmazonCognitoSyncAsyncRegisters 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.
registerDeviceAsync in interface AmazonCognitoSyncAsyncrequest - A request to RegisterDevice.public Future<RegisterDeviceResult> registerDeviceAsync(RegisterDeviceRequest request, AsyncHandler<RegisterDeviceRequest,RegisterDeviceResult> asyncHandler)
AmazonCognitoSyncAsyncRegisters 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.
registerDeviceAsync in interface AmazonCognitoSyncAsyncrequest - A request to RegisterDevice.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetCognitoEventsResult> setCognitoEventsAsync(SetCognitoEventsRequest request)
AmazonCognitoSyncAsyncSets 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.
setCognitoEventsAsync in interface AmazonCognitoSyncAsyncrequest - A request to configure Cognito Events"public Future<SetCognitoEventsResult> setCognitoEventsAsync(SetCognitoEventsRequest request, AsyncHandler<SetCognitoEventsRequest,SetCognitoEventsResult> asyncHandler)
AmazonCognitoSyncAsyncSets 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.
setCognitoEventsAsync in interface AmazonCognitoSyncAsyncrequest - A request to configure Cognito Events"asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetIdentityPoolConfigurationResult> setIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest request)
AmazonCognitoSyncAsyncSets 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.
setIdentityPoolConfigurationAsync in interface AmazonCognitoSyncAsyncrequest - The input for the SetIdentityPoolConfiguration operation.public Future<SetIdentityPoolConfigurationResult> setIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest request, AsyncHandler<SetIdentityPoolConfigurationRequest,SetIdentityPoolConfigurationResult> asyncHandler)
AmazonCognitoSyncAsyncSets 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.
setIdentityPoolConfigurationAsync in interface AmazonCognitoSyncAsyncrequest - The input for the SetIdentityPoolConfiguration operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SubscribeToDatasetResult> subscribeToDatasetAsync(SubscribeToDatasetRequest request)
AmazonCognitoSyncAsyncSubscribes 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.
subscribeToDatasetAsync in interface AmazonCognitoSyncAsyncrequest - A request to SubscribeToDatasetRequest.public Future<SubscribeToDatasetResult> subscribeToDatasetAsync(SubscribeToDatasetRequest request, AsyncHandler<SubscribeToDatasetRequest,SubscribeToDatasetResult> asyncHandler)
AmazonCognitoSyncAsyncSubscribes 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.
subscribeToDatasetAsync in interface AmazonCognitoSyncAsyncrequest - A request to SubscribeToDatasetRequest.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UnsubscribeFromDatasetResult> unsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest request)
AmazonCognitoSyncAsyncUnsubscribes 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.
unsubscribeFromDatasetAsync in interface AmazonCognitoSyncAsyncrequest - A request to UnsubscribeFromDataset.public Future<UnsubscribeFromDatasetResult> unsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest request, AsyncHandler<UnsubscribeFromDatasetRequest,UnsubscribeFromDatasetResult> asyncHandler)
AmazonCognitoSyncAsyncUnsubscribes 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.
unsubscribeFromDatasetAsync in interface AmazonCognitoSyncAsyncrequest - A request to UnsubscribeFromDataset.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateRecordsResult> updateRecordsAsync(UpdateRecordsRequest request)
AmazonCognitoSyncAsyncPosts 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.
updateRecordsAsync in interface AmazonCognitoSyncAsyncrequest - A request to post updates to records or add and delete records for a dataset and user.public Future<UpdateRecordsResult> updateRecordsAsync(UpdateRecordsRequest request, AsyncHandler<UpdateRecordsRequest,UpdateRecordsResult> asyncHandler)
AmazonCognitoSyncAsyncPosts 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.
updateRecordsAsync in interface AmazonCognitoSyncAsyncrequest - A request to post updates to records or add and delete records for a dataset and user.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.