GreengrassV2 / Client / list_client_devices_associated_with_core_device

list_client_devices_associated_with_core_device#

GreengrassV2.Client.list_client_devices_associated_with_core_device(**kwargs)#

Retrieves a paginated list of client devices that are associated with a core device.

Request Syntax

response = client.list_client_devices_associated_with_core_device(
    coreDeviceThingName='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

coreDeviceThingName (string) –
[REQUIRED]

The name of the core device. This is also the name of the IoT thing.
maxResults (integer) – The maximum number of results to be returned per paginated request.
nextToken (string) – The token to be used for the next set of paginated results.

Return type:

dict

Returns:

Response Syntax

{
    'associatedClientDevices': [
        {
            'thingName': 'string',
            'associationTimestamp': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- associatedClientDevices (list) –
  
  A list that describes the client devices that are associated with the core device.
  - (dict) –
    
    Contains information about a client device that is associated to a core device for cloud discovery.
    - thingName (string) –
      
      The name of the IoT thing that represents the associated client device.
    - associationTimestamp (datetime) –
      
      The time that the client device was associated, expressed in ISO 8601 format.
- nextToken (string) –
  
  The token for the next set of results, or null if there are no additional results.

Exceptions

GreengrassV2.Client.exceptions.ValidationException
GreengrassV2.Client.exceptions.ResourceNotFoundException
GreengrassV2.Client.exceptions.AccessDeniedException
GreengrassV2.Client.exceptions.InternalServerException
GreengrassV2.Client.exceptions.ThrottlingException