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

batch-get-prepared-statement

Description

Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in UnprocessedPreparedStatementNames .

See also: AWS API Documentation

Synopsis

  batch-get-prepared-statement
--prepared-statement-names <value>
--work-group <value>
[--cli-input-json <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

--prepared-statement-names (list)

A list of prepared statement names to return.

(string)

Syntax:

"string" "string" ...

--work-group (string)

The name of the workgroup to which the prepared statements belong.

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

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

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

PreparedStatements -> (list)

The list of prepared statements returned.

(structure)

A prepared SQL statement for use with Athena.

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.

UnprocessedPreparedStatementNames -> (list)

A list of one or more prepared statements that were requested but could not be returned.

(structure)

The name of a prepared statement that could not be returned.

StatementName -> (string)

The name of a prepared statement that could not be returned due to an error.

ErrorCode -> (string)

The error code returned when the request for the prepared statement failed.

ErrorMessage -> (string)

The error message containing the reason why the prepared statement could not be returned. The following error messages are possible:

  • INVALID_INPUT - The name of the prepared statement that was provided is not valid (for example, the name is too long).
  • STATEMENT_NOT_FOUND - A prepared statement with the name provided could not be found.
  • UNAUTHORIZED - The requester does not have permission to access the workgroup that contains the prepared statement.