Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateDestination

Updates properties of a destination.

Request Syntax


PATCH /destinations/Name HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Expression": "string",
   "ExpressionType": "string",
   "RoleArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

Name

The new name of the resource.

Length Constraints: Maximum length of 128.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

A new description of the resource.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

Expression

The new rule name or topic rule to send messages to.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

ExpressionType

The type of value in Expression.

Type: String

Valid Values: RuleName | MqttTopic

Required: No

RoleArn

The ARN of the IAM Role that authorizes the destination.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

Response Syntax


HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400