GetDeviceFleetReport
Describes a fleet.
Request Syntax
{
"DeviceFleetName": "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.
- 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
Response Syntax
{
"AgentVersions": [
{
"AgentCount": number,
"Version": "string"
}
],
"Description": "string",
"DeviceFleetArn": "string",
"DeviceFleetName": "string",
"DeviceStats": {
"ConnectedDeviceCount": number,
"RegisteredDeviceCount": number
},
"ModelStats": [
{
"ActiveDeviceCount": number,
"ConnectedDeviceCount": number,
"ModelName": "string",
"ModelVersion": "string",
"OfflineDeviceCount": number,
"SamplingDeviceCount": number
}
],
"OutputConfig": {
"KmsKeyId": "string",
"PresetDeploymentConfig": "string",
"PresetDeploymentType": "string",
"S3OutputLocation": "string"
},
"ReportGenerated": number
}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.
- AgentVersions
-
The versions of Edge Manager agent deployed on the fleet.
Type: Array of AgentVersion objects
- Description
-
Description of the fleet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Pattern:
[-a-zA-Z0-9_.,;:! ]* - DeviceFleetArn
-
The Amazon Resource Name (ARN) of the device.
Type: String
Pattern:
arn:aws[a-z\-]*:iam::\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\-_/]+ - 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} - DeviceStats
-
Status of devices.
Type: DeviceStats object
- ModelStats
-
Status of model on device.
Type: Array of EdgeModelStat objects
- OutputConfig
-
The output configuration for storing sample data collected by the fleet.
Type: EdgeOutputConfig object
- ReportGenerated
-
Timestamp of when the report was generated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Error Types.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
