/greengrass/definition/connectors/ConnectorDefinitionId/versions - Amazon IoT Greengrass
GETPOST
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Amazon IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the Amazon IoT Greengrass V1 maintenance policy. After this date, Amazon IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on Amazon IoT Greengrass V1 won't be disrupted and will continue to operate and to connect to the cloud. We strongly recommend that you migrate to Amazon IoT Greengrass Version 2, which adds significant new features and support for additional platforms.

/greengrass/definition/connectors/ConnectorDefinitionId/versions

GET

GET /greengrass/definition/connectors/ConnectorDefinitionId/versions

Operation ID: ListConnectorDefinitionVersions

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, Amazon, and other cloud services.

Produces: application/json

Path Parameters

ConnectorDefinitionId

The ID of the connector definition.

where used: path; required: true

type: string

Query Parameters

NextToken

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

where used: query; required: false

type: string

MaxResults

The maximum number of results to be returned per request.

where used: query; required: false

type: integer

CLI

aws greengrass list-connector-definition-versions \
  --connector-definition-id <value> \
  [--next-token <value>] \
  [--max-results <value>]  \
  [--cli-input-json <value>] \
  [--generate-cli-skeleton]

cli-input-json format:

{
"ConnectorDefinitionId": "string",
"NextToken": "string",
"MaxResults": "integer"
}

Responses

200 (ListConnectorDefinitionVersionsResponse)

ListVersionsResponse 

{
"Versions": [
  {
    "Arn": "string",
    "Id": "string",
    "Version": "string",
    "CreationTimestamp": "string"
  }
],
"NextToken": "string"
}
ListVersionsResponse

A list of versions.

type: object

Versions

Information about a version.

type: array

items: VersionInformation

VersionInformation

Information about a version.

type: object

Arn

The ARN of the version.

type: string

Id

The ID of the parent definition that the version is associated with.

type: string

Version

The ID of the version.

type: string

CreationTimestamp

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

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

POST

POST /greengrass/definition/connectors/ConnectorDefinitionId/versions

Operation ID: CreateConnectorDefinitionVersion

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

Produces: application/json

Body Parameters

CreateConnectorDefinitionVersionRequestBody

where used: body; required: true

{
"Connectors": [
  {
    "Id": "string",
    "ConnectorArn": "string",
    "Parameters": {
      "additionalProperty0": "string",
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  }
]
}
ConnectorDefinitionVersion

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, Amazon, 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: An object with properties of type string that represent the connector configuration.

Header Parameters

X-Amzn-Client-Token

A client token used to enforce the idempotency of this API.

where used: header; required: false

type: string

Path Parameters

ConnectorDefinitionId

The ID of the connector definition.

where used: path; required: true

type: string

CLI

aws greengrass create-connector-definition-version \
  --connector-definition-id <value> \
  [--connectors <value>] \
  [--amzn-client-token <value>]  \
  [--cli-input-json <value>] \
  [--generate-cli-skeleton]

cli-input-json format:

{
"ConnectorDefinitionId": "string",
"Connectors": [
  {
    "Id": "string",
    "ConnectorArn": "string",
    "Parameters": {
      "additionalProperty0": "string",
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  }
],
"AmznClientToken": "string"
}

Responses

200 (CreateConnectorDefinitionVersionResponse)

VersionInformation 

{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string"
}
VersionInformation

Information about a version.

type: object

Arn

The ARN of the version.

type: string

Id

The ID of the parent definition that the version is associated with.

type: string

Version

The ID of the version.

type: string

CreationTimestamp

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

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