GetConnectorDefinitionVersion - AWS Greengrass

GetConnectorDefinitionVersion

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.

URI: GET /greengrass/definition/connectors/ConnectorDefinitionId/versions/ConnectorDefinitionVersionId

Produces: application/json

CLI:

aws greengrass get-connector-definition-version \ --connector-definition-id <value> \ --connector-definition-version-id <value> \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "ConnectorDefinitionId": "string", "ConnectorDefinitionVersionId": "string", "NextToken": "string" }

Parameters:

ConnectorDefinitionId

The ID of the connector definition.

where used: path; required: true

type: string

ConnectorDefinitionVersionId

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.

where used: path; required: true

type: string

NextToken

The token for the next set of results, or null if there are no more results.

where used: query; required: false

type: string

Responses:

200 (GetConnectorDefinitionVersionResponse)

GetConnectorDefinitionVersionResponse

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Connectors": [ { "Id": "string", "ConnectorArn": "string", "Parameters": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" } } ] }, "NextToken": "string" }
GetConnectorDefinitionVersionResponse

Information about a connector definition version.

type: object

Arn

The ARN of the connector definition version.

type: string

Id

The ID of the connector definition version.

type: string

Version

The version of the connector definition version.

type: string

CreationTimestamp

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

type: string

Definition

Information about the connector definition version, which is a container for connectors.

type: object

Connectors

A list of references to connectors in this version, with their corresponding configuration settings.

type: array

items: Connector

Connector

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.

type: object

required: ["Id", "ConnectorArn"]

Id

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

type: string

ConnectorArn

The ARN of the connector.

type: string

Parameters

The parameters or configuration used by the connector.

type: object

additionalProperties: The key-value pair for the resource tag. Type: string

NextToken

The token for the next set of results, or null if there are no more results.

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