AbstractAmazonCognitoSync (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitosync.AbstractAmazonCognitoSync

All Implemented Interfaces:

AmazonCognitoSync

Direct Known Subclasses:

AbstractAmazonCognitoSyncAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonCognitoSync
extends Object
implements AmazonCognitoSync
```
Abstract implementation of AmazonCognitoSync. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.cognitosync.AmazonCognitoSync
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BulkPublishResult`	`bulkPublish(BulkPublishRequest request)` Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream.
`DeleteDatasetResult`	`deleteDataset(DeleteDatasetRequest request)` Deletes the specific dataset.
`DescribeDatasetResult`	`describeDataset(DescribeDatasetRequest request)` Gets meta data about a dataset by identity and dataset name.
`DescribeIdentityPoolUsageResult`	`describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest request)` Gets usage details (for example, data storage) about a particular identity pool.
`DescribeIdentityUsageResult`	`describeIdentityUsage(DescribeIdentityUsageRequest request)` Gets usage information for an identity, including number of datasets and data usage.
`GetBulkPublishDetailsResult`	`getBulkPublishDetails(GetBulkPublishDetailsRequest request)` Get the status of the last BulkPublish operation for an identity pool.
`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.
`GetCognitoEventsResult`	`getCognitoEvents(GetCognitoEventsRequest request)` Gets the events and the corresponding Lambda functions associated with an identity pool.
`GetIdentityPoolConfigurationResult`	`getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest request)` Gets the configuration settings of an identity pool.
`ListDatasetsResult`	`listDatasets(ListDatasetsRequest request)` Lists datasets for an identity.
`ListIdentityPoolUsageResult`	`listIdentityPoolUsage(ListIdentityPoolUsageRequest request)` Gets a list of identity pools registered with Cognito.
`ListRecordsResult`	`listRecords(ListRecordsRequest request)` Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
`RegisterDeviceResult`	`registerDevice(RegisterDeviceRequest request)` Registers a device to receive push sync notifications.
`SetCognitoEventsResult`	`setCognitoEvents(SetCognitoEventsRequest request)` Sets the AWS Lambda function for a given event type for an identity pool.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://cognito-sync.us-east-1.amazonaws.com/").
`SetIdentityPoolConfigurationResult`	`setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest request)` Sets the necessary configuration for push sync.
`void`	`setRegion(Region region)` An alternative to `AmazonCognitoSync.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.
`SubscribeToDatasetResult`	`subscribeToDataset(SubscribeToDatasetRequest request)` Subscribes to receive notifications when a dataset is modified by another device.
`UnsubscribeFromDatasetResult`	`unsubscribeFromDataset(UnsubscribeFromDatasetRequest request)` Unsubscribes from receiving notifications when a dataset is modified by another device.
`UpdateRecordsResult`	`updateRecords(UpdateRecordsRequest request)` Posts updates to records and adds and deletes records for a dataset and user.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonCognitoSync
    
    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.
    
    Specified by:
    
    setEndpoint in interface AmazonCognitoSync
    
    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.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonCognitoSync
    
    An alternative to AmazonCognitoSync.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.
    
    Specified by:
    
    setRegion in interface AmazonCognitoSync
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - bulkPublish
```
public BulkPublishResult bulkPublish(BulkPublishRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.
    
    This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
    
    Specified by:
    
    bulkPublish in interface AmazonCognitoSync
    
    Parameters:
    
    request - The input for the BulkPublish operation.
    
    Returns:
    
    Result of the BulkPublish operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDataset
```
public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.
    
    This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
    
    Specified by:
    
    deleteDataset in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request to delete the specific dataset.
    
    Returns:
    
    Result of the DeleteDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDataset
```
public DescribeDatasetResult describeDataset(DescribeDatasetRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
    
    This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
    
    Specified by:
    
    describeDataset in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name.
    
    Returns:
    
    Result of the DescribeDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeIdentityPoolUsage
```
public DescribeIdentityPoolUsageResult describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Gets usage details (for example, data storage) about a particular identity pool.
    
    This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
    
    Specified by:
    
    describeIdentityPoolUsage in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request for usage information about the identity pool.
    
    Returns:
    
    Result of the DescribeIdentityPoolUsage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeIdentityUsage
