Try it now and let us know what you think. Switch to the new look >>
You can return to the original look by selecting English in the language selector above.
ConfirmDevice
Confirms tracking of the device. This API call is the call that begins device tracking.
Request Syntax
{ "AccessToken": "string", "DeviceKey": "string", "DeviceName": "string", "DeviceSecretVerifierConfig": { "PasswordVerifier": "string", "Salt": "string" } }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AccessToken
-
The access token.
Type: String
Pattern:
[A-Za-z0-9-_=.]+Required: Yes
- DeviceKey
-
The device key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-f-]+Required: Yes
- DeviceName
-
The device name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- DeviceSecretVerifierConfig
-
The configuration of the device secret verifier.
Type: DeviceSecretVerifierConfigType object
Required: No
Response Syntax
{ "UserConfirmationNecessary": boolean }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- UserConfirmationNecessary
-
Indicates whether the user confirmation is necessary to confirm the device response.
Type: Boolean
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidLambdaResponseException
-
This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
HTTP Status Code: 400
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- InvalidPasswordException
-
This exception is thrown when the Amazon Cognito service encounters an invalid password.
HTTP Status Code: 400
- InvalidUserPoolConfigurationException
-
This exception is thrown when the user pool configuration is invalid.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user is not authorized.
HTTP Status Code: 400
- PasswordResetRequiredException
-
This exception is thrown when a password reset is required.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service cannot find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
- UsernameExistsException
-
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
HTTP Status Code: 400
- UserNotConfirmedException
-
This exception is thrown when a user is not confirmed successfully.
HTTP Status Code: 400
- UserNotFoundException
-
This exception is thrown when a user is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
