Amazonka.CognitoSync.SubscribeToDataset

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.

Creating a Request

data SubscribeToDataset

A request to SubscribeToDatasetRequest.

See: newSubscribeToDataset smart constructor.

Constructors

SubscribeToDataset'

Fields

• identityPoolId :: Text

  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 :: Text

  Unique ID for this identity.

• datasetName :: Text

  The name of the dataset to subcribe to.

• deviceId :: Text

  The unique ID generated for this device by Cognito.

Instances

ToJSON SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

toJSON :: SubscribeToDataset -> Value

toEncoding :: SubscribeToDataset -> Encoding

toJSONList :: [SubscribeToDataset] -> Value

toEncodingList :: [SubscribeToDataset] -> Encoding

ToHeaders SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

toHeaders :: SubscribeToDataset -> [Header]

ToPath SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

toPath :: SubscribeToDataset -> ByteString

ToQuery SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

toQuery :: SubscribeToDataset -> QueryString

AWSRequest SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

Associated Types

type AWSResponse SubscribeToDataset

Methods

request :: (Service -> Service) -> SubscribeToDataset -> Request SubscribeToDataset

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SubscribeToDataset -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SubscribeToDataset)))

Generic SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

Associated Types

type Rep SubscribeToDataset :: Type -> Type

Methods

from :: SubscribeToDataset -> Rep SubscribeToDataset x

to :: Rep SubscribeToDataset x -> SubscribeToDataset

Read SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

readsPrec :: Int -> ReadS SubscribeToDataset

readList :: ReadS [SubscribeToDataset]

readPrec :: ReadPrec SubscribeToDataset

readListPrec :: ReadPrec [SubscribeToDataset]

Show SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

showsPrec :: Int -> SubscribeToDataset -> ShowS

show :: SubscribeToDataset -> String

showList :: [SubscribeToDataset] -> ShowS

NFData SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

rnf :: SubscribeToDataset -> ()

Eq SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

(==) :: SubscribeToDataset -> SubscribeToDataset -> Bool

(/=) :: SubscribeToDataset -> SubscribeToDataset -> Bool

Hashable SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

hashWithSalt :: Int -> SubscribeToDataset -> Int

hash :: SubscribeToDataset -> Int

type AWSResponse SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

type AWSResponse SubscribeToDataset = SubscribeToDatasetResponse

type Rep SubscribeToDataset

Defined in Amazonka.CognitoSync.SubscribeToDataset

type Rep SubscribeToDataset = D1 ('MetaData "SubscribeToDataset" "Amazonka.CognitoSync.SubscribeToDataset" "amazonka-cognito-sync-2.0-4eAo0O3jWiUGlkSwv2vKaB" 'False) (C1 ('MetaCons "SubscribeToDataset'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSubscribeToDataset

Arguments

:: Text

SubscribeToDataset

-> Text

SubscribeToDataset

-> Text

SubscribeToDataset

-> Text

$sel:deviceId:SubscribeToDataset'

-> SubscribeToDataset

Create a value of SubscribeToDataset with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SubscribeToDataset, subscribeToDataset_identityPoolId - 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.

SubscribeToDataset, subscribeToDataset_identityId - Unique ID for this identity.

SubscribeToDataset, subscribeToDataset_datasetName - The name of the dataset to subcribe to.

$sel:deviceId:SubscribeToDataset', subscribeToDataset_deviceId - The unique ID generated for this device by Cognito.

Request Lenses

subscribeToDataset_identityPoolId :: Lens' SubscribeToDataset Text

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.

subscribeToDataset_identityId :: Lens' SubscribeToDataset Text

Unique ID for this identity.

subscribeToDataset_datasetName :: Lens' SubscribeToDataset Text

The name of the dataset to subcribe to.

subscribeToDataset_deviceId :: Lens' SubscribeToDataset Text

The unique ID generated for this device by Cognito.

Destructuring the Response

data SubscribeToDatasetResponse

Response to a SubscribeToDataset request.

See: newSubscribeToDatasetResponse smart constructor.

Constructors

SubscribeToDatasetResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic SubscribeToDatasetResponse

Defined in Amazonka.CognitoSync.SubscribeToDataset

Associated Types

type Rep SubscribeToDatasetResponse :: Type -> Type

Methods

from :: SubscribeToDatasetResponse -> Rep SubscribeToDatasetResponse x

to :: Rep SubscribeToDatasetResponse x -> SubscribeToDatasetResponse

Read SubscribeToDatasetResponse

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

readsPrec :: Int -> ReadS SubscribeToDatasetResponse

readList :: ReadS [SubscribeToDatasetResponse]

readPrec :: ReadPrec SubscribeToDatasetResponse

readListPrec :: ReadPrec [SubscribeToDatasetResponse]

Show SubscribeToDatasetResponse

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

showsPrec :: Int -> SubscribeToDatasetResponse -> ShowS

show :: SubscribeToDatasetResponse -> String

showList :: [SubscribeToDatasetResponse] -> ShowS

NFData SubscribeToDatasetResponse

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

rnf :: SubscribeToDatasetResponse -> ()

Eq SubscribeToDatasetResponse

Defined in Amazonka.CognitoSync.SubscribeToDataset

Methods

(==) :: SubscribeToDatasetResponse -> SubscribeToDatasetResponse -> Bool

(/=) :: SubscribeToDatasetResponse -> SubscribeToDatasetResponse -> Bool

type Rep SubscribeToDatasetResponse

Defined in Amazonka.CognitoSync.SubscribeToDataset

type Rep SubscribeToDatasetResponse = D1 ('MetaData "SubscribeToDatasetResponse" "Amazonka.CognitoSync.SubscribeToDataset" "amazonka-cognito-sync-2.0-4eAo0O3jWiUGlkSwv2vKaB" 'False) (C1 ('MetaCons "SubscribeToDatasetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSubscribeToDatasetResponse

Arguments

:: Int

$sel:httpStatus:SubscribeToDatasetResponse'

-> SubscribeToDatasetResponse

Create a value of SubscribeToDatasetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:SubscribeToDatasetResponse', subscribeToDatasetResponse_httpStatus - The response's http status code.

Response Lenses

subscribeToDatasetResponse_httpStatus :: Lens' SubscribeToDatasetResponse Int

The response's http status code.