AWS API Changes

2021/11/04 - Amazon SageMaker Service - 2 updated api methods

Changes ListDevices and DescribeDevice now show Edge Manager agent version.

DescribeDevice (updated)

Link ¶
Changes (response)

{'AgentVersion': 'string'}

Describes the device.

See also: AWS API Documentation

Request Syntax

client.describe_device(
    NextToken='string',
    DeviceName='string',
    DeviceFleetName='string'
)

type NextToken

string

param NextToken

Next token of device description.

type DeviceName

string

param DeviceName

[REQUIRED]

The unique ID of the device.

type DeviceFleetName

string

param DeviceFleetName

[REQUIRED]

The name of the fleet the devices belong to.

rtype

dict

returns

Response Syntax

{
    'DeviceArn': 'string',
    'DeviceName': 'string',
    'Description': 'string',
    'DeviceFleetName': 'string',
    'IotThingName': 'string',
    'RegistrationTime': datetime(2015, 1, 1),
    'LatestHeartbeat': datetime(2015, 1, 1),
    'Models': [
        {
            'ModelName': 'string',
            'ModelVersion': 'string',
            'LatestSampleTime': datetime(2015, 1, 1),
            'LatestInference': datetime(2015, 1, 1)
        },
    ],
    'MaxModels': 123,
    'NextToken': 'string',
    'AgentVersion': 'string'
}

Response Structure

(dict) --
- DeviceArn (string) --
  
  The Amazon Resource Name (ARN) of the device.
- DeviceName (string) --
  
  The unique identifier of the device.
- Description (string) --
  
  A description of the device.
- DeviceFleetName (string) --
  
  The name of the fleet the device belongs to.
- IotThingName (string) --
  
  The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.
- RegistrationTime (datetime) --
  
  The timestamp of the last registration or de-reregistration.
- LatestHeartbeat (datetime) --
  
  The last heartbeat received from the device.
- Models (list) --
  
  Models on the device.
  - (dict) --
    
    The model on the edge device.
    - ModelName (string) --
      
      The name of the model.
    - ModelVersion (string) --
      
      The model version.
    - LatestSampleTime (datetime) --
      
      The timestamp of the last data sample taken.
    - LatestInference (datetime) --
      
      The timestamp of the last inference that was made.
- MaxModels (integer) --
  
  The maximum number of models.
- NextToken (string) --
  
  The response from the last list when returning a list large enough to need tokening.
- AgentVersion (string) --
  
  Edge Manager agent version.

ListDevices (updated)

Link ¶
Changes (response)

{'DeviceSummaries': {'AgentVersion': 'string'}}

A list of devices.

See also: AWS API Documentation

Request Syntax

client.list_devices(
    NextToken='string',
    MaxResults=123,
    LatestHeartbeatAfter=datetime(2015, 1, 1),
    ModelName='string',
    DeviceFleetName='string'
)

type NextToken

string

param NextToken

The response from the last list when returning a list large enough to need tokening.

type MaxResults

integer

param MaxResults

Maximum number of results to select.

type LatestHeartbeatAfter

datetime

param LatestHeartbeatAfter

Select fleets where the job was updated after X

type ModelName

string

param ModelName

A filter that searches devices that contains this name in any of their models.

type DeviceFleetName

string

param DeviceFleetName

Filter for fleets containing this name in their device fleet name.

rtype

dict

returns

Response Syntax

{
    'DeviceSummaries': [
        {
            'DeviceName': 'string',
            'DeviceArn': 'string',
            'Description': 'string',
            'DeviceFleetName': 'string',
            'IotThingName': 'string',
            'RegistrationTime': datetime(2015, 1, 1),
            'LatestHeartbeat': datetime(2015, 1, 1),
            'Models': [
                {
                    'ModelName': 'string',
                    'ModelVersion': 'string'
                },
            ],
            'AgentVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- DeviceSummaries (list) --
  
  Summary of devices.
  - (dict) --
    
    Summary of the device.
    - DeviceName (string) --
      
      The unique identifier of the device.
    - DeviceArn (string) --
      
      Amazon Resource Name (ARN) of the device.
    - Description (string) --
      
      A description of the device.
    - DeviceFleetName (string) --
      
      The name of the fleet the device belongs to.
    - IotThingName (string) --
      
      The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..
    - RegistrationTime (datetime) --
      
      The timestamp of the last registration or de-reregistration.
    - LatestHeartbeat (datetime) --
      
      The last heartbeat received from the device.
    - Models (list) --
      
      Models on the device.
      - (dict) --
        
        Summary of model on edge device.
        
        ModelName (string) --
        
        The name of the model.
        
        ModelVersion (string) --
        
        The version model.
    - AgentVersion (string) --
      
      Edge Manager agent version.
- NextToken (string) --
  
  The response from the last list when returning a list large enough to need tokening.