SageMaker / Client / update_device_fleet

update_device_fleet#

SageMaker.Client.update_device_fleet(**kwargs)#

Updates a fleet of devices.

See also: AWS API Documentation

Request Syntax

response = client.update_device_fleet(
    DeviceFleetName='string',
    RoleArn='string',
    Description='string',
    OutputConfig={
        'S3OutputLocation': 'string',
        'KmsKeyId': 'string',
        'PresetDeploymentType': 'GreengrassV2Component',
        'PresetDeploymentConfig': 'string'
    },
    EnableIotRoleAlias=True|False
)
Parameters:

  • DeviceFleetName (string) –

    [REQUIRED]

    The name of the fleet.

  • RoleArn (string) – The Amazon Resource Name (ARN) of the device.

  • Description (string) – Description of the fleet.

  • OutputConfig (dict) –

    [REQUIRED]

    Output configuration for storing sample data collected by the fleet.

    • S3OutputLocation (string) – [REQUIRED]

      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.

  • EnableIotRoleAlias (boolean) –

    Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: “SageMakerEdge-{DeviceFleetName}”.

    For example, if your device fleet is called “demo-fleet”, the name of the role alias will be “SageMakerEdge-demo-fleet”.

Returns:

None

Exceptions

  • SageMaker.Client.exceptions.ResourceInUse