CloudWatchLogs / Paginator / DescribeDeliveries

DescribeDeliveries

class CloudWatchLogs.Paginator.DescribeDeliveries

paginator = client.get_paginator('describe_deliveries')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchLogs.Client.describe_deliveries().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous 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.

      You can’t update an existing delivery. You can only create and delete deliveries.

      • 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) –

    A token to resume pagination.