SnowDeviceManagement / Client / list_devices

list_devices#

SnowDeviceManagement.Client.list_devices(**kwargs)#

Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.

Request Syntax

response = client.list_devices(
    jobId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

jobId (string) – The ID of the job used to order the device.
maxResults (integer) – The maximum number of devices to list per page.
nextToken (string) – A pagination token to continue to the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'devices': [
        {
            'associatedWithJob': 'string',
            'managedDeviceArn': 'string',
            'managedDeviceId': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- devices (list) –
  
  A list of device structures that contain information about the device.
  - (dict) –
    
    Identifying information about the device.
    - associatedWithJob (string) –
      
      The ID of the job used to order the device.
    - managedDeviceArn (string) –
      
      The Amazon Resource Name (ARN) of the device.
    - managedDeviceId (string) –
      
      The ID of the device.
    - tags (dict) –
      
      Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.
      - (string) –
        
        (string) –
- nextToken (string) –
  
  A pagination token to continue to the next page of devices.

Exceptions

SnowDeviceManagement.Client.exceptions.ThrottlingException
SnowDeviceManagement.Client.exceptions.InternalServerException
SnowDeviceManagement.Client.exceptions.ValidationException
SnowDeviceManagement.Client.exceptions.AccessDeniedException