AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . logs ]

describe-configuration-templates

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 CreateDelivery .

See also: AWS API Documentation

describe-configuration-templates is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: configurationTemplates

Synopsis

  describe-configuration-templates
[--service <value>]
[--log-types <value>]
[--resource-types <value>]
[--delivery-destination-types <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--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.

--log-types (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)

Syntax:

"string" "string" ...

--resource-types (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)

Syntax:

"string" "string" ...

--delivery-destination-types (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)

Syntax:

"string" "string" ...

Where valid values are:
  S3
  CWL
  FH

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

configurationTemplates -> (list)

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

(structure)

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 -> (structure)

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 -> (structure)

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. 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.

allowedFields -> (list)

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

(structure)

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)

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