CognitoIdentityProvider / Client / admin_list_devices

admin_list_devices#

CognitoIdentityProvider.Client.admin_list_devices(**kwargs)#

Lists devices, as an administrator.

Note

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

Request Syntax

response = client.admin_list_devices(
    UserPoolId='string',
    Username='string',
    Limit=123,
    PaginationToken='string'
)

Parameters:

UserPoolId (string) –
[REQUIRED]

The user pool ID.
Username (string) –
[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.
Limit (integer) – The limit of the devices 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) –

Lists the device’s response, as an administrator.
- Devices (list) –
  
  The devices in the list of 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 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 device was last authenticated.
- 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.