:doc:`CognitoSync <../../cognito-sync>` / Client / unsubscribe_from_dataset

************************
unsubscribe_from_dataset
************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UnsubscribeFromDataset>`_  


  **Request Syntax**
  ::

    response = client.unsubscribe_from_dataset(
        IdentityPoolId='string',
        IdentityId='string',
        DatasetName='string',
        DeviceId='string'
    )
    
  :type IdentityPoolId: string
  :param IdentityPoolId: **[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.

    

  
  :type IdentityId: string
  :param IdentityId: **[REQUIRED]** 

    Unique ID for this identity.

    

  
  :type DatasetName: string
  :param DatasetName: **[REQUIRED]** 

    The name of the dataset from which to unsubcribe.

    

  
  :type DeviceId: string
  :param DeviceId: **[REQUIRED]** 

    The unique ID generated for this device by Cognito.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 

      Response to an UnsubscribeFromDataset request.

      
  
  **Exceptions**
  
  *   :py:class:`CognitoSync.Client.exceptions.NotAuthorizedException`

  
  *   :py:class:`CognitoSync.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`CognitoSync.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CognitoSync.Client.exceptions.InternalErrorException`

  
  *   :py:class:`CognitoSync.Client.exceptions.InvalidConfigurationException`

  
  *   :py:class:`CognitoSync.Client.exceptions.TooManyRequestsException`

  