```
public DescribeIdentityUsageResult describeIdentityUsage(DescribeIdentityUsageRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Gets usage information for an identity, including number of datasets and data usage.
    
    This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
    
    Specified by:
    
    describeIdentityUsage in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request for information about the usage of an identity pool.
    
    Returns:
    
    Result of the DescribeIdentityUsage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBulkPublishDetails
```
public GetBulkPublishDetailsResult getBulkPublishDetails(GetBulkPublishDetailsRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Get the status of the last BulkPublish operation for an identity pool.
    
    This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
    
    Specified by:
    
    getBulkPublishDetails in interface AmazonCognitoSync
    
    Parameters:
    
    request - The input for the GetBulkPublishDetails operation.
    
    Returns:
    
    Result of the GetBulkPublishDetails operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCognitoEvents
```
public GetCognitoEventsResult getCognitoEvents(GetCognitoEventsRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Gets the events and the corresponding Lambda functions associated with an identity pool.
    
    This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
    
    Specified by:
    
    getCognitoEvents in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request for a list of the configured Cognito Events
    
    Returns:
    
    Result of the GetCognitoEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getIdentityPoolConfiguration
```
public GetIdentityPoolConfigurationResult getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Gets the configuration settings of an identity pool.
    
    This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
    
    Specified by:
    
    getIdentityPoolConfiguration in interface AmazonCognitoSync
    
    Parameters:
    
    request - The input for the GetIdentityPoolConfiguration operation.
    
    Returns:
    
    Result of the GetIdentityPoolConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDatasets
```
public ListDatasetsResult listDatasets(ListDatasetsRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
    
    ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.
    
    Specified by:
    
    listDatasets in interface AmazonCognitoSync
    
    Parameters:
    
    request - Request for a list of datasets for an identity.
    
    Returns:
    
    Result of the ListDatasets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listIdentityPoolUsage
```
public ListIdentityPoolUsageResult listIdentityPoolUsage(ListIdentityPoolUsageRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Gets a list of identity pools registered with Cognito.
    
    ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.
    
    Specified by:
    
    listIdentityPoolUsage in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request for usage information on an identity pool.
    
    Returns:
    
    Result of the ListIdentityPoolUsage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRecords
```
public ListRecordsResult listRecords(ListRecordsRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
    
    ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
    
    Specified by:
    
    listRecords in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request for a list of records.
    
    Returns:
    
    Result of the ListRecords operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerDevice
```
public RegisterDeviceResult registerDevice(RegisterDeviceRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Registers a device to receive push sync notifications.
    
    This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
    
    Specified by:
    
    registerDevice in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request to RegisterDevice.
    
    Returns:
    
    Result of the RegisterDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setCognitoEvents
```
public SetCognitoEventsResult setCognitoEvents(SetCognitoEventsRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.
    
    This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
    
    Specified by:
    
    setCognitoEvents in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request to configure Cognito Events"
    
    Returns:
    
    Result of the SetCognitoEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setIdentityPoolConfiguration
```
public SetIdentityPoolConfigurationResult setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Sets the necessary configuration for push sync.
    
    This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
    
    Specified by:
    
    setIdentityPoolConfiguration in interface AmazonCognitoSync
    
    Parameters:
    
    request - The input for the SetIdentityPoolConfiguration operation.
    
    Returns:
    
    Result of the SetIdentityPoolConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - subscribeToDataset
```
public SubscribeToDatasetResult subscribeToDataset(SubscribeToDatasetRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Subscribes to receive notifications when a dataset is modified by another device.
    
    This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
    
    Specified by:
    
    subscribeToDataset in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request to SubscribeToDatasetRequest.
    
    Returns:
    
    Result of the SubscribeToDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - unsubscribeFromDataset
```
public UnsubscribeFromDatasetResult unsubscribeFromDataset(UnsubscribeFromDatasetRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Unsubscribes from receiving notifications when a dataset is modified by another device.
    
    This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
    
    Specified by:
    
    unsubscribeFromDataset in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request to UnsubscribeFromDataset.
    
    Returns:
    
    Result of the UnsubscribeFromDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateRecords
```
public UpdateRecordsResult updateRecords(UpdateRecordsRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    Posts updates to records and adds and deletes records for a dataset and user.
    
    The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.
    
    For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.
    
    This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
    
    Specified by:
    
    updateRecords in interface AmazonCognitoSync
    
    Parameters:
    
    request - A request to post updates to records or add and delete records for a dataset and user.
    
    Returns:
    
    Result of the UpdateRecords operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonCognitoSync
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonCognitoSync
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonCognitoSync
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonCognitoSync
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonCognitoSync

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

bulkPublish

deleteDataset

describeDataset

describeIdentityPoolUsage

describeIdentityUsage

getBulkPublishDetails

getCognitoEvents

getIdentityPoolConfiguration

listDatasets

listIdentityPoolUsage

listRecords

registerDevice

setCognitoEvents

setIdentityPoolConfiguration

subscribeToDataset

unsubscribeFromDataset

updateRecords

shutdown

getCachedResponseMetadata