CognitoSync / Client / subscribe_to_dataset

subscribe_to_dataset#

CognitoSync.Client.subscribe_to_dataset(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.subscribe_to_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 the identity belongs.

  • IdentityId (string) –

    [REQUIRED]

    Unique ID for this identity.

  • DatasetName (string) –

    [REQUIRED]

    The name of the dataset to subcribe to.

  • DeviceId (string) –

    [REQUIRED]

    The unique ID generated for this device by Cognito.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    Response to a SubscribeToDataset request.

Exceptions