software.amazon.awssdk.services.cognitosync

Interface CognitoSyncAsyncClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface CognitoSyncAsyncClient
extends AwsClient

Service client for accessing Amazon Cognito Sync asynchronously. This can be created using the static builder() method. 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

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

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 CognitoSyncServiceClientConfiguration	serviceClientConfiguration()
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.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

bulkPublish

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.

Parameters:

bulkPublishRequest - The input for the BulkPublish operation.

Returns:

A Java Future containing the result of the BulkPublish operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• DuplicateRequestException An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool.
• AlreadyStreamedException An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

bulkPublish

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.

This is a convenience which creates an instance of the BulkPublishRequest.Builder avoiding the need to create one manually via BulkPublishRequest.builder()

Parameters:

bulkPublishRequest - A Consumer that will call methods on BulkPublishRequest.Builder to create a request. The input for the BulkPublish operation.

Returns:

A Java Future containing the result of the BulkPublish operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• DuplicateRequestException An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool.
• AlreadyStreamedException An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteDataset

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.

Parameters:

deleteDatasetRequest - A request to delete the specific dataset.

Returns:

A Java Future containing the result of the DeleteDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• ResourceConflictException Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteDataset

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.

This is a convenience which creates an instance of the DeleteDatasetRequest.Builder avoiding the need to create one manually via DeleteDatasetRequest.builder()

Parameters:

deleteDatasetRequest - A Consumer that will call methods on DeleteDatasetRequest.Builder to create a request. A request to delete the specific dataset.

Returns:

A Java Future containing the result of the DeleteDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• ResourceConflictException Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeDataset

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.

Parameters:

describeDatasetRequest - A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name.

Returns:

A Java Future containing the result of the DescribeDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeDataset

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.

This is a convenience which creates an instance of the DescribeDatasetRequest.Builder avoiding the need to create one manually via DescribeDatasetRequest.builder()

Parameters:

describeDatasetRequest - A Consumer that will call methods on DescribeDatasetRequest.Builder to create a request. A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name.

Returns:

A Java Future containing the result of the DescribeDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeIdentityPoolUsage

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.

Parameters:

describeIdentityPoolUsageRequest - A request for usage information about the identity pool.

Returns:

A Java Future containing the result of the DescribeIdentityPoolUsage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeIdentityPoolUsage

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.

This is a convenience which creates an instance of the DescribeIdentityPoolUsageRequest.Builder avoiding the need to create one manually via DescribeIdentityPoolUsageRequest.builder()

Parameters:

describeIdentityPoolUsageRequest - A Consumer that will call methods on DescribeIdentityPoolUsageRequest.Builder to create a request. A request for usage information about the identity pool.

Returns:

A Java Future containing the result of the DescribeIdentityPoolUsage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeIdentityUsage

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.

Parameters:

describeIdentityUsageRequest - A request for information about the usage of an identity pool.

Returns:

A Java Future containing the result of the DescribeIdentityUsage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeIdentityUsage

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.

This is a convenience which creates an instance of the DescribeIdentityUsageRequest.Builder avoiding the need to create one manually via DescribeIdentityUsageRequest.builder()

Parameters:

describeIdentityUsageRequest - A Consumer that will call methods on DescribeIdentityUsageRequest.Builder to create a request. A request for information about the usage of an identity pool.

Returns:

A Java Future containing the result of the DescribeIdentityUsage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getBulkPublishDetails

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.

Parameters:

getBulkPublishDetailsRequest - The input for the GetBulkPublishDetails operation.

Returns:

A Java Future containing the result of the GetBulkPublishDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getBulkPublishDetails

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.

This is a convenience which creates an instance of the GetBulkPublishDetailsRequest.Builder avoiding the need to create one manually via GetBulkPublishDetailsRequest.builder()

Parameters:

getBulkPublishDetailsRequest - A Consumer that will call methods on GetBulkPublishDetailsRequest.Builder to create a request. The input for the GetBulkPublishDetails operation.

Returns:

A Java Future containing the result of the GetBulkPublishDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getCognitoEvents

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.

Parameters:

getCognitoEventsRequest - A request for a list of the configured Cognito Events

Returns:

