AWS IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. After this date, AWS IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on AWS 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 AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
/greengrass/definition/connectors/ConnectorDefinitionId
GET
GET
/greengrass/definition/connectors/ConnectorDefinitionId
Operation ID: GetConnectorDefinition
Retrieves information about a connector definition.
Produces: application/json
Path Parameters
- ConnectorDefinitionId
-
The ID of the connector definition.
where used: path; required: true
type: string
CLI
aws greengrass get-connector-definition \ --connector-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"ConnectorDefinitionId": "string"
}Responses
- 200 (GetConnectorDefinitionResponse)
-
{ "Name": "string", "Id": "string", "Arn": "string", "tags": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "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
- 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
- 400
-
Invalid request.
{ "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
DELETE
DELETE
/greengrass/definition/connectors/ConnectorDefinitionId
Operation ID: DeleteConnectorDefinition
Deletes a connector definition.
Produces: application/json
Path Parameters
- ConnectorDefinitionId
-
The ID of the connector definition.
where used: path; required: true
type: string
CLI
aws greengrass delete-connector-definition \ --connector-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"ConnectorDefinitionId": "string"
}Responses
- 200
-
Success.
{ }- Empty Schema
-
Empty
type: object
- 400
-
Invalid request.
{ "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
PUT
PUT
/greengrass/definition/connectors/ConnectorDefinitionId
Operation ID: UpdateConnectorDefinition
Updates the name of a connector definition. To update the list of available
connectors, use CreateConnectorDefinitionVersion.
Produces: application/json
Body Parameters
- UpdateDefinitionRequestBody
-
where used: body; required: true
{ "Name": "string" }- Name
-
The name of the definition.
required: true
type: string
Path Parameters
- ConnectorDefinitionId
-
The ID of the connector definition.
where used: path; required: true
type: string
CLI
aws greengrass update-connector-definition \ --connector-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"ConnectorDefinitionId": "string",
"Name": "string"
}Responses
- 200
-
Success.
{ }- Empty Schema
-
Empty
type: object
- 400
-
Invalid request.
{ "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
