Network.AWS.CognitoSync.RegisterDevice

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Creating a Request

registerDevice

Arguments

:: Text

rdIdentityPoolId

-> Text

rdIdentityId

-> Platform

rdPlatform

-> Text

rdToken

-> RegisterDevice

Creates a value of RegisterDevice with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdIdentityPoolId - A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.
• rdIdentityId - The unique ID for this identity.
• rdPlatform - The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
• rdToken - The push token.

data RegisterDevice

A request to RegisterDevice.

See: registerDevice smart constructor.

Instances

Eq RegisterDevice

Methods

(==) :: RegisterDevice -> RegisterDevice -> Bool

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

Data RegisterDevice

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterDevice -> c RegisterDevice

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterDevice

toConstr :: RegisterDevice -> Constr

dataTypeOf :: RegisterDevice -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterDevice)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterDevice)

gmapT :: (forall b. Data b => b -> b) -> RegisterDevice -> RegisterDevice

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDevice -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDevice -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterDevice -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterDevice -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterDevice -> m RegisterDevice

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDevice -> m RegisterDevice

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDevice -> m RegisterDevice

Read RegisterDevice

Methods

readsPrec :: Int -> ReadS RegisterDevice

readList :: ReadS [RegisterDevice]

readPrec :: ReadPrec RegisterDevice

readListPrec :: ReadPrec [RegisterDevice]

Show RegisterDevice

Methods

showsPrec :: Int -> RegisterDevice -> ShowS

show :: RegisterDevice -> String

showList :: [RegisterDevice] -> ShowS

Generic RegisterDevice

Associated Types

type Rep RegisterDevice :: * -> *

Methods

from :: RegisterDevice -> Rep RegisterDevice x

to :: Rep RegisterDevice x -> RegisterDevice

Hashable RegisterDevice

Methods

hashWithSalt :: Int -> RegisterDevice -> Int

hash :: RegisterDevice -> Int

ToJSON RegisterDevice

Methods

toJSON :: RegisterDevice -> Value

toEncoding :: RegisterDevice -> Encoding

toJSONList :: [RegisterDevice] -> Value

toEncodingList :: [RegisterDevice] -> Encoding

NFData RegisterDevice

Methods

rnf :: RegisterDevice -> ()

AWSRequest RegisterDevice

Associated Types

type Rs RegisterDevice :: *

Methods

request :: RegisterDevice -> Request RegisterDevice

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * RegisterDevice -> ClientResponse -> m (Response RegisterDevice)

ToHeaders RegisterDevice

Methods

toHeaders :: RegisterDevice -> [Header]

ToPath RegisterDevice

Methods

toPath :: RegisterDevice -> ByteString

ToQuery RegisterDevice

Methods

toQuery :: RegisterDevice -> QueryString

type Rep RegisterDevice

type Rep RegisterDevice = D1 * (MetaData "RegisterDevice" "Network.AWS.CognitoSync.RegisterDevice" "amazonka-cognito-sync-1.6.0-4ZDIfAcLSDvASU5l7zxfWR" False) (C1 * (MetaCons "RegisterDevice'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rdIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_rdIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rdPlatform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Platform)) (S1 * (MetaSel (Just Symbol "_rdToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs RegisterDevice

type Rs RegisterDevice = RegisterDeviceResponse

Request Lenses

rdIdentityPoolId :: Lens' RegisterDevice Text

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.

rdIdentityId :: Lens' RegisterDevice Text

The unique ID for this identity.

rdPlatform :: Lens' RegisterDevice Platform

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

rdToken :: Lens' RegisterDevice Text

The push token.

Destructuring the Response

registerDeviceResponse

Arguments

:: Int

rdrsResponseStatus

-> RegisterDeviceResponse

Creates a value of RegisterDeviceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdrsDeviceId - The unique ID generated for this device by Cognito.
• rdrsResponseStatus - -- | The response status code.

data RegisterDeviceResponse

Response to a RegisterDevice request.

See: registerDeviceResponse smart constructor.

Instances

Eq RegisterDeviceResponse

Methods

(==) :: RegisterDeviceResponse -> RegisterDeviceResponse -> Bool

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

Data RegisterDeviceResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterDeviceResponse -> c RegisterDeviceResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterDeviceResponse

toConstr :: RegisterDeviceResponse -> Constr

dataTypeOf :: RegisterDeviceResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterDeviceResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterDeviceResponse)

gmapT :: (forall b. Data b => b -> b) -> RegisterDeviceResponse -> RegisterDeviceResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDeviceResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDeviceResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterDeviceResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterDeviceResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterDeviceResponse -> m RegisterDeviceResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDeviceResponse -> m RegisterDeviceResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDeviceResponse -> m RegisterDeviceResponse

Read RegisterDeviceResponse

Methods

readsPrec :: Int -> ReadS RegisterDeviceResponse

readList :: ReadS [RegisterDeviceResponse]

readPrec :: ReadPrec RegisterDeviceResponse

readListPrec :: ReadPrec [RegisterDeviceResponse]

Show RegisterDeviceResponse

Methods

showsPrec :: Int -> RegisterDeviceResponse -> ShowS

show :: RegisterDeviceResponse -> String

showList :: [RegisterDeviceResponse] -> ShowS

Generic RegisterDeviceResponse

Associated Types

type Rep RegisterDeviceResponse :: * -> *

Methods

from :: RegisterDeviceResponse -> Rep RegisterDeviceResponse x

to :: Rep RegisterDeviceResponse x -> RegisterDeviceResponse

NFData RegisterDeviceResponse

Methods

rnf :: RegisterDeviceResponse -> ()

type Rep RegisterDeviceResponse

type Rep RegisterDeviceResponse = D1 * (MetaData "RegisterDeviceResponse" "Network.AWS.CognitoSync.RegisterDevice" "amazonka-cognito-sync-1.6.0-4ZDIfAcLSDvASU5l7zxfWR" False) (C1 * (MetaCons "RegisterDeviceResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_rdrsDeviceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

rdrsDeviceId :: Lens' RegisterDeviceResponse (Maybe Text)

The unique ID generated for this device by Cognito.

rdrsResponseStatus :: Lens' RegisterDeviceResponse Int

• - | The response status code.