A Java Future containing the result of the GetCognitoEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getCognitoEvents

default 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.

This is a convenience which creates an instance of the GetCognitoEventsRequest.Builder avoiding the need to create one manually via GetCognitoEventsRequest.builder()

Parameters:

getCognitoEventsRequest - A Consumer that will call methods on GetCognitoEventsRequest.Builder to create a request. A request for a list of the configured Cognito Events

Returns:

A Java Future containing the result of the GetCognitoEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getIdentityPoolConfiguration

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.

Parameters:

getIdentityPoolConfigurationRequest - The input for the GetIdentityPoolConfiguration operation.

Returns:

A Java Future containing the result of the GetIdentityPoolConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getIdentityPoolConfiguration

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.

This is a convenience which creates an instance of the GetIdentityPoolConfigurationRequest.Builder avoiding the need to create one manually via GetIdentityPoolConfigurationRequest.builder()

Parameters:

getIdentityPoolConfigurationRequest - A Consumer that will call methods on GetIdentityPoolConfigurationRequest.Builder to create a request. The input for the GetIdentityPoolConfiguration operation.

Returns:

A Java Future containing the result of the GetIdentityPoolConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listDatasets

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.

Parameters:

listDatasetsRequest - Request for a list of datasets for an identity.

Returns:

A Java Future containing the result of the ListDatasets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listDatasets

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.

This is a convenience which creates an instance of the ListDatasetsRequest.Builder avoiding the need to create one manually via ListDatasetsRequest.builder()

Parameters:

listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request. Request for a list of datasets for an identity.

Returns:

A Java Future containing the result of the ListDatasets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listIdentityPoolUsage

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.

Parameters:

listIdentityPoolUsageRequest - A request for usage information on an identity pool.

Returns:

A Java Future containing the result of the ListIdentityPoolUsage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listIdentityPoolUsage

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.

This is a convenience which creates an instance of the ListIdentityPoolUsageRequest.Builder avoiding the need to create one manually via ListIdentityPoolUsageRequest.builder()

Parameters:

listIdentityPoolUsageRequest - A Consumer that will call methods on ListIdentityPoolUsageRequest.Builder to create a request. A request for usage information on an identity pool.

Returns:

A Java Future containing the result of the ListIdentityPoolUsage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listIdentityPoolUsage

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.

Returns:

A Java Future containing the result of the ListIdentityPoolUsage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listRecords

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.

Parameters:

listRecordsRequest - A request for a list of records.

Returns:

A Java Future containing the result of the ListRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• TooManyRequestsException Thrown if the request is throttled.
• InternalErrorException Indicates an internal service error.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listRecords

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.

This is a convenience which creates an instance of the ListRecordsRequest.Builder avoiding the need to create one manually via ListRecordsRequest.builder()

Parameters:

listRecordsRequest - A Consumer that will call methods on ListRecordsRequest.Builder to create a request. A request for a list of records.

Returns:

A Java Future containing the result of the ListRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• TooManyRequestsException Thrown if the request is throttled.
• InternalErrorException Indicates an internal service error.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

registerDevice

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.

Parameters:

registerDeviceRequest - A request to RegisterDevice.

Returns:

A Java Future containing the result of the RegisterDevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• InvalidConfigurationException
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

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.

This is a convenience which creates an instance of the RegisterDeviceRequest.Builder avoiding the need to create one manually via RegisterDeviceRequest.builder()

Parameters:

registerDeviceRequest - A Consumer that will call methods on RegisterDeviceRequest.Builder to create a request. A request to RegisterDevice.

Returns:

A Java Future containing the result of the RegisterDevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• InvalidConfigurationException
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

setCognitoEvents

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.

Parameters:

setCognitoEventsRequest - A request to configure Cognito Events"

Returns:

A Java Future containing the result of the SetCognitoEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

setCognitoEvents

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.

This is a convenience which creates an instance of the SetCognitoEventsRequest.Builder avoiding the need to create one manually via SetCognitoEventsRequest.builder()

Parameters:

setCognitoEventsRequest - A Consumer that will call methods on SetCognitoEventsRequest.Builder to create a request. A request to configure Cognito Events"

Returns:

