public interface AmazonCognitoSync
void setEndpoint(java.lang.String endpoint)
throws java.lang.IllegalArgumentException
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.
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.java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.void setRegion(Region region) throws java.lang.IllegalArgumentException
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.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.java.lang.IllegalArgumentException - If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)UpdateRecordsResult updateRecords(UpdateRecordsRequest updateRecordsRequest) throws AmazonServiceException, AmazonClientException
updateRecordsRequest - Container for the necessary parameters to
execute the UpdateRecords service method on AmazonCognitoSync.LimitExceededExceptionTooManyRequestsExceptionResourceConflictExceptionInvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.DescribeIdentityUsageResult describeIdentityUsage(DescribeIdentityUsageRequest describeIdentityUsageRequest) throws AmazonServiceException, AmazonClientException
describeIdentityUsageRequest - Container for the necessary
parameters to execute the DescribeIdentityUsage service method on
AmazonCognitoSync.InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.SetIdentityPoolConfigurationResult setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest) throws AmazonServiceException, AmazonClientException
setIdentityPoolConfigurationRequest - Container for the necessary
parameters to execute the SetIdentityPoolConfiguration service method
on AmazonCognitoSync.InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.GetIdentityPoolConfigurationResult getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest) throws AmazonServiceException, AmazonClientException
getIdentityPoolConfigurationRequest - Container for the necessary
parameters to execute the GetIdentityPoolConfiguration service method
on AmazonCognitoSync.InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.UnsubscribeFromDatasetResult unsubscribeFromDataset(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest) throws AmazonServiceException, AmazonClientException
unsubscribeFromDatasetRequest - Container for the necessary
parameters to execute the UnsubscribeFromDataset service method on
AmazonCognitoSync.InvalidConfigurationExceptionInvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.SubscribeToDatasetResult subscribeToDataset(SubscribeToDatasetRequest subscribeToDatasetRequest) throws AmazonServiceException, AmazonClientException
subscribeToDatasetRequest - Container for the necessary
parameters to execute the SubscribeToDataset service method on
AmazonCognitoSync.InvalidConfigurationExceptionInvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.DescribeIdentityPoolUsageResult describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest) throws AmazonServiceException, AmazonClientException
describeIdentityPoolUsageRequest - Container for the necessary
parameters to execute the DescribeIdentityPoolUsage service method on
AmazonCognitoSync.InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest) throws AmazonServiceException, AmazonClientException
listDatasetsRequest - Container for the necessary parameters to
execute the ListDatasets service method on AmazonCognitoSync.InvalidParameterExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.ListIdentityPoolUsageResult listIdentityPoolUsage(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest) throws AmazonServiceException, AmazonClientException
listIdentityPoolUsageRequest - Container for the necessary
parameters to execute the ListIdentityPoolUsage service method on
AmazonCognitoSync.InvalidParameterExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.ListRecordsResult listRecords(ListRecordsRequest listRecordsRequest) throws AmazonServiceException, AmazonClientException
listRecordsRequest - Container for the necessary parameters to
execute the ListRecords service method on AmazonCognitoSync.TooManyRequestsExceptionInvalidParameterExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest) throws AmazonServiceException, AmazonClientException
describeDatasetRequest - Container for the necessary parameters
to execute the DescribeDataset service method on AmazonCognitoSync.InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest) throws AmazonServiceException, AmazonClientException
deleteDatasetRequest - Container for the necessary parameters to
execute the DeleteDataset service method on AmazonCognitoSync.InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.RegisterDeviceResult registerDevice(RegisterDeviceRequest registerDeviceRequest) throws AmazonServiceException, AmazonClientException
registerDeviceRequest - Container for the necessary parameters to
execute the RegisterDevice service method on AmazonCognitoSync.InvalidConfigurationExceptionInvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.