ListGroups - Amazon IoT Greengrass
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.

You are viewing the documentation for Amazon IoT Greengrass Version 1. Amazon IoT Greengrass Version 2 is the latest major version of Amazon IoT Greengrass. For more information about the Amazon IoT Greengrass V2 API, see the Amazon IoT Greengrass Version 2 API Reference.

ListGroups

Retrieves a list of groups.

URI: GET /greengrass/groups

Produces: application/json

CLI:

aws greengrass list-groups \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "MaxResults": "integer", "NextToken": "string" }

Parameters:

MaxResults

The maximum number of results to be returned per request.

where used: query; required: false

type: integer

NextToken

The token for the next set of results, or null if there are no more results.

where used: query; required: false

type: string

Responses:

200 (ListGroupsResponse)

ListGroupsResponse

{ "Groups": [ { "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string" }
ListGroupsResponse

type: object

Groups

Information about a group.

type: array

items: GroupInformation

GroupInformation

Information about a group.

type: object

Name

The name of the group.

type: string

Id

The ID of the group.

type: string

Arn

The ARN of the group.

type: string

LastUpdatedTimestamp

The time, in milliseconds since the epoch, when the group was last updated.

type: string

CreationTimestamp

The time, in milliseconds since the epoch, when the group was created.

type: string

LatestVersion

The ID of the latest version associated with the group.

type: string

LatestVersionArn

The ARN of the latest version associated with the group.

type: string

NextToken

The token for the next set of results, or null if there are no more results.

type: string