[ aws . athena ]

get-prepared-statement

Description

Retrieves the prepared statement with the specified name from the specified workgroup.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-prepared-statement
--statement-name <value>
--work-group <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--statement-name (string)

The name of the prepared statement to retrieve.

--work-group (string)

The workgroup to which the statement to be retrieved belongs.

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

See ‘aws help’ for descriptions of global parameters.

Output

PreparedStatement -> (structure)

The name of the prepared statement that was retrieved.

StatementName -> (string)

The name of the prepared statement.

QueryStatement -> (string)

The query string for the prepared statement.

WorkGroupName -> (string)

The name of the workgroup to which the prepared statement belongs.

Description -> (string)

The description of the prepared statement.

LastModifiedTime -> (timestamp)

The last modified time of the prepared statement.