List Devices

cognitoidentityprovider_list_devices

R Documentation

Lists the sign-in devices that Amazon Cognito has registered to the current user

Description

Lists the sign-in devices that Amazon Cognito has registered to 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_list_devices(AccessToken, Limit,
  PaginationToken)

Arguments

AccessToken

[required] A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.

Limit

The limit of the device request.

PaginationToken

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Value

A list with the following syntax:

list(
  Devices = list(
    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"
      )
    )
  ),
  PaginationToken = "string"
)

Request syntax

svc$list_devices(
  AccessToken = "string",
  Limit = 123,
  PaginationToken = "string"
)