com.amazonaws.services.cognitosync

Interface AmazonCognitoSync

All Known Subinterfaces:

AmazonCognitoSyncAsync

All Known Implementing Classes:

AmazonCognitoSyncAsyncClient, AmazonCognitoSyncClient

public interface AmazonCognitoSync

Interface for accessing AmazonCognitoSync. 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.

Method Summary

Methods

Modifier and Type	Method and Description
DeleteDatasetResult	deleteDataset(DeleteDatasetRequest deleteDatasetRequest) Deletes the specific dataset.
DescribeDatasetResult	describeDataset(DescribeDatasetRequest describeDatasetRequest) Gets metadata about a dataset by identity and dataset name.
DescribeIdentityPoolUsageResult	describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest) Gets usage details (for example, data storage) about a particular identity pool.
DescribeIdentityUsageResult	describeIdentityUsage(DescribeIdentityUsageRequest describeIdentityUsageRequest) Gets usage information for an identity, including number of datasets and data usage.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListDatasetsResult	listDatasets(ListDatasetsRequest listDatasetsRequest) Lists datasets for an identity.
ListIdentityPoolUsageResult	listIdentityPoolUsage(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest) Gets a list of identity pools registered with Cognito.
ListRecordsResult	listRecords(ListRecordsRequest listRecordsRequest) Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://cognito-sync.us-east-1.amazonaws.com/").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateRecordsResult	updateRecords(UpdateRecordsRequest updateRecordsRequest) Posts updates to records and add and delete records for a dataset and user.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://cognito-sync.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "cognito-sync.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cognito-sync.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "cognito-sync.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cognito-sync.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

updateRecords

UpdateRecordsResult updateRecords(UpdateRecordsRequest updateRecordsRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Posts updates to records and add and delete records for a dataset and user.

Parameters:

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

Returns:

The response from the UpdateRecords service method, as returned by AmazonCognitoSync.

Throws:

LimitExceededException

TooManyRequestsException

ResourceConflictException

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

InternalErrorException

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

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

describeIdentityPoolUsage

DescribeIdentityPoolUsageResult describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Gets usage details (for example, data storage) about a particular identity pool.

Parameters:

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

Returns:

The response from the DescribeIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

InternalErrorException

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

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

listDatasets

ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Lists datasets for an identity.

Parameters:

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

Returns:

The response from the ListDatasets service method, as returned by AmazonCognitoSync.

Throws:

InvalidParameterException

NotAuthorizedException

InternalErrorException

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

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

listIdentityPoolUsage

ListIdentityPoolUsageResult listIdentityPoolUsage(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Gets a list of identity pools registered with Cognito.

Parameters:

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

Returns:

The response from the ListIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

InvalidParameterException

NotAuthorizedException

InternalErrorException

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

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

listRecords

ListRecordsResult listRecords(ListRecordsRequest listRecordsRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Gets paginated records, optionally changed after a particular sync count for a dataset and identity.

Parameters:

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

Returns:

The response from the ListRecords service method, as returned by AmazonCognitoSync.

Throws:

TooManyRequestsException

InvalidParameterException

NotAuthorizedException

InternalErrorException

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

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

describeDataset

DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Gets metadata about a dataset by identity and dataset name.

Parameters:

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

Returns:

The response from the DescribeDataset service method, as returned by AmazonCognitoSync.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

InternalErrorException

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

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

deleteDataset

DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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

Parameters:

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

Returns:

The response from the DeleteDataset service method, as returned by AmazonCognitoSync.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

InternalErrorException

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

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

describeIdentityUsage

DescribeIdentityUsageResult describeIdentityUsage(DescribeIdentityUsageRequest describeIdentityUsageRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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

Parameters:

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

Returns:

The response from the DescribeIdentityUsage service method, as returned by AmazonCognitoSync.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

InternalErrorException

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

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.