DescribePublishingDestination
Returns information about the publishing destination specified by the provided
destinationId
.
Request Syntax
GET /detector/detectorId
/publishingDestination/destinationId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- destinationId
-
The ID of the publishing destination to retrieve.
Required: Yes
- detectorId
-
The unique ID of the detector associated with the publishing destination to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"destinationId": "string",
"destinationProperties": {
"destinationArn": "string",
"kmsKeyArn": "string"
},
"destinationType": "string",
"publishingFailureStartTimestamp": number,
"status": "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.
Type: String
- destinationProperties
-
A
DestinationProperties
object that includes theDestinationArn
andKmsKeyArn
of the publishing destination.Type: DestinationProperties object
- destinationType
-
The type of publishing destination. Currently, only Amazon S3 buckets are supported.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Valid Values:
S3
- publishingFailureStartTimestamp
-
The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.
Type: Long
- status
-
The status of the publishing destination.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Valid Values:
PENDING_VERIFICATION | PUBLISHING | UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY | STOPPED
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: