get_device_fleet_report

get_device_fleet_report(**kwargs)

Describes a fleet.

See also: AWS API Documentation

Request Syntax

response = client.get_device_fleet_report(
    DeviceFleetName='string'
)

Parameters

DeviceFleetName (string) --

[REQUIRED]

The name of the fleet.

Return type

dict

Returns

Response Syntax

{
    'DeviceFleetArn': 'string',
    'DeviceFleetName': 'string',
    'OutputConfig': {
        'S3OutputLocation': 'string',
        'KmsKeyId': 'string',
        'PresetDeploymentType': 'GreengrassV2Component',
        'PresetDeploymentConfig': 'string'
    },
    'Description': 'string',
    'ReportGenerated': datetime(2015, 1, 1),
    'DeviceStats': {
        'ConnectedDeviceCount': 123,
        'RegisteredDeviceCount': 123
    },
    'AgentVersions': [
        {
            'Version': 'string',
            'AgentCount': 123
        },
    ],
    'ModelStats': [
        {
            'ModelName': 'string',
            'ModelVersion': 'string',
            'OfflineDeviceCount': 123,
            'ConnectedDeviceCount': 123,
            'ActiveDeviceCount': 123,
            'SamplingDeviceCount': 123
        },
    ]
}

Response Structure

• (dict) --
  • DeviceFleetArn (string) --

    The Amazon Resource Name (ARN) of the device.

  • DeviceFleetName (string) --

    The name of the fleet.

  • OutputConfig (dict) --

    The output configuration for storing sample data collected by the fleet.

    • S3OutputLocation (string) --

      The Amazon Simple Storage (S3) bucker URI.

    • KmsKeyId (string) --

      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

    • PresetDeploymentType (string) --

      The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

    • PresetDeploymentConfig (string) --

      The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

      • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.
      • ComponentDescription (optional) - Description of the component.
      • ComponentVersion (optional) - The version of the component.

      Note

      Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a*major.minor.patch* number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

      • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.
      • PlatformArchitecture (optional) - The processor architecture for the platform. Supported architectures Windows include: Windows32_x86, Windows64_x64. Supported architectures for Linux include: Linux x86_64, Linux ARMV8.
  • Description (string) --

    Description of the fleet.

  • ReportGenerated (datetime) --

    Timestamp of when the report was generated.

  • DeviceStats (dict) --

    Status of devices.

    • ConnectedDeviceCount (integer) --

      The number of devices connected with a heartbeat.

    • RegisteredDeviceCount (integer) --

      The number of registered devices.

  • AgentVersions (list) --

    The versions of Edge Manager agent deployed on the fleet.

    • (dict) --

      Edge Manager agent version.

      • Version (string) --

        Version of the agent.

      • AgentCount (integer) --

        The number of Edge Manager agents.

  • ModelStats (list) --

    Status of model on device.

    • (dict) --

      Status of edge devices with this model.

      • ModelName (string) --

        The name of the model.

      • ModelVersion (string) --

        The model version.

      • OfflineDeviceCount (integer) --

        The number of devices that have this model version and do not have a heart beat.

      • ConnectedDeviceCount (integer) --

        The number of devices that have this model version and have a heart beat.

      • ActiveDeviceCount (integer) --

        The number of devices that have this model version, a heart beat, and are currently running.

      • SamplingDeviceCount (integer) --

        The number of devices with this model version and are producing sample data.