@Generated(value="software.amazon.awssdk:codegen") public interface CognitoSyncAsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static CognitoSyncAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CognitoSyncAsyncClient . |
default CompletableFuture<BulkPublishResponse> |
bulkPublish(BulkPublishRequest bulkPublishRequest)
Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream.
|
default CompletableFuture<BulkPublishResponse> |
bulkPublish(Consumer<BulkPublishRequest.Builder> bulkPublishRequest)
Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream.
|
static CognitoSyncAsyncClient |
create()
Create a
CognitoSyncAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CompletableFuture<DeleteDatasetResponse> |
deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
Deletes the specific dataset.
|
default CompletableFuture<DeleteDatasetResponse> |
deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
Deletes the specific dataset.
|
default CompletableFuture<DescribeDatasetResponse> |
describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
Gets meta data about a dataset by identity and dataset name.
|
default CompletableFuture<DescribeDatasetResponse> |
describeDataset(DescribeDatasetRequest describeDatasetRequest)
Gets meta data about a dataset by identity and dataset name.
|
default CompletableFuture<DescribeIdentityPoolUsageResponse> |
describeIdentityPoolUsage(Consumer<DescribeIdentityPoolUsageRequest.Builder> describeIdentityPoolUsageRequest)
Gets usage details (for example, data storage) about a particular identity pool.
|
default CompletableFuture<DescribeIdentityPoolUsageResponse> |
describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest)
Gets usage details (for example, data storage) about a particular identity pool.
|
default CompletableFuture<DescribeIdentityUsageResponse> |
describeIdentityUsage(Consumer<DescribeIdentityUsageRequest.Builder> describeIdentityUsageRequest)
Gets usage information for an identity, including number of datasets and data usage.
|
default CompletableFuture<DescribeIdentityUsageResponse> |
describeIdentityUsage(DescribeIdentityUsageRequest describeIdentityUsageRequest)
Gets usage information for an identity, including number of datasets and data usage.
|
default CompletableFuture<GetBulkPublishDetailsResponse> |
getBulkPublishDetails(Consumer<GetBulkPublishDetailsRequest.Builder> getBulkPublishDetailsRequest)
Get the status of the last BulkPublish operation for an identity pool.
|
default CompletableFuture<GetBulkPublishDetailsResponse> |
getBulkPublishDetails(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest)
Get the status of the last BulkPublish operation for an identity pool.
|
default CompletableFuture<GetCognitoEventsResponse> |
getCognitoEvents(Consumer<GetCognitoEventsRequest.Builder> getCognitoEventsRequest)
Gets the events and the corresponding Lambda functions associated with an identity pool.
|
default CompletableFuture<GetCognitoEventsResponse> |
getCognitoEvents(GetCognitoEventsRequest getCognitoEventsRequest)
Gets the events and the corresponding Lambda functions associated with an identity pool.
|
default CompletableFuture<GetIdentityPoolConfigurationResponse> |
getIdentityPoolConfiguration(Consumer<GetIdentityPoolConfigurationRequest.Builder> getIdentityPoolConfigurationRequest)
Gets the configuration settings of an identity pool.
|
default CompletableFuture<GetIdentityPoolConfigurationResponse> |
getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest)
Gets the configuration settings of an identity pool.
|
default CompletableFuture<ListDatasetsResponse> |
listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
Lists datasets for an identity.
|
default CompletableFuture<ListDatasetsResponse> |
listDatasets(ListDatasetsRequest listDatasetsRequest)
Lists datasets for an identity.
|
default CompletableFuture<ListIdentityPoolUsageResponse> |
listIdentityPoolUsage()
Gets a list of identity pools registered with Cognito.
|
default CompletableFuture<ListIdentityPoolUsageResponse> |
listIdentityPoolUsage(Consumer<ListIdentityPoolUsageRequest.Builder> listIdentityPoolUsageRequest)
Gets a list of identity pools registered with Cognito.
|
default CompletableFuture<ListIdentityPoolUsageResponse> |
listIdentityPoolUsage(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest)
Gets a list of identity pools registered with Cognito.
|
default CompletableFuture<ListRecordsResponse> |
listRecords(Consumer<ListRecordsRequest.Builder> listRecordsRequest)
Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
|
default CompletableFuture<ListRecordsResponse> |
listRecords(ListRecordsRequest listRecordsRequest)
Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
|
default CompletableFuture<RegisterDeviceResponse> |
registerDevice(Consumer<RegisterDeviceRequest.Builder> registerDeviceRequest)
Registers a device to receive push sync notifications.
|
default CompletableFuture<RegisterDeviceResponse> |
registerDevice(RegisterDeviceRequest registerDeviceRequest)
Registers a device to receive push sync notifications.
|
default CompletableFuture<SetCognitoEventsResponse> |
setCognitoEvents(Consumer<SetCognitoEventsRequest.Builder> setCognitoEventsRequest)
Sets the AWS Lambda function for a given event type for an identity pool.
|
default CompletableFuture<SetCognitoEventsResponse> |
setCognitoEvents(SetCognitoEventsRequest setCognitoEventsRequest)
Sets the AWS Lambda function for a given event type for an identity pool.
|
default CompletableFuture<SetIdentityPoolConfigurationResponse> |
setIdentityPoolConfiguration(Consumer<SetIdentityPoolConfigurationRequest.Builder> setIdentityPoolConfigurationRequest)
Sets the necessary configuration for push sync.
|
default CompletableFuture<SetIdentityPoolConfigurationResponse> |
setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest)
Sets the necessary configuration for push sync.
|
default CompletableFuture<SubscribeToDatasetResponse> |
subscribeToDataset(Consumer<SubscribeToDatasetRequest.Builder> subscribeToDatasetRequest)
Subscribes to receive notifications when a dataset is modified by another device.
|
default CompletableFuture<SubscribeToDatasetResponse> |
subscribeToDataset(SubscribeToDatasetRequest subscribeToDatasetRequest)
Subscribes to receive notifications when a dataset is modified by another device.
|
default CompletableFuture<UnsubscribeFromDatasetResponse> |
unsubscribeFromDataset(Consumer<UnsubscribeFromDatasetRequest.Builder> unsubscribeFromDatasetRequest)
Unsubscribes from receiving notifications when a dataset is modified by another device.
|
default CompletableFuture<UnsubscribeFromDatasetResponse> |
unsubscribeFromDataset(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest)
Unsubscribes from receiving notifications when a dataset is modified by another device.
|
default CompletableFuture<UpdateRecordsResponse> |
updateRecords(Consumer<UpdateRecordsRequest.Builder> updateRecordsRequest)
Posts updates to records and adds and deletes records for a dataset and user.
|
default CompletableFuture<UpdateRecordsResponse> |
updateRecords(UpdateRecordsRequest updateRecordsRequest)
Posts updates to records and adds and deletes records for a dataset and user.
|
serviceName
close
static final String SERVICE_NAME
static CognitoSyncAsyncClient create()
CognitoSyncAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static CognitoSyncAsyncClientBuilder builder()
CognitoSyncAsyncClient
.default CompletableFuture<BulkPublishResponse> bulkPublish(BulkPublishRequest bulkPublishRequest)
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.
bulkPublishRequest
- The input for the BulkPublish operation.default CompletableFuture<BulkPublishResponse> bulkPublish(Consumer<BulkPublishRequest.Builder> bulkPublishRequest)
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.
BulkPublishRequest.Builder
avoiding the need to
create one manually via BulkPublishRequest.builder()
bulkPublishRequest
- a Consumer
that will call methods on BulkPublishRequest.Builder
.default CompletableFuture<DeleteDatasetResponse> deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
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.
deleteDatasetRequest
- A request to delete the specific dataset.default CompletableFuture<DeleteDatasetResponse> deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
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.
DeleteDatasetRequest.Builder
avoiding the need to
create one manually via DeleteDatasetRequest.builder()
deleteDatasetRequest
- a Consumer
that will call methods on DeleteDatasetRequest.Builder
.default CompletableFuture<DescribeDatasetResponse> describeDataset(DescribeDatasetRequest describeDatasetRequest)
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.
describeDatasetRequest
- A request for meta data about a dataset (creation date, number of records, size) by owner and dataset
name.default CompletableFuture<DescribeDatasetResponse> describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
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.
DescribeDatasetRequest.Builder
avoiding the need
to create one manually via DescribeDatasetRequest.builder()
describeDatasetRequest
- a Consumer
that will call methods on DescribeDatasetRequest.Builder
.default CompletableFuture<DescribeIdentityPoolUsageResponse> describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest)
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.
describeIdentityPoolUsageRequest
- A request for usage information about the identity pool.default CompletableFuture<DescribeIdentityPoolUsageResponse> describeIdentityPoolUsage(Consumer<DescribeIdentityPoolUsageRequest.Builder> describeIdentityPoolUsageRequest)
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.
DescribeIdentityPoolUsageRequest.Builder
avoiding
the need to create one manually via DescribeIdentityPoolUsageRequest.builder()
describeIdentityPoolUsageRequest
- a Consumer
that will call methods on DescribeIdentityPoolUsageRequest.Builder
.default CompletableFuture<DescribeIdentityUsageResponse> describeIdentityUsage(DescribeIdentityUsageRequest describeIdentityUsageRequest)
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.
describeIdentityUsageRequest
- A request for information about the usage of an identity pool.default CompletableFuture<DescribeIdentityUsageResponse> describeIdentityUsage(Consumer<DescribeIdentityUsageRequest.Builder> describeIdentityUsageRequest)
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.
DescribeIdentityUsageRequest.Builder
avoiding the
need to create one manually via DescribeIdentityUsageRequest.builder()
describeIdentityUsageRequest
- a Consumer
that will call methods on DescribeIdentityUsageRequest.Builder
.default CompletableFuture<GetBulkPublishDetailsResponse> getBulkPublishDetails(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest)
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.
getBulkPublishDetailsRequest
- The input for the GetBulkPublishDetails operation.default CompletableFuture<GetBulkPublishDetailsResponse> getBulkPublishDetails(Consumer<GetBulkPublishDetailsRequest.Builder> getBulkPublishDetailsRequest)
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.
GetBulkPublishDetailsRequest.Builder
avoiding the
need to create one manually via GetBulkPublishDetailsRequest.builder()
getBulkPublishDetailsRequest
- a Consumer
that will call methods on GetBulkPublishDetailsRequest.Builder
.default CompletableFuture<GetCognitoEventsResponse> getCognitoEvents(GetCognitoEventsRequest getCognitoEventsRequest)
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.
getCognitoEventsRequest
- A request for a list of the configured Cognito Eventsdefault CompletableFuture<GetCognitoEventsResponse> getCognitoEvents(Consumer<GetCognitoEventsRequest.Builder> getCognitoEventsRequest)
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.
GetCognitoEventsRequest.Builder
avoiding the need
to create one manually via GetCognitoEventsRequest.builder()
getCognitoEventsRequest
- a Consumer
that will call methods on GetCognitoEventsRequest.Builder
.default CompletableFuture<GetIdentityPoolConfigurationResponse> getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest)
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.
getIdentityPoolConfigurationRequest
- The input for the GetIdentityPoolConfiguration operation.default CompletableFuture<GetIdentityPoolConfigurationResponse> getIdentityPoolConfiguration(Consumer<GetIdentityPoolConfigurationRequest.Builder> getIdentityPoolConfigurationRequest)
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.
GetIdentityPoolConfigurationRequest.Builder
avoiding the need to create one manually via GetIdentityPoolConfigurationRequest.builder()
getIdentityPoolConfigurationRequest
- a Consumer
that will call methods on GetIdentityPoolConfigurationRequest.Builder
.default CompletableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest listDatasetsRequest)
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.
listDatasetsRequest
- Request for a list of datasets for an identity.default CompletableFuture<ListDatasetsResponse> listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
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.
ListDatasetsRequest.Builder
avoiding the need to
create one manually via ListDatasetsRequest.builder()
listDatasetsRequest
- a Consumer
that will call methods on ListDatasetsRequest.Builder
.default CompletableFuture<ListIdentityPoolUsageResponse> listIdentityPoolUsage(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest)
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.
listIdentityPoolUsageRequest
- A request for usage information on an identity pool.default CompletableFuture<ListIdentityPoolUsageResponse> listIdentityPoolUsage()
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.
default CompletableFuture<ListIdentityPoolUsageResponse> listIdentityPoolUsage(Consumer<ListIdentityPoolUsageRequest.Builder> listIdentityPoolUsageRequest)
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.
ListIdentityPoolUsageRequest.Builder
avoiding the
need to create one manually via ListIdentityPoolUsageRequest.builder()
listIdentityPoolUsageRequest
- a Consumer
that will call methods on ListIdentityPoolUsageRequest.Builder
.default CompletableFuture<ListRecordsResponse> listRecords(ListRecordsRequest listRecordsRequest)
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.
listRecordsRequest
- A request for a list of records.default CompletableFuture<ListRecordsResponse> listRecords(Consumer<ListRecordsRequest.Builder> listRecordsRequest)
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.
ListRecordsRequest.Builder
avoiding the need to
create one manually via ListRecordsRequest.builder()
listRecordsRequest
- a Consumer
that will call methods on ListRecordsRequest.Builder
.default CompletableFuture<RegisterDeviceResponse> registerDevice(RegisterDeviceRequest registerDeviceRequest)
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.
registerDeviceRequest
- A request to RegisterDevice.default CompletableFuture<RegisterDeviceResponse> registerDevice(Consumer<RegisterDeviceRequest.Builder> registerDeviceRequest)
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.
RegisterDeviceRequest.Builder
avoiding the need to
create one manually via RegisterDeviceRequest.builder()
registerDeviceRequest
- a Consumer
that will call methods on RegisterDeviceRequest.Builder
.default CompletableFuture<SetCognitoEventsResponse> setCognitoEvents(SetCognitoEventsRequest setCognitoEventsRequest)
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.
setCognitoEventsRequest
- A request to configure Cognito Events"default CompletableFuture<SetCognitoEventsResponse> setCognitoEvents(Consumer<SetCognitoEventsRequest.Builder> setCognitoEventsRequest)
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.
SetCognitoEventsRequest.Builder
avoiding the need
to create one manually via SetCognitoEventsRequest.builder()
setCognitoEventsRequest
- a Consumer
that will call methods on SetCognitoEventsRequest.Builder
.default CompletableFuture<SetIdentityPoolConfigurationResponse> setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest)
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.
setIdentityPoolConfigurationRequest
- The input for the SetIdentityPoolConfiguration operation.default CompletableFuture<SetIdentityPoolConfigurationResponse> setIdentityPoolConfiguration(Consumer<SetIdentityPoolConfigurationRequest.Builder> setIdentityPoolConfigurationRequest)
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.
SetIdentityPoolConfigurationRequest.Builder
avoiding the need to create one manually via SetIdentityPoolConfigurationRequest.builder()
setIdentityPoolConfigurationRequest
- a Consumer
that will call methods on SetIdentityPoolConfigurationRequest.Builder
.default CompletableFuture<SubscribeToDatasetResponse> subscribeToDataset(SubscribeToDatasetRequest subscribeToDatasetRequest)
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.
subscribeToDatasetRequest
- A request to SubscribeToDatasetRequest.default CompletableFuture<SubscribeToDatasetResponse> subscribeToDataset(Consumer<SubscribeToDatasetRequest.Builder> subscribeToDatasetRequest)
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.
SubscribeToDatasetRequest.Builder
avoiding the
need to create one manually via SubscribeToDatasetRequest.builder()
subscribeToDatasetRequest
- a Consumer
that will call methods on SubscribeToDatasetRequest.Builder
.default CompletableFuture<UnsubscribeFromDatasetResponse> unsubscribeFromDataset(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest)
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.
unsubscribeFromDatasetRequest
- A request to UnsubscribeFromDataset.default CompletableFuture<UnsubscribeFromDatasetResponse> unsubscribeFromDataset(Consumer<UnsubscribeFromDatasetRequest.Builder> unsubscribeFromDatasetRequest)
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.
UnsubscribeFromDatasetRequest.Builder
avoiding the
need to create one manually via UnsubscribeFromDatasetRequest.builder()
unsubscribeFromDatasetRequest
- a Consumer
that will call methods on UnsubscribeFromDatasetRequest.Builder
.default CompletableFuture<UpdateRecordsResponse> updateRecords(UpdateRecordsRequest updateRecordsRequest)
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.
updateRecordsRequest
- A request to post updates to records or add and delete records for a dataset and user.default CompletableFuture<UpdateRecordsResponse> updateRecords(Consumer<UpdateRecordsRequest.Builder> updateRecordsRequest)
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.
UpdateRecordsRequest.Builder
avoiding the need to
create one manually via UpdateRecordsRequest.builder()
updateRecordsRequest
- a Consumer
that will call methods on UpdateRecordsRequest.Builder
.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.