CognitoIdentityProvider / Client / list_devices

list_devices#

CognitoIdentityProvider.Client.list_devices(**kwargs)#

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.

Note

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.

Request Syntax

response = client.list_devices(
    AccessToken='string',
    Limit=123,
    PaginationToken='string'
)

Parameters:

AccessToken (string) –
[REQUIRED]

A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
Limit (integer) – The limit of the device request.
PaginationToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Devices': [
        {
            'DeviceKey': 'string',
            'DeviceAttributes': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'DeviceCreateDate': datetime(2015, 1, 1),
            'DeviceLastModifiedDate': datetime(2015, 1, 1),
            'DeviceLastAuthenticatedDate': datetime(2015, 1, 1)
        },
    ],
    'PaginationToken': 'string'
}

Response Structure

(dict) –

Represents the response to list devices.
- Devices (list) –
  
  The devices returned in the list devices response.
  - (dict) –
    
    Information about a user’s device that they’ve registered for device SRP authentication in your application. For more information, see Working with user devices in your user pool.
    
    The data type is a response parameter of AdminGetDevice, AdminListDevices, and GetDevice.
    - DeviceKey (string) –
      
      The device key, for example us-west-2_EXAMPLE-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
    - DeviceAttributes (list) –
      
      Metadata about a user’s device, like name and last-access source IP.
      - (dict) –
        
        The name and value of a user attribute.
        
        This data type is a request parameter of AdminUpdateUserAttributes and UpdateUserAttributes.
        
        Name (string) –
        
        The name of the attribute.
        
        Value (string) –
        
        The value of the attribute.
    - DeviceCreateDate (datetime) –
      
      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    - DeviceLastModifiedDate (datetime) –
      
      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    - DeviceLastAuthenticatedDate (datetime) –
      
      The date when the user last signed in with the device.
- PaginationToken (string) –
  
  The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

Exceptions

CognitoIdentityProvider.Client.exceptions.InvalidParameterException
CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
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