@Generated(value="software.amazon.awssdk:codegen") public interface CognitoSyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.
With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service.
If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static CognitoSyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CognitoSyncClient . |
default BulkPublishResponse |
bulkPublish(BulkPublishRequest bulkPublishRequest)
Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream.
|
default BulkPublishResponse |
bulkPublish(Consumer<BulkPublishRequest.Builder> bulkPublishRequest)
Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream.
|
static CognitoSyncClient |
create()
Create a
CognitoSyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default DeleteDatasetResponse |
deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
Deletes the specific dataset.
|
default DeleteDatasetResponse |
deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
Deletes the specific dataset.
|
default DescribeDatasetResponse |
describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
Gets meta data about a dataset by identity and dataset name.
|
default DescribeDatasetResponse |
describeDataset(DescribeDatasetRequest describeDatasetRequest)
Gets meta data about a dataset by identity and dataset name.
|
default DescribeIdentityPoolUsageResponse |
describeIdentityPoolUsage(Consumer<DescribeIdentityPoolUsageRequest.Builder> describeIdentityPoolUsageRequest)
Gets usage details (for example, data storage) about a particular identity pool.
|
default DescribeIdentityPoolUsageResponse |
describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest)
Gets usage details (for example, data storage) about a particular identity pool.
|
default DescribeIdentityUsageResponse |
describeIdentityUsage(Consumer<DescribeIdentityUsageRequest.Builder> describeIdentityUsageRequest)
Gets usage information for an identity, including number of datasets and data usage.
|
default DescribeIdentityUsageResponse |
describeIdentityUsage(DescribeIdentityUsageRequest describeIdentityUsageRequest)
Gets usage information for an identity, including number of datasets and data usage.
|
default GetBulkPublishDetailsResponse |
getBulkPublishDetails(Consumer<GetBulkPublishDetailsRequest.Builder> getBulkPublishDetailsRequest)
Get the status of the last BulkPublish operation for an identity pool.
|
default GetBulkPublishDetailsResponse |
getBulkPublishDetails(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest)
Get the status of the last BulkPublish operation for an identity pool.
|
default GetCognitoEventsResponse |
getCognitoEvents(Consumer<GetCognitoEventsRequest.Builder> getCognitoEventsRequest)
Gets the events and the corresponding Lambda functions associated with an identity pool.
|
default GetCognitoEventsResponse |
getCognitoEvents(GetCognitoEventsRequest getCognitoEventsRequest)
Gets the events and the corresponding Lambda functions associated with an identity pool.
|
default GetIdentityPoolConfigurationResponse |
getIdentityPoolConfiguration(Consumer<GetIdentityPoolConfigurationRequest.Builder> getIdentityPoolConfigurationRequest)
Gets the configuration settings of an identity pool.
|
default GetIdentityPoolConfigurationResponse |
getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest)
Gets the configuration settings of an identity pool.
|
default ListDatasetsResponse |
listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
Lists datasets for an identity.
|
default ListDatasetsResponse |
listDatasets(ListDatasetsRequest listDatasetsRequest)
Lists datasets for an identity.
|
default ListIdentityPoolUsageResponse |
listIdentityPoolUsage()
Gets a list of identity pools registered with Cognito.
|
default ListIdentityPoolUsageResponse |
listIdentityPoolUsage(Consumer<ListIdentityPoolUsageRequest.Builder> listIdentityPoolUsageRequest)
Gets a list of identity pools registered with Cognito.
|
default ListIdentityPoolUsageResponse |
listIdentityPoolUsage(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest)
Gets a list of identity pools registered with Cognito.
|
default ListRecordsResponse |
listRecords(Consumer<ListRecordsRequest.Builder> listRecordsRequest)
Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
|
default ListRecordsResponse |
listRecords(ListRecordsRequest listRecordsRequest)
Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
|
default RegisterDeviceResponse |
registerDevice(Consumer<RegisterDeviceRequest.Builder> registerDeviceRequest)
Registers a device to receive push sync notifications.
|
default RegisterDeviceResponse |
registerDevice(RegisterDeviceRequest registerDeviceRequest)
Registers a device to receive push sync notifications.
|
static ServiceMetadata |
serviceMetadata() |
default SetCognitoEventsResponse |
setCognitoEvents(Consumer<SetCognitoEventsRequest.Builder> setCognitoEventsRequest)
Sets the AWS Lambda function for a given event type for an identity pool.
|
default SetCognitoEventsResponse |
setCognitoEvents(SetCognitoEventsRequest setCognitoEventsRequest)
Sets the AWS Lambda function for a given event type for an identity pool.
|
default SetIdentityPoolConfigurationResponse |
setIdentityPoolConfiguration(Consumer<SetIdentityPoolConfigurationRequest.Builder> setIdentityPoolConfigurationRequest)
Sets the necessary configuration for push sync.
|
default SetIdentityPoolConfigurationResponse |
setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest)
Sets the necessary configuration for push sync.
|
default SubscribeToDatasetResponse |
subscribeToDataset(Consumer<SubscribeToDatasetRequest.Builder> subscribeToDatasetRequest)
Subscribes to receive notifications when a dataset is modified by another device.
|
default SubscribeToDatasetResponse |
subscribeToDataset(SubscribeToDatasetRequest subscribeToDatasetRequest)
Subscribes to receive notifications when a dataset is modified by another device.
|
default UnsubscribeFromDatasetResponse |
unsubscribeFromDataset(Consumer<UnsubscribeFromDatasetRequest.Builder> unsubscribeFromDatasetRequest)
Unsubscribes from receiving notifications when a dataset is modified by another device.
|
default UnsubscribeFromDatasetResponse |
unsubscribeFromDataset(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest)
Unsubscribes from receiving notifications when a dataset is modified by another device.
|
default UpdateRecordsResponse |
updateRecords(Consumer<UpdateRecordsRequest.Builder> updateRecordsRequest)
Posts updates to records and adds and deletes records for a dataset and user.
|
default UpdateRecordsResponse |
updateRecords(UpdateRecordsRequest updateRecordsRequest)
Posts updates to records and adds and deletes records for a dataset and user.
|
serviceName
close
static final String SERVICE_NAME
static CognitoSyncClient create()
CognitoSyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static CognitoSyncClientBuilder builder()
CognitoSyncClient
.default BulkPublishResponse bulkPublish(BulkPublishRequest bulkPublishRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, DuplicateRequestException, AlreadyStreamedException, SdkServiceException, SdkClientException, CognitoSyncException
Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
bulkPublishRequest
- The input for the BulkPublish operation.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.SdkServiceException
default BulkPublishResponse bulkPublish(Consumer<BulkPublishRequest.Builder> bulkPublishRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, DuplicateRequestException, AlreadyStreamedException, SdkServiceException, SdkClientException, CognitoSyncException
Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
bulkPublishRequest
- The input for the BulkPublish operation.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.SdkServiceException
default DeleteDatasetResponse deleteDataset(DeleteDatasetRequest deleteDatasetRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, ResourceConflictException, SdkServiceException, SdkClientException, CognitoSyncException
Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
deleteDatasetRequest
- A request to delete the specific dataset.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.SdkServiceException
default DeleteDatasetResponse deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, ResourceConflictException, SdkServiceException, SdkClientException, CognitoSyncException
Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
deleteDatasetRequest
- A request to delete the specific dataset.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.SdkServiceException
default DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
describeDatasetRequest
- A request for meta data about a dataset (creation date, number of records, size) by owner and dataset
name.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.SdkServiceException
default DescribeDatasetResponse describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
describeDatasetRequest
- A request for meta data about a dataset (creation date, number of records, size) by owner and dataset
name.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.SdkServiceException
default DescribeIdentityPoolUsageResponse describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets usage details (for example, data storage) about a particular identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
describeIdentityPoolUsageRequest
- A request for usage information about the identity pool.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.SdkServiceException
default DescribeIdentityPoolUsageResponse describeIdentityPoolUsage(Consumer<DescribeIdentityPoolUsageRequest.Builder> describeIdentityPoolUsageRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets usage details (for example, data storage) about a particular identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
describeIdentityPoolUsageRequest
- A request for usage information about the identity pool.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.SdkServiceException
default DescribeIdentityUsageResponse describeIdentityUsage(DescribeIdentityUsageRequest describeIdentityUsageRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets usage information for an identity, including number of datasets and data usage.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
describeIdentityUsageRequest
- A request for information about the usage of an identity pool.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.SdkServiceException
default DescribeIdentityUsageResponse describeIdentityUsage(Consumer<DescribeIdentityUsageRequest.Builder> describeIdentityUsageRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets usage information for an identity, including number of datasets and data usage.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
describeIdentityUsageRequest
- A request for information about the usage of an identity pool.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.SdkServiceException
default GetBulkPublishDetailsResponse getBulkPublishDetails(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, SdkServiceException, SdkClientException, CognitoSyncException
Get the status of the last BulkPublish operation for an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
getBulkPublishDetailsRequest
- The input for the GetBulkPublishDetails operation.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.SdkServiceException
default GetBulkPublishDetailsResponse getBulkPublishDetails(Consumer<GetBulkPublishDetailsRequest.Builder> getBulkPublishDetailsRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, SdkServiceException, SdkClientException, CognitoSyncException
Get the status of the last BulkPublish operation for an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
getBulkPublishDetailsRequest
- The input for the GetBulkPublishDetails operation.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.SdkServiceException
default GetCognitoEventsResponse getCognitoEvents(GetCognitoEventsRequest getCognitoEventsRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets the events and the corresponding Lambda functions associated with an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
getCognitoEventsRequest
- A request for a list of the configured Cognito EventsInvalidParameterException
- 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.SdkServiceException
default GetCognitoEventsResponse getCognitoEvents(Consumer<GetCognitoEventsRequest.Builder> getCognitoEventsRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets the events and the corresponding Lambda functions associated with an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
getCognitoEventsRequest
- A request for a list of the configured Cognito EventsInvalidParameterException
- 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.SdkServiceException
default GetIdentityPoolConfigurationResponse getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets the configuration settings of an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
getIdentityPoolConfigurationRequest
- The input for the GetIdentityPoolConfiguration operation.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.SdkServiceException
default GetIdentityPoolConfigurationResponse getIdentityPoolConfiguration(Consumer<GetIdentityPoolConfigurationRequest.Builder> getIdentityPoolConfigurationRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets the configuration settings of an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
getIdentityPoolConfigurationRequest
- The input for the GetIdentityPoolConfiguration operation.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.SdkServiceException
default ListDatasetsResponse listDatasets(ListDatasetsRequest listDatasetsRequest) throws NotAuthorizedException, InvalidParameterException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.
listDatasetsRequest
- Request for a list of datasets for an identity.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.SdkServiceException
default ListDatasetsResponse listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws NotAuthorizedException, InvalidParameterException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.
listDatasetsRequest
- Request for a list of datasets for an identity.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.SdkServiceException
default ListIdentityPoolUsageResponse listIdentityPoolUsage() throws NotAuthorizedException, InvalidParameterException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
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.
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.SdkServiceException
listIdentityPoolUsage(ListIdentityPoolUsageRequest)
,
AWS API Documentationdefault ListIdentityPoolUsageResponse listIdentityPoolUsage(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest) throws NotAuthorizedException, InvalidParameterException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets a list of identity pools registered with Cognito.
ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.
listIdentityPoolUsageRequest
- A request for usage information on an identity pool.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.SdkServiceException
default ListIdentityPoolUsageResponse listIdentityPoolUsage(Consumer<ListIdentityPoolUsageRequest.Builder> listIdentityPoolUsageRequest) throws NotAuthorizedException, InvalidParameterException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Gets a list of identity pools registered with Cognito.
ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.
listIdentityPoolUsageRequest
- A request for usage information on an identity pool.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.SdkServiceException
default ListRecordsResponse listRecords(ListRecordsRequest listRecordsRequest) throws InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, SdkServiceException, SdkClientException, CognitoSyncException
Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
listRecordsRequest
- A request for a list of records.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.SdkServiceException
default ListRecordsResponse listRecords(Consumer<ListRecordsRequest.Builder> listRecordsRequest) throws InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, SdkServiceException, SdkClientException, CognitoSyncException
Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
listRecordsRequest
- A request for a list of records.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.SdkServiceException
default RegisterDeviceResponse registerDevice(RegisterDeviceRequest registerDeviceRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, InvalidConfigurationException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Registers a device to receive push sync notifications.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
registerDeviceRequest
- A request to RegisterDevice.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.SdkServiceException
default RegisterDeviceResponse registerDevice(Consumer<RegisterDeviceRequest.Builder> registerDeviceRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, InvalidConfigurationException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Registers a device to receive push sync notifications.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
registerDeviceRequest
- A request to RegisterDevice.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.SdkServiceException
default SetCognitoEventsResponse setCognitoEvents(SetCognitoEventsRequest setCognitoEventsRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
setCognitoEventsRequest
- A request to configure Cognito Events"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.SdkServiceException
default SetCognitoEventsResponse setCognitoEvents(Consumer<SetCognitoEventsRequest.Builder> setCognitoEventsRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InternalErrorException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
setCognitoEventsRequest
- A request to configure Cognito Events"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.SdkServiceException
default SetIdentityPoolConfigurationResponse setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, ConcurrentModificationException, SdkServiceException, SdkClientException, CognitoSyncException
Sets the necessary configuration for push sync.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
setIdentityPoolConfigurationRequest
- The input for the SetIdentityPoolConfiguration operation.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.SdkServiceException
default SetIdentityPoolConfigurationResponse setIdentityPoolConfiguration(Consumer<SetIdentityPoolConfigurationRequest.Builder> setIdentityPoolConfigurationRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, TooManyRequestsException, ConcurrentModificationException, SdkServiceException, SdkClientException, CognitoSyncException
Sets the necessary configuration for push sync.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
setIdentityPoolConfigurationRequest
- The input for the SetIdentityPoolConfiguration operation.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.SdkServiceException
default SubscribeToDatasetResponse subscribeToDataset(SubscribeToDatasetRequest subscribeToDatasetRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, InvalidConfigurationException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Subscribes to receive notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
subscribeToDatasetRequest
- A request to SubscribeToDatasetRequest.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.SdkServiceException
default SubscribeToDatasetResponse subscribeToDataset(Consumer<SubscribeToDatasetRequest.Builder> subscribeToDatasetRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, InvalidConfigurationException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Subscribes to receive notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
subscribeToDatasetRequest
- A request to SubscribeToDatasetRequest.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.SdkServiceException
default UnsubscribeFromDatasetResponse unsubscribeFromDataset(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, InvalidConfigurationException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Unsubscribes from receiving notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
unsubscribeFromDatasetRequest
- A request to UnsubscribeFromDataset.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.SdkServiceException
default UnsubscribeFromDatasetResponse unsubscribeFromDataset(Consumer<UnsubscribeFromDatasetRequest.Builder> unsubscribeFromDatasetRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, InvalidConfigurationException, TooManyRequestsException, SdkServiceException, SdkClientException, CognitoSyncException
Unsubscribes from receiving notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
unsubscribeFromDatasetRequest
- A request to UnsubscribeFromDataset.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.SdkServiceException
default UpdateRecordsResponse updateRecords(UpdateRecordsRequest updateRecordsRequest) throws InvalidParameterException, LimitExceededException, NotAuthorizedException, ResourceNotFoundException, ResourceConflictException, InvalidLambdaFunctionOutputException, LambdaThrottledException, TooManyRequestsException, InternalErrorException, SdkServiceException, SdkClientException, CognitoSyncException
Posts updates to records and adds and deletes records for a dataset and user.
The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.
For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
updateRecordsRequest
- A request to post updates to records or add and delete records for a dataset and user.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 SupportTooManyRequestsException
- 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.SdkServiceException
default UpdateRecordsResponse updateRecords(Consumer<UpdateRecordsRequest.Builder> updateRecordsRequest) throws InvalidParameterException, LimitExceededException, NotAuthorizedException, ResourceNotFoundException, ResourceConflictException, InvalidLambdaFunctionOutputException, LambdaThrottledException, TooManyRequestsException, InternalErrorException, SdkServiceException, SdkClientException, CognitoSyncException
Posts updates to records and adds and deletes records for a dataset and user.
The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.
For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
updateRecordsRequest
- A request to post updates to records or add and delete records for a dataset and user.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 SupportTooManyRequestsException
- 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.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.