Greengrass / Client / get_connector_definition_version

get_connector_definition_version#

Greengrass.Client.get_connector_definition_version(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_connector_definition_version(
    ConnectorDefinitionId='string',
    ConnectorDefinitionVersionId='string',
    NextToken='string'
)
Parameters:

  • ConnectorDefinitionId (string) – [REQUIRED] The ID of the connector definition.

  • ConnectorDefinitionVersionId (string) – [REQUIRED] 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.

  • NextToken (string) – The token for the next set of results, or ‘’null’’ if there are no additional results.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Connectors': [
            {
                'ConnectorArn': 'string',
                'Id': 'string',
                'Parameters': {
                    'string': 'string'
                }
            },
        ]
    },
    'Id': 'string',
    'NextToken': 'string',
    'Version': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) – The ARN of the connector definition version.

    • CreationTimestamp (string) – The time, in milliseconds since the epoch, when the connector definition version was created.

    • Definition (dict) – Information about the connector definition version.

      • Connectors (list) – A list of references to connectors in this version, with their corresponding configuration settings.

        • (dict) – Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.

          • ConnectorArn (string) – The ARN of the connector.

          • Id (string) – A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.

          • Parameters (dict) – The parameters or configuration that the connector uses.

            • (string) –

              • (string) –

    • Id (string) – The ID of the connector definition version.

    • NextToken (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.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException