/greengrass/definition/connectors - Amazon IoT Greengrass
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.

Amazon IoT Greengrass Version 1 no longer receives feature updates, and will receive only security patches and bug fixes until June 30, 2023. For more information, see the Amazon IoT Greengrass V1 maintenance policy. 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

GET

GET /greengrass/definition/connectors

Operation ID: ListConnectorDefinitions

Retrieves a list of connector definitions.

Produces: application/json

Query Parameters

MaxResults

The maximum number of results to be returned per request.

where used: query; required: false

type: integer

NextToken

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

where used: query; required: false

type: string

CLI

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

cli-input-json format:

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

Responses

200 (ListConnectorDefinitionsResponse)

ListDefinitionsResponse

{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "tags": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string" }
ListDefinitionsResponse

A list of definitions.

type: object

Definitions

Information about a definition.

type: array

items: DefinitionInformation

DefinitionInformation

Information about a definition.

type: object

Name

The name of the definition.

type: string

Id

The ID of the definition.

type: string

Arn

The ARN of the definition.

type: string

tags

The resource tags.

type: object

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

LastUpdatedTimestamp

The time, in milliseconds since the epoch, when the definition was last updated.

type: string

CreationTimestamp

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

type: string

LatestVersion

The ID of the latest version associated with the definition.

type: string

LatestVersionArn

The ARN of the latest version associated with the definition.

type: string

NextToken

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

type: string

POST

POST /greengrass/definition/connectors

Operation ID: CreateConnectorDefinition

Creates a connector definition. You can provide the initial version of the connector definition now or use CreateConnectorDefinitionVersion later.

Produces: application/json

Body Parameters

CreateConnectorDefinitionRequestBody

where used: body; required: true

{ "Name": "string", "InitialVersion": { "Connectors": [ { "Id": "string", "ConnectorArn": "string", "Parameters": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" } } ] }, "tags": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" } }
Name

The name of the connector definition.

type: string

InitialVersion

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.

tags

The resource tags.

type: object

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

Header Parameters

X-Amzn-Client-Token

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

where used: header; required: false

type: string

CLI

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

cli-input-json format:

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

Responses

200 (CreateConnectorDefinitionResponse)

DefinitionInformation

{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" }
DefinitionInformation

Information about a definition.

type: object

Name

The name of the definition.

type: string

Id

The ID of the definition.

type: string

Arn

The ARN of the definition.

type: string

LastUpdatedTimestamp

The time, in milliseconds since the epoch, when the definition was last updated.

type: string

CreationTimestamp

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

type: string

LatestVersion

The ID of the latest version associated with the definition.

type: string

LatestVersionArn

The ARN of the latest version associated with the definition.

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