connector_definition_versions

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

Overview

Name	connector_definition_versions
Type	Resource
Id	aws.greengrass.connector_definition_versions

Fields

The following fields are returned by SELECT queries:

get_connector_definition_version

Name	Datatype	Description
arn	string	The ARN of the connector definition version.
creation_timestamp	string	The time, in milliseconds since the epoch, when the connector definition version was created.
definition	object	Information about the connector definition version, which is a container for connectors.
id	string	The ID of the connector definition version.
next_token	string	The token for the next set of results, or ''null'' if there are no additional results.
version	string	The version of the connector definition version.

list_connector_definition_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_connector_definition_version	select	connector_definition_id, connector_definition_version_id, region	NextToken	Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.
list_connector_definition_versions	select	connector_definition_id, region	MaxResults, NextToken	Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.
create_connector_definition_version	insert	connector_definition_id, region	X-Amzn-Client-Token	Creates a version of a connector definition 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
connector_definition_id	string	The ID of the connector definition.
connector_definition_version_id	string	The ID of the connector definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListConnectorDefinitionVersions'' requests. If the version is the last one that was associated with a connector definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' 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_connector_definition_version

Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.

SELECT
arn,
creation_timestamp,
definition,
id,
next_token,
version
FROM aws.greengrass.connector_definition_versions
WHERE connector_definition_id = '{{ connector_definition_id }}' -- required
AND connector_definition_version_id = '{{ connector_definition_version_id }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
;

list_connector_definition_versions

Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.

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

INSERT examples

create_connector_definition_version

Creates a version of a connector definition which has already been defined.

INSERT INTO aws.greengrass.connector_definition_versions (
Connectors,
connector_definition_id,
region,
`X-Amzn-Client-Token`
)
SELECT 
'{{ Connectors }}',
'{{ connector_definition_id }}',
'{{ region }}',
'{{ X-Amzn-Client-Token }}'
RETURNING
arn,
creation_timestamp,
id,
version
;

Manifest

# Description fields are for documentation purposes
- name: connector_definition_versions
props:
  - name: connector_definition_id
    value: "{{ connector_definition_id }}"
    description: Required parameter for the connector_definition_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connector_definition_versions resource.
  - name: Connectors
    value:
      - ConnectorArn: "{{ ConnectorArn }}"
        Id: "{{ Id }}"
        Parameters: "{{ Parameters }}"
  - 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.