GuardDuty / Client / describe_publishing_destination

describe_publishing_destination

GuardDuty.Client.describe_publishing_destination(**kwargs)

Returns information about the publishing destination specified by the provided destinationId.

See also: AWS API Documentation

Request Syntax

response = client.describe_publishing_destination(
    DetectorId='string',
    DestinationId='string'
)

Parameters:

• DetectorId (string) –

  [REQUIRED]

  The unique ID of the detector associated with the publishing destination to retrieve.

• DestinationId (string) –

  [REQUIRED]

  The ID of the publishing destination to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'DestinationId': 'string',
    'DestinationType': 'S3',
    'Status': 'PENDING_VERIFICATION'|'PUBLISHING'|'UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY'|'STOPPED',
    'PublishingFailureStartTimestamp': 123,
    'DestinationProperties': {
        'DestinationArn': 'string',
        'KmsKeyArn': 'string'
    }
}

Response Structure

• (dict) –

  • DestinationId (string) –

    The ID of the publishing destination.

  • DestinationType (string) –

    The type of publishing destination. Currently, only Amazon S3 buckets are supported.

  • Status (string) –

    The status of the publishing destination.

  • PublishingFailureStartTimestamp (integer) –

    The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.

  • DestinationProperties (dict) –

    A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.

    • DestinationArn (string) –

      The ARN of the resource to publish to.

      To specify an S3 bucket folder use the following format: arn:aws:s3:::DOC-EXAMPLE-BUCKET/myFolder/

    • KmsKeyArn (string) –

      The ARN of the KMS key to use for encryption.

Exceptions

• GuardDuty.Client.exceptions.BadRequestException

• GuardDuty.Client.exceptions.InternalServerErrorException