[ aws . timestream-query ]

list-scheduled-queries

Description

Gets a list of all scheduled queries in the caller’s Amazon account and Region. ListScheduledQueries is eventually consistent.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-scheduled-queries 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: ScheduledQueries

Synopsis

  list-scheduled-queries
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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

ScheduledQueries -> (list)

A list of scheduled queries.

(structure)

Scheduled Query

Arn -> (string)

The Amazon Resource Name.

Name -> (string)

The name of the scheduled query.

CreationTime -> (timestamp)

The creation time of the scheduled query.

State -> (string)

State of scheduled query.

PreviousInvocationTime -> (timestamp)

The last time the scheduled query was run.

NextInvocationTime -> (timestamp)

The next time the scheduled query is to be run.

ErrorReportConfiguration -> (structure)

Configuration for scheduled query error reporting.

S3Configuration -> (structure)

The S3 configuration for the error reports.

BucketName -> (string)

Name of the S3 bucket under which error reports will be created.

ObjectKeyPrefix -> (string)

Prefix for the error report key. Timestream by default adds the following prefix to the error report path.

EncryptionOption -> (string)

Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.

TargetDestination -> (structure)

Target data source where final scheduled query result will be written.

TimestreamDestination -> (structure)

Query result destination details for Timestream data source.

DatabaseName -> (string)

Timestream database name.

TableName -> (string)

Timestream table name.

LastRunStatus -> (string)

Status of the last scheduled query run.

NextToken -> (string)

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