A Java Future containing the result of the SetCognitoEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

setIdentityPoolConfiguration

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.

Parameters:

setIdentityPoolConfigurationRequest - The input for the SetIdentityPoolConfiguration operation.

Returns:

A Java Future containing the result of the SetIdentityPoolConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• ConcurrentModificationException Thrown if there are parallel requests to modify a resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

setIdentityPoolConfiguration

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.

This is a convenience which creates an instance of the SetIdentityPoolConfigurationRequest.Builder avoiding the need to create one manually via SetIdentityPoolConfigurationRequest.builder()

Parameters:

setIdentityPoolConfigurationRequest - A Consumer that will call methods on SetIdentityPoolConfigurationRequest.Builder to create a request. The input for the SetIdentityPoolConfiguration operation.

Returns:

A Java Future containing the result of the SetIdentityPoolConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• TooManyRequestsException Thrown if the request is throttled.
• ConcurrentModificationException Thrown if there are parallel requests to modify a resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

subscribeToDataset

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.

Parameters:

subscribeToDatasetRequest - A request to SubscribeToDatasetRequest.

Returns:

A Java Future containing the result of the SubscribeToDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• InvalidConfigurationException
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

subscribeToDataset

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.

This is a convenience which creates an instance of the SubscribeToDatasetRequest.Builder avoiding the need to create one manually via SubscribeToDatasetRequest.builder()

Parameters:

subscribeToDatasetRequest - A Consumer that will call methods on SubscribeToDatasetRequest.Builder to create a request. A request to SubscribeToDatasetRequest.

Returns:

A Java Future containing the result of the SubscribeToDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• InvalidConfigurationException
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

unsubscribeFromDataset

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.

Parameters:

unsubscribeFromDatasetRequest - A request to UnsubscribeFromDataset.

Returns:

A Java Future containing the result of the UnsubscribeFromDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• InvalidConfigurationException
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

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.

This is a convenience which creates an instance of the UnsubscribeFromDatasetRequest.Builder avoiding the need to create one manually via UnsubscribeFromDatasetRequest.builder()

Parameters:

unsubscribeFromDatasetRequest - A Consumer that will call methods on UnsubscribeFromDatasetRequest.Builder to create a request. A request to UnsubscribeFromDataset.

Returns:

A Java Future containing the result of the UnsubscribeFromDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• InternalErrorException Indicates an internal service error.
• InvalidConfigurationException
• TooManyRequestsException Thrown if the request is throttled.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateRecords

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.

Parameters:

updateRecordsRequest - A request to post updates to records or add and delete records for a dataset and user.

Returns:

A Java Future containing the result of the UpdateRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• LimitExceededException Thrown when the limit on the number of objects or operations has been exceeded.
• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• ResourceConflictException Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.
• InvalidLambdaFunctionOutputException The AWS Lambda function returned invalid output or an exception.
• LambdaThrottledException AWS Lambda throttled your account, please contact AWS Support
• TooManyRequestsException Thrown if the request is throttled.
• InternalErrorException Indicates an internal service error.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateRecords

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.

This is a convenience which creates an instance of the UpdateRecordsRequest.Builder avoiding the need to create one manually via UpdateRecordsRequest.builder()

Parameters:

updateRecordsRequest - A Consumer that will call methods on UpdateRecordsRequest.Builder to create a request. A request to post updates to records or add and delete records for a dataset and user.

Returns:

A Java Future containing the result of the UpdateRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
• LimitExceededException Thrown when the limit on the number of objects or operations has been exceeded.
• NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
• ResourceNotFoundException Thrown if the resource doesn't exist.
• ResourceConflictException Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.
• InvalidLambdaFunctionOutputException The AWS Lambda function returned invalid output or an exception.
• LambdaThrottledException AWS Lambda throttled your account, please contact AWS Support
• TooManyRequestsException Thrown if the request is throttled.
• InternalErrorException Indicates an internal service error.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CognitoSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

serviceClientConfiguration

default CognitoSyncServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

create

static CognitoSyncAsyncClient create()

Create a CognitoSyncAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CognitoSyncAsyncClientBuilder builder()

Create a builder that can be used to configure and create a CognitoSyncAsyncClient.