CreatePreparedStatement - Athena

CreatePreparedStatement

Creates a prepared statement for use with SQL queries in Athena.

Request Syntax

{ "Description": "string", "QueryStatement": "string", "StatementName": "string", "WorkGroup": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Description

The description of the prepared statement.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

QueryStatement

The query string for the prepared statement.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 262144.

Required: Yes

StatementName

The name of the prepared statement.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z_][a-zA-Z0-9_@:]{1,256}

Required: Yes

WorkGroup

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

Type: String

Pattern: [a-zA-Z0-9._-]{1,128}

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

Indicates a platform issue, which may be due to a transient condition or outage.

HTTP Status Code: 500

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: