Describe a thing group.
Requires permission to access the DescribeThingGroup action.
Request SyntaxGET /thing-groups/thingGroupName
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
The name of the thing group.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [a-zA-Z0-9:_-]+
Required: Yes
The request does not have a request body.
Response SyntaxHTTP/1.1 200
Content-type: application/json
{
"indexName": "string",
"queryString": "string",
"queryVersion": "string",
"status": "string",
"thingGroupArn": "string",
"thingGroupId": "string",
"thingGroupMetadata": {
"creationDate": number,
"parentGroupName": "string",
"rootToParentThingGroups": [
{
"groupArn": "string",
"groupName": "string"
}
]
},
"thingGroupName": "string",
"thingGroupProperties": {
"attributePayload": {
"attributes": {
"string" : "string"
},
"merge": boolean
},
"thingGroupDescription": "string"
},
"version": 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.
The dynamic thing group index name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [a-zA-Z0-9:_-]+
The dynamic thing group search query string.
Type: String
Length Constraints: Minimum length of 1.
The dynamic thing group query version.
Type: String
The dynamic thing group status.
Type: String
Valid Values: ACTIVE | BUILDING | REBUILDING
The thing group ARN.
Type: String
The thing group ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [a-zA-Z0-9\-]+
Thing group metadata.
Type: ThingGroupMetadata object
The name of the thing group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [a-zA-Z0-9:_-]+
The thing group properties.
Type: ThingGroupProperties object
The version of the thing group.
Type: Long
An unexpected error has occurred.
HTTP Status Code: 500
The request is not valid.
HTTP Status Code: 400
The specified resource does not exist.
HTTP Status Code: 404
The rate exceeds the limit.
HTTP Status Code: 400
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4