AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoSync::Types::UnsubscribeFromDatasetRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UnsubscribeFromDatasetRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId", # required
  dataset_name: "DatasetName", # required
  device_id: "DeviceId", # required
}

A request to UnsubscribeFromDataset.

Instance Attribute Summary collapse

Instance Attribute Details

#dataset_nameString

The name of the dataset from which to unsubcribe.

Returns:

  • (String)

    The name of the dataset from which to unsubcribe.

#device_idString

The unique ID generated for this device by Cognito.

Returns:

  • (String)

    The unique ID generated for this device by Cognito.

#identity_idString

Unique ID for this identity.

Returns:

  • (String)

    Unique ID for this identity.

#identity_pool_idString

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.

Returns:

  • (String)

    A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.