CognitoSync / Client / unsubscribe_from_dataset
unsubscribe_from_dataset#
- CognitoSync.Client.unsubscribe_from_dataset(**kwargs)#
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.
See also: AWS API Documentation
Request Syntax
response = client.unsubscribe_from_dataset( IdentityPoolId='string', IdentityId='string', DatasetName='string', DeviceId='string' )
- Parameters:
IdentityPoolId (string) –
[REQUIRED]
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.
IdentityId (string) –
[REQUIRED]
Unique ID for this identity.
DatasetName (string) –
[REQUIRED]
The name of the dataset from which to unsubcribe.
DeviceId (string) –
[REQUIRED]
The unique ID generated for this device by Cognito.
- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
Response to an UnsubscribeFromDataset request.
Exceptions
CognitoSync.Client.exceptions.NotAuthorizedException
CognitoSync.Client.exceptions.InvalidParameterException
CognitoSync.Client.exceptions.ResourceNotFoundException
CognitoSync.Client.exceptions.InternalErrorException
CognitoSync.Client.exceptions.InvalidConfigurationException
CognitoSync.Client.exceptions.TooManyRequestsException