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

ListDeviceFleets

Returns a list of devices in the fleet.

Request Syntax

{ "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "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.

CreationTimeAfter

Filter fleets where packaging job was created after specified time.

Type: Timestamp

Required: No

CreationTimeBefore

Filter fleets where the edge packaging job was created before specified time.

Type: Timestamp

Required: No

LastModifiedTimeAfter

Select fleets where the job was updated after X

Type: Timestamp

Required: No

LastModifiedTimeBefore

Select fleets where the job was updated before X

Type: Timestamp

Required: No

MaxResults

The maximum number of results to select.

Type: Integer

Valid Range: Maximum value of 100.

Required: No

NameContains

Filter for fleets containing this name in their fleet device name.

Type: String

Length Constraints: Maximum length of 63.

Pattern: [a-zA-Z0-9\-]+

Required: No

NextToken

The response from the last list when returning a list large enough to need tokening.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The column to sort by.

Type: String

Valid Values: NAME | CREATION_TIME | LAST_MODIFIED_TIME

Required: No

SortOrder

What direction to sort in.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax

{ "DeviceFleetSummaries": [ { "CreationTime": number, "DeviceFleetArn": "string", "DeviceFleetName": "string", "LastModifiedTime": number } ], "NextToken": "string" }

Response Elements

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

The following data is returned in JSON format by the service.

DeviceFleetSummaries

Summary of the device fleet.

Type: Array of DeviceFleetSummary objects

NextToken

The response from the last list when returning a list large enough to need tokening.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

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

See Also

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