UpdateCommand - AWS IoT

UpdateCommand

Update information about a command or mark a command for deprecation.

Request Syntax

PATCH /commands/commandId HTTP/1.1 Content-type: application/json { "deprecated": boolean, "description": "string", "displayName": "string" }

URI Request Parameters

The request uses the following URI parameters.

commandId

The unique identifier of the command to be updated.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

deprecated

A boolean that you can use to specify whether to deprecate a command.

Type: Boolean

Required: No

description

A short text description of the command.

Type: String

Length Constraints: Maximum length of 2028.

Pattern: [^\p{C}]*

Required: No

displayName

The new user-friendly name to use in the console for the command.

Type: String

Length Constraints: Maximum length of 64.

Pattern: [^\p{C}]*

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "commandId": "string", "deprecated": boolean, "description": "string", "displayName": "string", "lastUpdatedAt": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

commandId

The unique identifier of the command.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

deprecated

The boolean that indicates whether the command was deprecated.

Type: Boolean

description

The updated text description of the command.

Type: String

Length Constraints: Maximum length of 2028.

Pattern: [^\p{C}]*

displayName

The updated user-friendly display name in the console for the command.

Type: String

Length Constraints: Maximum length of 64.

Pattern: [^\p{C}]*

lastUpdatedAt

The date and time (epoch timestamp in seconds) when the command was last updated.

Type: Timestamp

Errors

ConflictException

The request conflicts with the current state of the resource.

HTTP Status Code: 409

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

ValidationException

The request is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: