Get Device

cognitoidentityprovider_get_device

R Documentation

Given a device key, returns information about a remembered device for the current user¶

Description¶

Given a device key, returns information about a remembered device for the current user. For more information about device authentication, see Working with user devices in your user pool.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Usage¶

cognitoidentityprovider_get_device(DeviceKey, AccessToken)

Arguments¶

DeviceKey

[required] The key of the device that you want to get information about.

AccessToken

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Value¶

A list with the following syntax:

list(
  Device = list(
    DeviceKey = "string",
    DeviceAttributes = list(
      list(
        Name = "string",
        Value = "string"
      )
    ),
    DeviceCreateDate = as.POSIXct(
      "2015-01-01"
    ),
    DeviceLastModifiedDate = as.POSIXct(
      "2015-01-01"
    ),
    DeviceLastAuthenticatedDate = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

svc$get_device(
  DeviceKey = "string",
  AccessToken = "string"
)