AWS IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. After this date, AWS IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on AWS IoT Greengrass V1 won't be disrupted and will continue to operate and to connect to the cloud. We strongly recommend that you migrate to AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
/greengrass/groups
GET
GET /greengrass/groups
Operation ID: ListGroups
Retrieves a list of groups.
Produces: application/json
Query 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
nullif there are no more results.where used: query; required: false
type: string
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"
}Responses
- 200 (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
nullif there are no more results.type: string
POST
POST /greengrass/groups
Operation ID: CreateGroup
Creates a group. You can provide the initial version of the group or use
CreateGroupVersion later. Tip: You can use the gg_group_setup
package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or
command-line application to create and deploy Greengrass groups.
Produces: application/json
Body Parameters
- CreateGroupRequestBody
-
where used: body; required: true
{ "Name": "string", "InitialVersion": { "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string", "ConnectorDefinitionVersionArn": "string" }, "tags": { "keyName0": "string", "keyName1": "string", "keyName2": "string" } }- Name
-
The name of the group.
type: string
- InitialVersion
-
Information about a group version.
type: object
- CoreDefinitionVersionArn
-
The ARN of the core definition version for this group.
type: string
- DeviceDefinitionVersionArn
-
The ARN of the client device definition version for this group.
type: string
- FunctionDefinitionVersionArn
-
The ARN of the function definition version for this group.
type: string
- SubscriptionDefinitionVersionArn
-
The ARN of the subscription definition version for this group.
type: string
- LoggerDefinitionVersionArn
-
The ARN of the logger definition version for this group.
type: string
- ResourceDefinitionVersionArn
-
The ARN of the resource definition version for this group.
type: string
- ConnectorDefinitionVersionArn
-
The ARN of the connector definition version for this group.
type: string
- tags
-
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
Header Parameters
- X-Amzn-Client-Token
-
A client token used to correlate requests and responses.
where used: header; required: false
type: string
CLI
aws greengrass create-group \ --name <value> \ [--initial-version <value>] \ [--tags <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"Name": "string",
"InitialVersion": {
"CoreDefinitionVersionArn": "string",
"DeviceDefinitionVersionArn": "string",
"FunctionDefinitionVersionArn": "string",
"SubscriptionDefinitionVersionArn": "string",
"LoggerDefinitionVersionArn": "string",
"ResourceDefinitionVersionArn": "string",
"ConnectorDefinitionVersionArn": "string"
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"AmznClientToken": "string"
}Responses
- 200 (CreateGroupResponse)
-
Success. The group was created.
{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" }- DefinitionInformation
-
Information about a definition.
type: object
- Name
-
The name of the definition.
type: string
- Id
-
The ID of the definition.
type: string
- Arn
-
The ARN of the definition.
type: string
- LastUpdatedTimestamp
-
The time, in milliseconds since the epoch, when the definition was last updated.
type: string
- CreationTimestamp
-
The time, in milliseconds since the epoch, when the definition was created.
type: string
- LatestVersion
-
The ID of the latest version associated with the definition.
type: string
- LatestVersionArn
-
The ARN of the latest version associated with the definition.
type: string
- 400
-
Invalid request.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains information about the error.
type: string
- ErrorDetails
-
A list of error details.
type: array
items: ErrorDetail
- ErrorDetail
-
Details about the error.
type: object
- DetailedErrorCode
-
A detailed error code.
type: string
- DetailedErrorMessage
-
A detailed error message.
type: string
