Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
Requires permission to access the UpdateTopicRuleDestination action.
Request Syntax
PATCH /destinations HTTP/1.1
Content-type: application/json
{
"arn": "string",
"status": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- arn
-
The ARN of the topic rule destination.
Type: String
Required: Yes
- status
-
The status of the topic rule destination. Valid values are:
- IN_PROGRESS
-
A topic rule destination was created but has not been confirmed. You can set
statustoIN_PROGRESSby callingUpdateTopicRuleDestination. CallingUpdateTopicRuleDestinationcauses a new confirmation challenge to be sent to your confirmation endpoint. - ENABLED
-
Confirmation was completed, and traffic to this destination is allowed. You can set
statustoDISABLEDby callingUpdateTopicRuleDestination. - DISABLED
-
Confirmation was completed, and traffic to this destination is not allowed. You can set
statustoENABLEDby callingUpdateTopicRuleDestination. - ERROR
-
Confirmation could not be completed, for example if the confirmation timed out. You can call
GetTopicRuleDestinationfor details about the error. You can setstatustoIN_PROGRESSby callingUpdateTopicRuleDestination. CallingUpdateTopicRuleDestinationcauses a new confirmation challenge to be sent to your confirmation endpoint.
Type: String
Valid Values:
ENABLED | IN_PROGRESS | DISABLED | ERROR | DELETINGRequired: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
- ConflictingResourceUpdateException
-
A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.
HTTP Status Code: 409
- InternalException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- UnauthorizedException
-
You are not authorized to perform this operation.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
