Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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-query-definitions

Description

This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.

You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-query-definitions
[--query-definition-name-prefix <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--query-definition-name-prefix (string)

Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.

--max-results (integer)

Limits the number of returned query definitions to the specified number.

--next-token (string)

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

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

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

See 'aws help' for descriptions of global parameters.

Output

queryDefinitions -> (list)

The list of query definitions that match your request.

(structure)

This structure contains details about a saved CloudWatch Logs Insights query definition.

queryDefinitionId -> (string)

The unique ID of the query definition.

name -> (string)

The name of the query definition.

queryString -> (string)

The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax .

lastModified -> (long)

The date that the query definition was most recently modified.

logGroupNames -> (list)

If this query definition contains a list of log groups that it is limited to, that list appears here.

(string)

nextToken -> (string)

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