ListPublishingDestinations
Returns a list of publishing destinations associated with the specified
detectorId
.
Request Syntax
GET /detector/detectorId
/publishingDestination?maxResults=MaxResults
&nextToken=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- detectorId
-
The detector ID for which you want to retrieve the publishing destination.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
- MaxResults
-
The maximum number of results to return in the response.
Valid Range: Minimum value of 1. Maximum value of 50.
- NextToken
-
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the
NextToken
value returned from the previous request to continue listing results after the first page.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"destinations": [
{
"destinationId": "string",
"destinationType": "string",
"status": "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.
- destinations
-
A
Destinations
object that includes information about each publishing destination returned.Type: Array of Destination objects
- nextToken
-
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the
NextToken
value returned from the previous request to continue listing results after the first page.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
A bad request exception object.
HTTP Status Code: 400
- InternalServerErrorException
-
An internal server error exception object.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: