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/GroupId/versions
POST
POST /greengrass/groups/GroupId/versions
Operation ID: CreateGroupVersion
Creates a version of a group that has already been defined.
Produces: application/json
Body Parameters
- CreateGroupVersionRequestBody
-
where used: body; required: true
{ "CoreDefinitionVersionArn": "string", "DeviceDefinitionVersionArn": "string", "FunctionDefinitionVersionArn": "string", "SubscriptionDefinitionVersionArn": "string", "LoggerDefinitionVersionArn": "string", "ResourceDefinitionVersionArn": "string", "ConnectorDefinitionVersionArn": "string" }- GroupVersion
-
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
Header Parameters
- X-Amzn-Client-Token
-
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
- GroupId
-
The ID of the Greengrass group.
where used: path; required: true
type: string
CLI
aws greengrass create-group-version \ --group-id <value> \ [--core-definition-version-arn <value>] \ [--device-definition-version-arn <value>] \ [--function-definition-version-arn <value>] \ [--subscription-definition-version-arn <value>] \ [--logger-definition-version-arn <value>] \ [--resource-definition-version-arn <value>] \ [--connector-definition-version-arn <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"GroupId": "string",
"CoreDefinitionVersionArn": "string",
"DeviceDefinitionVersionArn": "string",
"FunctionDefinitionVersionArn": "string",
"SubscriptionDefinitionVersionArn": "string",
"LoggerDefinitionVersionArn": "string",
"ResourceDefinitionVersionArn": "string",
"ConnectorDefinitionVersionArn": "string",
"AmznClientToken": "string"
}Responses
- 200 (CreateGroupVersionResponse)
-
Success. The response contains information about the group version.
{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" }- VersionInformation
-
Information about a version.
type: object
- Arn
-
The ARN of the version.
type: string
- Id
-
The ID of the parent definition that the version is associated with.
type: string
- Version
-
The ID of the version.
type: string
- CreationTimestamp
-
The time, in milliseconds since the epoch, when the version was created.
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
GET
GET /greengrass/groups/GroupId/versions
Operation ID: ListGroupVersions
Lists the versions of a group.
Produces: application/json
Path Parameters
- GroupId
-
The ID of the Greengrass group.
where used: path; required: true
type: string
Query Parameters
- NextToken
-
The token for the next set of results, or
nullif there are no more results.where used: query; required: false
type: string
- MaxResults
-
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
CLI
aws greengrass list-group-versions \ --group-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"GroupId": "string",
"NextToken": "string",
"MaxResults": "integer"
}Responses
- 200 (ListGroupVersionsResponse)
-
Success. The response contains the list of versions and metadata for the given group.
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string" }- ListVersionsResponse
-
A list of versions.
type: object
- Versions
-
Information about a version.
type: array
items: VersionInformation
- VersionInformation
-
Information about a version.
type: object
- Arn
-
The ARN of the version.
type: string
- Id
-
The ID of the parent definition that the version is associated with.
type: string
- Version
-
The ID of the version.
type: string
- CreationTimestamp
-
The time, in milliseconds since the epoch, when the version was created.
type: string
- NextToken
-
The token for the next set of results, or
nullif there are no more results.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
