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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb

Overview

Note:

When making an API call, you may pass UnsubscribeFromDatasetRequest data as a 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)


1111
1112
1113
1114
1115
1116
1117
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1111

class UnsubscribeFromDatasetRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :device_id)
  include Aws::Structure
end

#device_idString

The unique ID generated for this device by Cognito.

Returns:

  • (String)


1111
1112
1113
1114
1115
1116
1117
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1111

class UnsubscribeFromDatasetRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :device_id)
  include Aws::Structure
end

#identity_idString

Unique ID for this identity.

Returns:

  • (String)


1111
1112
1113
1114
1115
1116
1117
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1111

class UnsubscribeFromDatasetRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :device_id)
  include Aws::Structure
end

#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)


1111
1112
1113
1114
1115
1116
1117
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 1111

class UnsubscribeFromDatasetRequest < Struct.new(
  :identity_pool_id,
  :identity_id,
  :dataset_name,
  :device_id)
  include Aws::Structure
end