group_versions

Creates, updates, deletes, gets or lists a group_versions resource.

Overview

Name	group_versions
Type	Resource
Id	aws.greengrass.group_versions

Fields

The following fields are returned by SELECT queries:

get_group_version

Name	Datatype	Description
arn	string	The ARN of the group version.
creation_timestamp	string	The time, in milliseconds since the epoch, when the group version was created.
definition	object	Information about a group version.
id	string	The ID of the group that the version is associated with.
version	string	The ID of the group version.

list_group_versions

Name	Datatype	Description
arn	string	The ARN of the version.
creation_timestamp	string	The time, in milliseconds since the epoch, when the version was created.
id	string	The ID of the parent definition that the version is associated with.
version	string	The ID of the version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_group_version	select	group_id, group_version_id, region		Retrieves information about a group version.
list_group_versions	select	group_id, region	MaxResults, NextToken	Lists the versions of a group.
create_group_version	insert	group_id, region	X-Amzn-Client-Token	Creates a version of a group which has already been defined.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
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.
region	string	AWS region (default: us-east-1)
MaxResults	string	The maximum number of results to be returned per request.
NextToken	string	The token for the next set of results, or ''null'' if there are no additional results.
X-Amzn-Client-Token	string	A client token used to correlate requests and responses.

SELECT examples

get_group_version

Retrieves information about a group version.

SELECT
arn,
creation_timestamp,
definition,
id,
version
FROM aws.greengrass.group_versions
WHERE group_id = '{{ group_id }}' -- required
AND group_version_id = '{{ group_version_id }}' -- required
AND region = '{{ region }}' -- required
;

list_group_versions

Lists the versions of a group.

SELECT
arn,
creation_timestamp,
id,
version
FROM aws.greengrass.group_versions
WHERE group_id = '{{ group_id }}' -- required
AND region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_group_version

Creates a version of a group which has already been defined.

INSERT INTO aws.greengrass.group_versions (
ConnectorDefinitionVersionArn,
CoreDefinitionVersionArn,
DeviceDefinitionVersionArn,
FunctionDefinitionVersionArn,
LoggerDefinitionVersionArn,
ResourceDefinitionVersionArn,
SubscriptionDefinitionVersionArn,
group_id,
region,
`X-Amzn-Client-Token`
)
SELECT 
'{{ ConnectorDefinitionVersionArn }}',
'{{ CoreDefinitionVersionArn }}',
'{{ DeviceDefinitionVersionArn }}',
'{{ FunctionDefinitionVersionArn }}',
'{{ LoggerDefinitionVersionArn }}',
'{{ ResourceDefinitionVersionArn }}',
'{{ SubscriptionDefinitionVersionArn }}',
'{{ group_id }}',
'{{ region }}',
'{{ X-Amzn-Client-Token }}'
RETURNING
arn,
creation_timestamp,
id,
version
;

Manifest

# Description fields are for documentation purposes
- name: group_versions
props:
  - name: group_id
    value: "{{ group_id }}"
    description: Required parameter for the group_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the group_versions resource.
  - name: ConnectorDefinitionVersionArn
    value: "{{ ConnectorDefinitionVersionArn }}"
  - name: CoreDefinitionVersionArn
    value: "{{ CoreDefinitionVersionArn }}"
  - name: DeviceDefinitionVersionArn
    value: "{{ DeviceDefinitionVersionArn }}"
  - name: FunctionDefinitionVersionArn
    value: "{{ FunctionDefinitionVersionArn }}"
  - name: LoggerDefinitionVersionArn
    value: "{{ LoggerDefinitionVersionArn }}"
  - name: ResourceDefinitionVersionArn
    value: "{{ ResourceDefinitionVersionArn }}"
  - name: SubscriptionDefinitionVersionArn
    value: "{{ SubscriptionDefinitionVersionArn }}"
  - name: X-Amzn-Client-Token
    value: "{{ X-Amzn-Client-Token }}"
    description: A client token used to correlate requests and responses.
    description: A client token used to correlate requests and responses.