Menu
Amazon Athena
Amazon Athena Documentation (API Version 2017-05-18)

BatchGetNamedQuery

Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Use ListNamedQueries to get the list of named query IDs. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries are different from executed queries. Use BatchGetQueryExecution to get details about each unique query execution, and ListQueryExecutions to get a list of query execution IDs.

Request Syntax

Copy
{ "NamedQueryIds": [ "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.

NamedQueryIds

An array of query IDs.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: Yes

Response Syntax

Copy
{ "NamedQueries": [ { "Database": "string", "Description": "string", "Name": "string", "NamedQueryId": "string", "QueryString": "string" } ], "UnprocessedNamedQueryIds": [ { "ErrorCode": "string", "ErrorMessage": "string", "NamedQueryId": "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.

NamedQueries

Information about the named query IDs submitted.

Type: Array of NamedQuery objects

UnprocessedNamedQueryIds

Information about provided query IDs.

Type: Array of UnprocessedNamedQueryId objects

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: