GetPreparedStatement - Amazon Athena

GetPreparedStatement

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

Request Syntax

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

StatementName

The name of the prepared statement to retrieve.

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 workgroup to which the statement to be retrieved belongs.

Type: String

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

Required: Yes

Response Syntax

{ "PreparedStatement": { "Description": "string", "LastModifiedTime": number, "QueryStatement": "string", "StatementName": "string", "WorkGroupName": "string" } }

Response Elements

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

The following data is returned in JSON format by the service.

PreparedStatement

The name of the prepared statement that was retrieved.

Type: PreparedStatement object

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

ResourceNotFoundException

A resource, such as a workgroup, was not found.

HTTP Status Code: 400

See Also

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