amazonka-cognito-sync-1.6.0: Amazon Cognito Sync SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoSync.RegisterDevice

Contents

Description

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.

Synopsis

Creating a Request

registerDevice Source #

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

A request to RegisterDevice.

See: registerDevice smart constructor.

Instances

Eq RegisterDevice Source # 
Data RegisterDevice Source # 

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 Source # 
Show RegisterDevice Source # 
Generic RegisterDevice Source # 

Associated Types

type Rep RegisterDevice :: * -> * #

Hashable RegisterDevice Source # 
ToJSON RegisterDevice Source # 
NFData RegisterDevice Source # 

Methods

rnf :: RegisterDevice -> () #

AWSRequest RegisterDevice Source # 
ToHeaders RegisterDevice Source # 
ToPath RegisterDevice Source # 
ToQuery RegisterDevice Source # 
type Rep RegisterDevice Source # 
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 Source # 

Request Lenses

rdIdentityPoolId :: Lens' RegisterDevice Text Source #

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

The unique ID for this identity.

rdPlatform :: Lens' RegisterDevice Platform Source #

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

Destructuring the Response

registerDeviceResponse Source #

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:

data RegisterDeviceResponse Source #

Response to a RegisterDevice request.

See: registerDeviceResponse smart constructor.

Instances

Eq RegisterDeviceResponse Source # 
Data RegisterDeviceResponse Source # 

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 Source # 
Show RegisterDeviceResponse Source # 
Generic RegisterDeviceResponse Source # 
NFData RegisterDeviceResponse Source # 

Methods

rnf :: RegisterDeviceResponse -> () #

type Rep RegisterDeviceResponse Source # 
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) Source #

The unique ID generated for this device by Cognito.

rdrsResponseStatus :: Lens' RegisterDeviceResponse Int Source #

  • - | The response status code.