DescribeDeviceFleet
A description of the fleet the device belongs to.
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
{
"CreationTime": number,
"Description": "string",
"DeviceFleetArn": "string",
"DeviceFleetName": "string",
"IotRoleAlias": "string",
"LastModifiedTime": number,
"OutputConfig": {
"KmsKeyId": "string",
"PresetDeploymentConfig": "string",
"PresetDeploymentType": "string",
"S3OutputLocation": "string"
},
"RoleArn": "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.
- CreationTime
-
Timestamp of when the device fleet was created.
Type: Timestamp
- Description
-
A description of the fleet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Pattern:
^[-a-zA-Z0-9_.,;:! ]*$ - DeviceFleetArn
-
The The Amazon Resource Name (ARN) of the fleet.
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}$ - IotRoleAlias
-
The Amazon Resource Name (ARN) alias created in Amazon Internet of Things (IoT).
Type: String
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\-_/]+$ - LastModifiedTime
-
Timestamp of when the device fleet was last updated.
Type: Timestamp
- OutputConfig
-
The output configuration for storing sampled data.
Type: EdgeOutputConfig object
- RoleArn
-
The Amazon Resource Name (ARN) that has access to Amazon Internet of Things (IoT).
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+=,.@\-_/]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: