BatchGetQueryExecution - Amazon Athena

BatchGetQueryExecution

Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutions:WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.

Request Syntax

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

QueryExecutionIds

An array of query execution IDs.

Type: Array of strings

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

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

Pattern: \S+

Required: Yes

Response Syntax

{ "QueryExecutions": [ { "EngineVersion": { "EffectiveEngineVersion": "string", "SelectedEngineVersion": "string" }, "ExecutionParameters": [ "string" ], "Query": "string", "QueryExecutionContext": { "Catalog": "string", "Database": "string" }, "QueryExecutionId": "string", "QueryResultsS3AccessGrantsConfiguration": { "AuthenticationType": "string", "CreateUserLevelPrefix": boolean, "EnableS3AccessGrants": boolean }, "ResultConfiguration": { "AclConfiguration": { "S3AclOption": "string" }, "EncryptionConfiguration": { "EncryptionOption": "string", "KmsKey": "string" }, "ExpectedBucketOwner": "string", "OutputLocation": "string" }, "ResultReuseConfiguration": { "ResultReuseByAgeConfiguration": { "Enabled": boolean, "MaxAgeInMinutes": number } }, "StatementType": "string", "Statistics": { "DataManifestLocation": "string", "DataScannedInBytes": number, "EngineExecutionTimeInMillis": number, "QueryPlanningTimeInMillis": number, "QueryQueueTimeInMillis": number, "ResultReuseInformation": { "ReusedPreviousResult": boolean }, "ServicePreProcessingTimeInMillis": number, "ServiceProcessingTimeInMillis": number, "TotalExecutionTimeInMillis": number }, "Status": { "AthenaError": { "ErrorCategory": number, "ErrorMessage": "string", "ErrorType": number, "Retryable": boolean }, "CompletionDateTime": number, "State": "string", "StateChangeReason": "string", "SubmissionDateTime": number }, "SubstatementType": "string", "WorkGroup": "string" } ], "UnprocessedQueryExecutionIds": [ { "ErrorCode": "string", "ErrorMessage": "string", "QueryExecutionId": "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.

QueryExecutions

Information about a query execution.

Type: Array of QueryExecution objects

UnprocessedQueryExecutionIds

Information about the query executions that failed to run.

Type: Array of UnprocessedQueryExecutionId 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: