CloudWatchLogs / Client / describe_deliveries

describe_deliveries#

CloudWatchLogs.Client.describe_deliveries(**kwargs)#

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

A delivery is a connection between a delivery source and a delivery destination.

A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.

See also: AWS API Documentation

Request Syntax

response = client.describe_deliveries(
    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 deliveries to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'deliveries': [
        {
            'id': 'string',
            'arn': 'string',
            'deliverySourceName': 'string',
            'deliveryDestinationArn': 'string',
            'deliveryDestinationType': 'S3'|'CWL'|'FH',
            'recordFields': [
                'string',
            ],
            'fieldDelimiter': 'string',
            's3DeliveryConfiguration': {
                'suffixPath': 'string',
                'enableHiveCompatiblePath': True|False
            },
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • deliveries (list) –

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

      • (dict) –

        This structure contains information about one delivery in your account.

        A delivery is a connection between a logical delivery source and a logical delivery destination.

        For more information, see CreateDelivery.

        To update an existing delivery configuration, use UpdateDeliveryConfiguration.

        • id (string) –

          The unique ID that identifies this delivery in your account.

        • arn (string) –

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

        • deliverySourceName (string) –

          The name of the delivery source that is associated with this delivery.

        • deliveryDestinationArn (string) –

          The ARN of the delivery destination that is associated with this delivery.

        • deliveryDestinationType (string) –

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

        • recordFields (list) –

          The record fields used in this delivery.

          • (string) –

        • fieldDelimiter (string) –

          The field delimiter that is used between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.

        • s3DeliveryConfiguration (dict) –

          This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

          • suffixPath (string) –

            This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.

          • enableHiveCompatiblePath (boolean) –

            This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

        • tags (dict) –

          The tags that have been assigned to this delivery.

          • (string) –

            • (string) –

    • nextToken (string) –

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

Exceptions