Try it now and let us know what you think. Switch to the new look >>
You can return to the original look by selecting English in the language selector above.
ListNamedQueries
Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
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 queries to return in this request.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 50.
Required: No
- NextToken
-
The token that specifies where to start pagination if a previous request was truncated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- WorkGroup
-
The name of the workgroup from which the named queries are being returned.
Type: String
Pattern:
[a-zA-z0-9._-]{1,128}Required: No
Response Syntax
{ "NamedQueryIds": [ "string" ], "NextToken": "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.
- NamedQueryIds
-
The list of unique query IDs.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
- NextToken
-
A token to be used by the next request if this request is truncated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
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:
