confirm_device

CognitoIdentityProvider.Client.confirm_device(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.confirm_device(
    AccessToken='string',
    DeviceKey='string',
    DeviceSecretVerifierConfig={
        'PasswordVerifier': 'string',
        'Salt': 'string'
    },
    DeviceName='string'
)

Parameters

• AccessToken (string) --

  [REQUIRED]

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

• DeviceKey (string) --

  [REQUIRED]

  The device key.

• DeviceSecretVerifierConfig (dict) --

  The configuration of the device secret verifier.

  • PasswordVerifier (string) --

    The password verifier.

  • Salt (string) --

    The salt

• DeviceName (string) -- The device name.

Return type

dict

Returns

Response Syntax

{
    'UserConfirmationNecessary': True|False
}

Response Structure

• (dict) --

  Confirms the device response.

  • UserConfirmationNecessary (boolean) --

    Indicates whether the user confirmation must confirm the device response.

Exceptions

• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
• CognitoIdentityProvider.Client.exceptions.InvalidParameterException
• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
• CognitoIdentityProvider.Client.exceptions.InvalidPasswordException
• CognitoIdentityProvider.Client.exceptions.InvalidLambdaResponseException
• CognitoIdentityProvider.Client.exceptions.UsernameExistsException
• CognitoIdentityProvider.Client.exceptions.InvalidUserPoolConfigurationException
• CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
• CognitoIdentityProvider.Client.exceptions.PasswordResetRequiredException
• CognitoIdentityProvider.Client.exceptions.UserNotFoundException
• CognitoIdentityProvider.Client.exceptions.UserNotConfirmedException
• CognitoIdentityProvider.Client.exceptions.InternalErrorException
• CognitoIdentityProvider.Client.exceptions.ForbiddenException