[ aws . timestream-query ]

prepare-query

Description

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with ValidateOnly set to true .

See also: AWS API Documentation

Synopsis

  prepare-query
--query-string <value>
[--validate-only | --no-validate-only]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--query-string (string)

The Timestream query string that you want to use as a prepared statement. Parameter names can be specified in the query string @ character followed by an identifier.

--validate-only | --no-validate-only (boolean)

By setting this value to true , Timestream will only validate that the query string is a valid Timestream query, and not store the prepared query for later use.

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

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

QueryString -> (string)

The query string that you want prepare.

Columns -> (list)

A list of SELECT clause columns of the submitted query string.

(structure)

Details of the column that is returned by the query.

Name -> (string)

Name of the column.

Type -> (structure)

Contains the data type of a column in a query result set. The data type can be scalar or complex. The supported scalar data types are integers, Boolean, string, double, timestamp, date, time, and intervals. The supported complex data types are arrays, rows, and timeseries.

ScalarType -> (string)

Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types .

ArrayColumnInfo -> (structure)

Indicates if the column is an array.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

Type -> (structure)

The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, strings, doubles, Booleans, and others. Complex data types are types such as arrays, rows, and others.

ScalarType -> (string)

Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types .

ArrayColumnInfo -> (structure)

Indicates if the column is an array.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

TimeSeriesMeasureValueColumnInfo -> (structure)

Indicates if the column is a timeseries data type.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

RowColumnInfo -> (list)

Indicates if the column is a row.

(structure)

Contains the metadata for query results such as the column names, data types, and other attributes.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

TimeSeriesMeasureValueColumnInfo -> (structure)

Indicates if the column is a timeseries data type.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

Type -> (structure)

The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, strings, doubles, Booleans, and others. Complex data types are types such as arrays, rows, and others.

ScalarType -> (string)

Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types .

ArrayColumnInfo -> (structure)

Indicates if the column is an array.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

TimeSeriesMeasureValueColumnInfo -> (structure)

Indicates if the column is a timeseries data type.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

RowColumnInfo -> (list)

Indicates if the column is a row.

(structure)

Contains the metadata for query results such as the column names, data types, and other attributes.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

RowColumnInfo -> (list)

Indicates if the column is a row.

(structure)

Contains the metadata for query results such as the column names, data types, and other attributes.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

Type -> (structure)

The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, strings, doubles, Booleans, and others. Complex data types are types such as arrays, rows, and others.

ScalarType -> (string)

Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types .

ArrayColumnInfo -> (structure)

Indicates if the column is an array.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

TimeSeriesMeasureValueColumnInfo -> (structure)

Indicates if the column is a timeseries data type.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

RowColumnInfo -> (list)

Indicates if the column is a row.

(structure)

Contains the metadata for query results such as the column names, data types, and other attributes.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

DatabaseName -> (string)

Database that has this column.

TableName -> (string)

Table within the database that has this column.

Aliased -> (boolean)

True, if the column name was aliased by the query. False otherwise.

Parameters -> (list)

A list of parameters used in the submitted query string.

(structure)

Mapping for named parameters.

Name -> (string)

Parameter name.

Type -> (structure)

Contains the data type of a column in a query result set. The data type can be scalar or complex. The supported scalar data types are integers, Boolean, string, double, timestamp, date, time, and intervals. The supported complex data types are arrays, rows, and timeseries.

ScalarType -> (string)

Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types .

ArrayColumnInfo -> (structure)

Indicates if the column is an array.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

Type -> (structure)

The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, strings, doubles, Booleans, and others. Complex data types are types such as arrays, rows, and others.

ScalarType -> (string)

Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types .

ArrayColumnInfo -> (structure)

Indicates if the column is an array.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

TimeSeriesMeasureValueColumnInfo -> (structure)

Indicates if the column is a timeseries data type.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

RowColumnInfo -> (list)

Indicates if the column is a row.

(structure)

Contains the metadata for query results such as the column names, data types, and other attributes.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

TimeSeriesMeasureValueColumnInfo -> (structure)

Indicates if the column is a timeseries data type.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

Type -> (structure)

The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, strings, doubles, Booleans, and others. Complex data types are types such as arrays, rows, and others.

ScalarType -> (string)

Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types .

ArrayColumnInfo -> (structure)

Indicates if the column is an array.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

TimeSeriesMeasureValueColumnInfo -> (structure)

Indicates if the column is a timeseries data type.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

RowColumnInfo -> (list)

Indicates if the column is a row.

(structure)

Contains the metadata for query results such as the column names, data types, and other attributes.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

RowColumnInfo -> (list)

Indicates if the column is a row.

(structure)

Contains the metadata for query results such as the column names, data types, and other attributes.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

Type -> (structure)

The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, strings, doubles, Booleans, and others. Complex data types are types such as arrays, rows, and others.

ScalarType -> (string)

Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types .

ArrayColumnInfo -> (structure)

Indicates if the column is an array.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

TimeSeriesMeasureValueColumnInfo -> (structure)

Indicates if the column is a timeseries data type.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )

RowColumnInfo -> (list)

Indicates if the column is a row.

(structure)

Contains the metadata for query results such as the column names, data types, and other attributes.

Name -> (string)

The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

( … recursive … )