[ aws . sagemaker ]

describe-device-fleet

Description

A description of the fleet the device belongs to.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-device-fleet
--device-fleet-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--device-fleet-name (string)

The name of the fleet.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

DeviceFleetName -> (string)

The name of the fleet.

DeviceFleetArn -> (string)

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

OutputConfig -> (structure)

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 -> (timestamp)

Timestamp of when the device fleet was created.

LastModifiedTime -> (timestamp)

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).