CloudWatchLogs / Client / describe_delivery_destinations

describe_delivery_destinations#

CloudWatchLogs.Client.describe_delivery_destinations(**kwargs)#

Retrieves a list of the delivery destinations that have been created in the account.

See also: AWS API Documentation

Request Syntax

response = client.describe_delivery_destinations(
    nextToken='string',
    limit=123
)
Parameters:

  • nextToken (string) – The token for the next set of items to return. The token expires after 24 hours.

  • limit (integer) – Optionally specify the maximum number of delivery destinations to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'deliveryDestinations': [
        {
            'name': 'string',
            'arn': 'string',
            'deliveryDestinationType': 'S3'|'CWL'|'FH',
            'outputFormat': 'json'|'plain'|'w3c'|'raw'|'parquet',
            'deliveryDestinationConfiguration': {
                'destinationResourceArn': 'string'
            },
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • deliveryDestinations (list) –

      An array of structures. Each structure contains information about one delivery destination in the account.

      • (dict) –

        This structure contains information about one delivery destination in your account. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, are supported as Firehose delivery destinations.

        To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:

        • Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.

        • Create a delivery destination, which is a logical object that represents the actual delivery destination.

        • If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.

        • Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

        You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.

        • name (string) –

          The name of this delivery destination.

        • arn (string) –

          The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.

        • deliveryDestinationType (string) –

          Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.

        • outputFormat (string) –

          The format of the logs that are sent to this delivery destination.

        • deliveryDestinationConfiguration (dict) –

          A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

          • destinationResourceArn (string) –

            The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.

        • tags (dict) –

          The tags that have been assigned to this delivery destination.

          • (string) –

            • (string) –

    • nextToken (string) –

      The token for the next set of items to return. The token expires after 24 hours.

Exceptions

  • CloudWatchLogs.Client.exceptions.ServiceUnavailableException

  • CloudWatchLogs.Client.exceptions.ServiceQuotaExceededException

  • CloudWatchLogs.Client.exceptions.ValidationException

  • CloudWatchLogs.Client.exceptions.ThrottlingException