Skip to content

Admin Get Device

cognitoidentityprovider_admin_get_device R Documentation

Given the device key, returns details for a user' device

Description

Given the device key, returns details for a user' device. For more information, see Working with devices.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Usage

cognitoidentityprovider_admin_get_device(DeviceKey, UserPoolId,
  Username)

Arguments

DeviceKey

[required] The key of the device that you want to delete. You can get device IDs in the response to an admin_list_devices request.

UserPoolId

[required] The ID of the user pool where the device owner is a user.

Username

[required] The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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$admin_get_device(
  DeviceKey = "string",
  UserPoolId = "string",
  Username = "string"
)