[ aws . greengrass ]

get-group-version

Description

Retrieves information about a group version.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-group-version
--group-id <value>
--group-version-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--group-id (string) The ID of the Greengrass group.

--group-version-id (string) 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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve information about a version of a Greengrass group

The following get-group-version example retrieves information about the specified version of the specified group. To retrieve the IDs of all versions of the group, use the list-group-versions command. To retrieve the ID of the last version added to the group, use the get-group command and check the LatestVersion property.

aws greengrass get-group-version \
    --group-id "1013db12-8b58-45ff-acc7-704248f66731"  \
    --group-version-id "115136b3-cfd7-4462-b77f-8741a4b00e5e"

Output:

{
    "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e",
    "CreationTimestamp": "2019-06-18T17:04:30.915Z",
    "Definition": {
        "CoreDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46/versions/42aeeac3-fd9d-4312-a8fd-ffa9404a20e0",
        "FunctionDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b",
        "SubscriptionDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b"
    },
    "Id": "1013db12-8b58-45ff-acc7-704248f66731",
    "Version": "115136b3-cfd7-4462-b77f-8741a4b00e5e"
}

Output

Arn -> (string)

The ARN of the group version.

CreationTimestamp -> (string)

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

Definition -> (structure)

Information about the group version definition.

ConnectorDefinitionVersionArn -> (string)

The ARN of the connector definition version for this group.

CoreDefinitionVersionArn -> (string)

The ARN of the core definition version for this group.

DeviceDefinitionVersionArn -> (string)

The ARN of the device definition version for this group.

FunctionDefinitionVersionArn -> (string)

The ARN of the function definition version for this group.

LoggerDefinitionVersionArn -> (string)

The ARN of the logger definition version for this group.

ResourceDefinitionVersionArn -> (string)

The ARN of the resource definition version for this group.

SubscriptionDefinitionVersionArn -> (string)

The ARN of the subscription definition version for this group.

Id -> (string)

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

Version -> (string)

The ID of the group version.