GetGroupVersion - Amazon IoT Greengrass
CLI: Parameters: Responses:
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 (PDF).

Amazon IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the Amazon IoT Greengrass V1 maintenance policy. After this date, Amazon IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on Amazon 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 Amazon IoT Greengrass Version 2, which adds significant new features and support for additional platforms.

GetGroupVersion

Retrieves information about a group version.

URI: GET /greengrass/groups/GroupId/versions/GroupVersionId

Produces: application/json

CLI:

aws greengrass get-group-version \
  --group-id <value> \
  --group-version-id <value>  \
  [--cli-input-json <value>] \
  [--generate-cli-skeleton]

cli-input-json format:

{
"GroupId": "string",
"GroupVersionId": "string"
}

Parameters:

GroupId

The ID of the Greengrass group.

where used: path; required: true

type: string

GroupVersionId

The ID of the group version. This value maps to the Version property of the corresponding VersionInformation object, which is returned by ListGroupVersions requests. If the version is the last one that was associated with a group, the value also maps to the LatestVersion property of the corresponding GroupInformation object.

where used: path; required: true

type: string

Responses:

200

Success.

GetGroupVersionResponse 

{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string",
"Definition": {
  "CoreDefinitionVersionArn": "string",
  "DeviceDefinitionVersionArn": "string",
  "FunctionDefinitionVersionArn": "string",
  "SubscriptionDefinitionVersionArn": "string",
  "LoggerDefinitionVersionArn": "string",
  "ResourceDefinitionVersionArn": "string",
  "ConnectorDefinitionVersionArn": "string"
}
}
GetGroupVersionResponse

Information about a group version.

type: object

Arn

The ARN of the group version.

type: string

Id

The ID of the group that the version is associated with.

type: string

Version

The ID of the group version.

type: string

CreationTimestamp

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

type: string

Definition

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

400

Invalid request.

GeneralError 

{
"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