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.

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) – The pagination token for the list request.

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) –
    
    The device type.
    - DeviceKey (string) –
      
      The device key.
    - DeviceAttributes (list) –
      
      The device attributes.
      - (dict) –
        
        Specifies whether the attribute is standard or custom.
        
        Name (string) –
        
        The name of the attribute.
        
        Value (string) –
        
        The value of the attribute.
    - DeviceCreateDate (datetime) –
      
      The creation date of the device.
    - DeviceLastModifiedDate (datetime) –
      
      The last modified date of the device.
    - DeviceLastAuthenticatedDate (datetime) –
      
      The date when the device was last authenticated.
- PaginationToken (string) –
  
  The pagination token for the list device response.

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