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

Amazonka.CognitoSync.RegisterDevice

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

data RegisterDevice Source #

A request to RegisterDevice.

See: newRegisterDevice smart constructor.

Constructors

RegisterDevice' 

Fields

  • identityPoolId :: 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.

  • identityId :: Text

    The unique ID for this identity.

  • platform :: Platform

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

  • token :: Text

    The push token.

Instances

Instances details
Eq RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

Read RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

Show RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

Generic RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

Associated Types

type Rep RegisterDevice :: Type -> Type #

NFData RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

Methods

rnf :: RegisterDevice -> () #

Hashable RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

ToJSON RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

AWSRequest RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

Associated Types

type AWSResponse RegisterDevice #

ToHeaders RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

ToPath RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

ToQuery RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

type Rep RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

type Rep RegisterDevice = D1 ('MetaData "RegisterDevice" "Amazonka.CognitoSync.RegisterDevice" "libZSservicesZSamazonka-cognito-syncZSamazonka-cognito-sync" 'False) (C1 ('MetaCons "RegisterDevice'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Platform) :*: S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse RegisterDevice Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

newRegisterDevice Source #

Create a value of RegisterDevice 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:identityPoolId:RegisterDevice', registerDevice_identityPoolId - 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.

$sel:identityId:RegisterDevice', registerDevice_identityId - The unique ID for this identity.

$sel:platform:RegisterDevice', registerDevice_platform - The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

$sel:token:RegisterDevice', registerDevice_token - The push token.

Request Lenses

registerDevice_identityPoolId :: 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.

registerDevice_identityId :: Lens' RegisterDevice Text Source #

The unique ID for this identity.

registerDevice_platform :: Lens' RegisterDevice Platform Source #

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

Destructuring the Response

data RegisterDeviceResponse Source #

Response to a RegisterDevice request.

See: newRegisterDeviceResponse smart constructor.

Constructors

RegisterDeviceResponse' 

Fields

Instances

Instances details
Eq RegisterDeviceResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

Read RegisterDeviceResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

Show RegisterDeviceResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

Generic RegisterDeviceResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

Associated Types

type Rep RegisterDeviceResponse :: Type -> Type #

NFData RegisterDeviceResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

Methods

rnf :: RegisterDeviceResponse -> () #

type Rep RegisterDeviceResponse Source # 
Instance details

Defined in Amazonka.CognitoSync.RegisterDevice

type Rep RegisterDeviceResponse = D1 ('MetaData "RegisterDeviceResponse" "Amazonka.CognitoSync.RegisterDevice" "libZSservicesZSamazonka-cognito-syncZSamazonka-cognito-sync" 'False) (C1 ('MetaCons "RegisterDeviceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterDeviceResponse Source #

Create a value of RegisterDeviceResponse 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:deviceId:RegisterDeviceResponse', registerDeviceResponse_deviceId - The unique ID generated for this device by Cognito.

$sel:httpStatus:RegisterDeviceResponse', registerDeviceResponse_httpStatus - The response's http status code.

Response Lenses

registerDeviceResponse_deviceId :: Lens' RegisterDeviceResponse (Maybe Text) Source #

The unique ID generated for this device by Cognito.