SageMaker / Client / describe_device_fleet

describe_device_fleet#

SageMaker.Client.describe_device_fleet(**kwargs)#

A description of the fleet the device belongs to.

See also: AWS API Documentation

Request Syntax

response = client.describe_device_fleet(
    DeviceFleetName='string'
)
Parameters:

DeviceFleetName (string) –

[REQUIRED]

The name of the fleet.

Return type:

dict

Returns:

Response Syntax

{
    'DeviceFleetName': 'string',
    'DeviceFleetArn': 'string',
    'OutputConfig': {
        'S3OutputLocation': 'string',
        'KmsKeyId': 'string',
        'PresetDeploymentType': 'GreengrassV2Component',
        'PresetDeploymentConfig': 'string'
    },
    'Description': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'RoleArn': 'string',
    'IotRoleAlias': 'string'
}

Response Structure

  • (dict) –

    • DeviceFleetName (string) –

      The name of the fleet.

    • DeviceFleetArn (string) –

      The The Amazon Resource Name (ARN) of the fleet.

    • OutputConfig (dict) –

      The output configuration for storing sampled data.

      • 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) –

      A description of the fleet.

    • CreationTime (datetime) –

      Timestamp of when the device fleet was created.

    • LastModifiedTime (datetime) –

      Timestamp of when the device fleet was last updated.

    • RoleArn (string) –

      The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

    • IotRoleAlias (string) –

      The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound