ListPreparedStatements
Lists the prepared statements in the specified workgroup.
Request Syntax
{
"MaxResults": number
,
"NextToken": "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.
- MaxResults
-
The maximum number of results to return in this request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- NextToken
-
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the
NextToken
from the response object of the previous page call.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- WorkGroup
-
The workgroup to list the prepared statements for.
Type: String
Pattern:
[a-zA-Z0-9._-]{1,128}
Required: Yes
Response Syntax
{
"NextToken": "string",
"PreparedStatements": [
{
"LastModifiedTime": number,
"StatementName": "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.
- NextToken
-
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the
NextToken
from the response object of the previous page call.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- PreparedStatements
-
The list of prepared statements for the workgroup.
Type: Array of PreparedStatementSummary objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
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: