UpdateDeviceFleet - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

UpdateDeviceFleet

Updates a fleet of devices.

Request Syntax

{ "Description": "string", "DeviceFleetName": "string", "EnableIotRoleAlias": boolean, "OutputConfig": { "KmsKeyId": "string", "PresetDeploymentConfig": "string", "PresetDeploymentType": "string", "S3OutputLocation": "string" }, "RoleArn": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Description

Description of the fleet.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 800.

Pattern: [\S\s]+

Required: No

DeviceFleetName

The name of the fleet.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: Yes

EnableIotRoleAlias

Whether to create an Amazon 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".

Type: Boolean

Required: No

OutputConfig

Output configuration for storing sample data collected by the fleet.

Type: EdgeOutputConfig object

Required: Yes

RoleArn

The Amazon Resource Name (ARN) of the device.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceInUse

Resource being accessed is in use.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: