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.
UpdateSubscriptionDefinition
Updates the name of a subscription definition. To update the list of available
subscriptions, use CreateSubscriptionDefinitionVersion
.
URI: PUT
/greengrass/definition/subscriptions/
SubscriptionDefinitionId
Produces: application/json
CLI:
aws greengrass update-subscription-definition \ --subscription-definition-id <value> \ [--name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string", "Name": "string" }
Parameters:
- SubscriptionDefinitionId
-
The ID of the subscription 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