List thing groups

GET 
/organizations/:organizationId/thing-groups

List thing groups

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

thingTypeName string

The name of IoT type

maxResults string

Default value: 10

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data object[]required
Data of the thing groups.
Array [
groupArn stringrequired
groupName stringrequired
]
nextToken string

To retrieve the next set of results.

Example (from schema)

{
  "data": [
    {
      "groupArn": "string",
      "groupName": "string"
    }
  ],
  "nextToken": "string"
}

Example

{
  "data": [
    {
      "groupArn": "arn:aws:iot:ap-northeast-1:012345678901:thing/o-organizationId-a-24e124148b323456",
      "groupName": "o-organizationId-a-24e124148b323456"
    }
  ]
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...