Describe Configuration Templates

cloudwatchlogs_describe_configuration_templates

R Documentation

Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries

Description

Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see create_delivery.

Usage

cloudwatchlogs_describe_configuration_templates(service, logTypes,
  resourceTypes, deliveryDestinationTypes, nextToken, limit)

Arguments

service

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

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

resourceTypes

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

deliveryDestinationTypes

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

nextToken

limit

Use this parameter to limit the number of configuration templates that are returned in the response.

Value

A list with the following syntax:

list(
  configurationTemplates = list(
    list(
      service = "string",
      logType = "string",
      resourceType = "string",
      deliveryDestinationType = "S3"|"CWL"|"FH",
      defaultDeliveryConfigValues = list(
        recordFields = list(
          "string"
        ),
        fieldDelimiter = "string",
        s3DeliveryConfiguration = list(
          suffixPath = "string",
          enableHiveCompatiblePath = TRUE|FALSE
        )
      ),
      allowedFields = list(
        list(
          name = "string",
          mandatory = TRUE|FALSE
        )
      ),
      allowedOutputFormats = list(
        "json"|"plain"|"w3c"|"raw"|"parquet"
      ),
      allowedActionForAllowVendedLogsDeliveryForResource = "string",
      allowedFieldDelimiters = list(
        "string"
      ),
      allowedSuffixPathFields = list(
        "string"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_configuration_templates(
  service = "string",
  logTypes = list(
    "string"
  ),
  resourceTypes = list(
    "string"
  ),
  deliveryDestinationTypes = list(
    "S3"|"CWL"|"FH"
  ),
  nextToken = "string",
  limit = 123
)