ListTopicRuleDestinations - AWS IoT

ListTopicRuleDestinations

Lists all the topic rule destinations in your AWS account.

Request Syntax

GET /destinations?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return at one time.

Valid Range: Minimum value of 1. Maximum value of 1000.

nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "destinationSummaries": [ { "arn": "string", "createdAt": number, "httpUrlSummary": { "confirmationUrl": "string" }, "lastUpdatedAt": number, "status": "string", "statusReason": "string", "vpcDestinationSummary": { "roleArn": "string", "securityGroups": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" } } ], "nextToken": "string" }

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.

destinationSummaries

Information about a topic rule destination.

Type: Array of TopicRuleDestinationSummary objects

nextToken

The token to use to get the next set of results, or null if there are no additional results.

Type: String

Errors

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: