ListPublishingDestinations - Amazon GuardDuty

ListPublishingDestinations

Returns a list of publishing destinations associated with the specified dectectorId.

Request Syntax

GET /detector/detectorId/publishingDestination?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

detectorId

The ID of the detector to retrieve publishing destinations for.

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

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 returned in the repsonse. 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 obect that includes information about each publishing destination returned.

Type: Array of Destination objects

nextToken

A token to use for paginating results returned in the repsonse. 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

Bad request exception object.

HTTP Status Code: 400

InternalServerErrorException

Internal server error exception object.

HTTP Status Code: 500

See Also

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