CloudWatchLogs / Paginator / DescribeConfigurationTemplates

DescribeConfigurationTemplates

class CloudWatchLogs.Paginator.DescribeConfigurationTemplates

paginator = client.get_paginator('describe_configuration_templates')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    service='string',
    logTypes=[
        'string',
    ],
    resourceTypes=[
        'string',
    ],
    deliveryDestinationTypes=[
        'S3'|'CWL'|'FH',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• service (string) – Use this parameter to filter the response to include only the configuration templates that apply to the Amazon Web Services service that you specify here.

• logTypes (list) –

  Use this parameter to filter the response to include only the configuration templates that apply to the log types that you specify here.

  • (string) –

• resourceTypes (list) –

  Use this parameter to filter the response to include only the configuration templates that apply to the resource types that you specify here.

  • (string) –

• deliveryDestinationTypes (list) –

  Use this parameter to filter the response to include only the configuration templates that apply to the delivery destination types that you specify here.

  • (string) –

• 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

{
    'configurationTemplates': [
        {
            'service': 'string',
            'logType': 'string',
            'resourceType': 'string',
            'deliveryDestinationType': 'S3'|'CWL'|'FH',
            'defaultDeliveryConfigValues': {
                'recordFields': [
                    'string',
                ],
                'fieldDelimiter': 'string',
                's3DeliveryConfiguration': {
                    'suffixPath': 'string',
                    'enableHiveCompatiblePath': True|False
                }
            },
            'allowedFields': [
                {
                    'name': 'string',
                    'mandatory': True|False
                },
            ],
            'allowedOutputFormats': [
                'json'|'plain'|'w3c'|'raw'|'parquet',
            ],
            'allowedActionForAllowVendedLogsDeliveryForResource': 'string',
            'allowedFieldDelimiters': [
                'string',
            ],
            'allowedSuffixPathFields': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • configurationTemplates (list) –

    An array of objects, where each object describes one configuration template that matches the filters that you specified in the request.

    • (dict) –

      A structure containing information about the deafult settings and available settings that you can use to configure a delivery or a delivery destination.

      • service (string) –

        A string specifying which service this configuration template applies to. For more information about supported services see Enable logging from Amazon Web Services services..

      • logType (string) –

        A string specifying which log type this configuration template applies to.

      • resourceType (string) –

        A string specifying which resource type this configuration template applies to.

      • deliveryDestinationType (string) –

        A string specifying which destination type this configuration template applies to.

      • defaultDeliveryConfigValues (dict) –

        A mapping that displays the default value of each property within a delivery’s configuration, if it is not specified in the request.

        • recordFields (list) –

          The default record fields that will be delivered when a list of record fields is not provided in a CreateDelivery operation.

          • (string) –

        • fieldDelimiter (string) –

          The default field delimiter that is used in a CreateDelivery operation when the field delimiter is not specified in that operation. The field delimiter is used only when the final output delivery is in Plain, W3C, or Raw format.

        • s3DeliveryConfiguration (dict) –

          The delivery parameters that are used when you create a delivery to a delivery destination that 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. To find the values supported for the suffix path for each log source, use the DescribeConfigurationTemplates operation and check the allowedSuffixPathFields field in the response.

          • enableHiveCompatiblePath (boolean) –

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

      • allowedFields (list) –

        The allowed fields that a caller can use in the recordFields parameter of a CreateDelivery or UpdateDeliveryConfiguration operation.

        • (dict) –

          A structure that represents a valid record field header and whether it is mandatory.

          • name (string) –

            The name to use when specifying this record field in a CreateDelivery or UpdateDeliveryConfiguration operation.

          • mandatory (boolean) –

            If this is true, the record field must be present in the recordFields parameter provided to a CreateDelivery or UpdateDeliveryConfiguration operation.

      • allowedOutputFormats (list) –

        The list of delivery destination output formats that are supported by this log source.

        • (string) –

      • allowedActionForAllowVendedLogsDeliveryForResource (string) –

        The action permissions that a caller needs to have to be able to successfully create a delivery source on the desired resource type when calling PutDeliverySource.

      • allowedFieldDelimiters (list) –

        The valid values that a caller can use as field delimiters when calling CreateDelivery or UpdateDeliveryConfiguration on a delivery that delivers in Plain, W3C, or Raw format.

        • (string) –

      • allowedSuffixPathFields (list) –

        The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.

        • (string) –

  • NextToken (string) –

    A token to resume pagination.