Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoIdentityProvider.ConfirmDevice

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Confirms tracking of the device. This API call is the call that begins device tracking.

Creating a Request

data ConfirmDevice Source #

Confirms the device request.

See: newConfirmDevice smart constructor.

Constructors

ConfirmDevice'
Fields deviceName :: Maybe Text The device name. deviceSecretVerifierConfig :: Maybe DeviceSecretVerifierConfigType The configuration of the device secret verifier. accessToken :: Sensitive Text A valid access token that Amazon Cognito issued to the user whose device you want to confirm. deviceKey :: Text The device key.

Instances

Instances details

ToJSON ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods toJSON :: ConfirmDevice -> Value # toEncoding :: ConfirmDevice -> Encoding # toJSONList :: [ConfirmDevice] -> Value # toEncodingList :: [ConfirmDevice] -> Encoding #
ToHeaders ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods toHeaders :: ConfirmDevice -> [Header] #
ToPath ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods toPath :: ConfirmDevice -> ByteString #
ToQuery ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods toQuery :: ConfirmDevice -> QueryString #
AWSRequest ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Associated Types type AWSResponse ConfirmDevice # Methods request :: (Service -> Service) -> ConfirmDevice -> Request ConfirmDevice # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ConfirmDevice -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ConfirmDevice))) #
Generic ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Associated Types type Rep ConfirmDevice :: Type -> Type # Methods from :: ConfirmDevice -> Rep ConfirmDevice x # to :: Rep ConfirmDevice x -> ConfirmDevice #
Show ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods showsPrec :: Int -> ConfirmDevice -> ShowS # show :: ConfirmDevice -> String # showList :: [ConfirmDevice] -> ShowS #
NFData ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods rnf :: ConfirmDevice -> () #
Eq ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods (==) :: ConfirmDevice -> ConfirmDevice -> Bool # (/=) :: ConfirmDevice -> ConfirmDevice -> Bool #
Hashable ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods hashWithSalt :: Int -> ConfirmDevice -> Int # hash :: ConfirmDevice -> Int #
type AWSResponse ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice type AWSResponse ConfirmDevice = ConfirmDeviceResponse
type Rep ConfirmDevice Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice type Rep ConfirmDevice = D1 ('MetaData "ConfirmDevice" "Amazonka.CognitoIdentityProvider.ConfirmDevice" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "ConfirmDevice'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deviceSecretVerifierConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceSecretVerifierConfigType))) :: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "deviceKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newConfirmDevice Source #

Arguments

:: Text	`ConfirmDevice`
-> Text	`ConfirmDevice`
-> ConfirmDevice

Create a value of ConfirmDevice 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:

ConfirmDevice, confirmDevice_deviceName - The device name.

$sel:deviceSecretVerifierConfig:ConfirmDevice', confirmDevice_deviceSecretVerifierConfig - The configuration of the device secret verifier.

ConfirmDevice, confirmDevice_accessToken - A valid access token that Amazon Cognito issued to the user whose device you want to confirm.

ConfirmDevice, confirmDevice_deviceKey - The device key.

Request Lenses

confirmDevice_deviceName :: Lens' ConfirmDevice (Maybe Text) Source #

The device name.

confirmDevice_deviceSecretVerifierConfig :: Lens' ConfirmDevice (Maybe DeviceSecretVerifierConfigType) Source #

The configuration of the device secret verifier.

confirmDevice_accessToken :: Lens' ConfirmDevice Text Source #

A valid access token that Amazon Cognito issued to the user whose device you want to confirm.

confirmDevice_deviceKey :: Lens' ConfirmDevice Text Source #

The device key.

Destructuring the Response

data ConfirmDeviceResponse Source #

Confirms the device response.

See: newConfirmDeviceResponse smart constructor.

Constructors

ConfirmDeviceResponse'
Fields userConfirmationNecessary :: Maybe Bool Indicates whether the user confirmation must confirm the device response. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ConfirmDeviceResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Associated Types type Rep ConfirmDeviceResponse :: Type -> Type # Methods from :: ConfirmDeviceResponse -> Rep ConfirmDeviceResponse x # to :: Rep ConfirmDeviceResponse x -> ConfirmDeviceResponse #
Read ConfirmDeviceResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods readsPrec :: Int -> ReadS ConfirmDeviceResponse # readList :: ReadS [ConfirmDeviceResponse] # readPrec :: ReadPrec ConfirmDeviceResponse # readListPrec :: ReadPrec [ConfirmDeviceResponse] #
Show ConfirmDeviceResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods showsPrec :: Int -> ConfirmDeviceResponse -> ShowS # show :: ConfirmDeviceResponse -> String # showList :: [ConfirmDeviceResponse] -> ShowS #
NFData ConfirmDeviceResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods rnf :: ConfirmDeviceResponse -> () #
Eq ConfirmDeviceResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice Methods (==) :: ConfirmDeviceResponse -> ConfirmDeviceResponse -> Bool # (/=) :: ConfirmDeviceResponse -> ConfirmDeviceResponse -> Bool #
type Rep ConfirmDeviceResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ConfirmDevice type Rep ConfirmDeviceResponse = D1 ('MetaData "ConfirmDeviceResponse" "Amazonka.CognitoIdentityProvider.ConfirmDevice" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "ConfirmDeviceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userConfirmationNecessary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newConfirmDeviceResponse Source #

Arguments

:: Int	`$sel:httpStatus:ConfirmDeviceResponse'`
-> ConfirmDeviceResponse

Create a value of ConfirmDeviceResponse 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:userConfirmationNecessary:ConfirmDeviceResponse', confirmDeviceResponse_userConfirmationNecessary - Indicates whether the user confirmation must confirm the device response.

$sel:httpStatus:ConfirmDeviceResponse', confirmDeviceResponse_httpStatus - The response's http status code.

Response Lenses

confirmDeviceResponse_userConfirmationNecessary :: Lens' ConfirmDeviceResponse (Maybe Bool) Source #

Indicates whether the user confirmation must confirm the device response.

confirmDeviceResponse_httpStatus :: Lens' ConfirmDeviceResponse Int Source #

The response's http status code.