You are viewing the documentation for AWS IoT Greengrass Version 1. AWS IoT Greengrass Version 2 is the latest major version of AWS IoT Greengrass. For more information about the AWS IoT Greengrass Version 2 API, see the AWS IoT Greengrass V2 API Reference.
UpdateConnectorDefinition
Updates the name of a connector definition. To update the list of available connectors,
use CreateConnectorDefinitionVersion
.
URI: PUT
/greengrass/definition/connectors/
ConnectorDefinitionId
Produces: application/json
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" }
Parameters:
- ConnectorDefinitionId
-
The ID of the connector definition.
where used: path; required: true
type: string
- UpdateDefinitionRequestBody
-
where used: body; required: true
{ "Name": "string" }
schema:
- Name
-
The name of the definition.
required: true
type: 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