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

CreatePublishingDestination

Creates a publishing destination where you can export your GuardDuty findings. Before you start exporting the findings, the destination resource must exist.

Request Syntax


POST /detector/detectorId/publishingDestination HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "destinationProperties": { 
      "destinationArn": "string",
      "kmsKeyArn": "string"
   },
   "destinationType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

detectorId

The ID of the GuardDuty detector associated with the publishing destination.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

The idempotency token for the request.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: No

destinationProperties

The properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.

Type: DestinationProperties object

Required: Yes

destinationType

The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.

Type: String

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

Valid Values: S3

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "destinationId": "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.

destinationId

The ID of the publishing destination that is created.

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