GuardDuty / Client / list_publishing_destinations

list_publishing_destinations#

GuardDuty.Client.list_publishing_destinations(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_publishing_destinations(
    DetectorId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • DetectorId (string) –

    [REQUIRED]

    The detector ID for which you want to retrieve the publishing destination.

  • MaxResults (integer) – The maximum number of results to return in the response.

  • NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Destinations': [
        {
            'DestinationId': 'string',
            'DestinationType': 'S3',
            'Status': 'PENDING_VERIFICATION'|'PUBLISHING'|'UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY'|'STOPPED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Destinations (list) –

      A Destinations object that includes information about each publishing destination returned.

      • (dict) –

        Contains information about the publishing destination, including the ID, type, and status.

        • DestinationId (string) –

          The unique ID of the publishing destination.

        • DestinationType (string) –

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

        • Status (string) –

          The status of the publishing destination.

    • NextToken (string) –

      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.

Exceptions

  • GuardDuty.Client.exceptions.BadRequestException

  • GuardDuty.Client.exceptions.InternalServerErrorException