openapi-directory/api/amazonaws.com/athena.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2017-05-18","x-release":"v4","title":"Amazon Athena","description":"<p>Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/what-is.html\">What is Amazon Athena</a> in the <i>Amazon Athena User Guide</i>.</p> <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html\">Accessing Amazon Athena with JDBC</a>.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"athena","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/athena-2017-05-18.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/athena/"},"x-hasEquivalentPaths":true,"security":[{"hmac":[]}],"paths":{"/":{"post":{"operationId":"BatchGetNamedQuery","description":"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 <a>ListNamedQueries</a> 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 <a>UnprocessedNamedQueryId</a>. Named queries are different from executed queries. Use <a>BatchGetQueryExecution</a> to get details about each unique query execution, and <a>ListQueryExecutions</a> to get a list of query execution IDs.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchGetNamedQueryOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchGetNamedQueryInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#BatchGetQueryExecution":{"post":{"operationId":"BatchGetQueryExecution","description":"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. To get a list of query execution IDs, use <a>ListQueryExecutions</a>. Query executions are different from named (saved) queries. Use <a>BatchGetNamedQuery</a> to get details about named queries.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchGetQueryExecutionOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchGetQueryExecutionInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateNamedQuery":{"post":{"operationId":"CreateNamedQuery","description":"<p>Creates a named query.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNamedQueryOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNamedQueryInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DeleteNamedQuery":{"post":{"operationId":"DeleteNamedQuery","description":"<p>Deletes a named query.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteNamedQueryOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteNamedQueryInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#GetNamedQuery":{"post":{"operationId":"GetNamedQuery","description":"Returns information about a single query.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNamedQueryOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNamedQueryInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#GetQueryExecution":{"post":{"operationId":"GetQueryExecution","description":"Returns information about a single execution of a query. Each time a query executes, information about the query execution is saved with a unique ID.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQueryExecutionOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQueryExecutionInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#GetQueryResults":{"post":{"operationId":"GetQueryResults","description":"Returns the results of a single query execution specified by <code>QueryExecutionId</code>. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQueryResultsOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQueryResultsInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListNamedQueries":{"post":{"operationId":"ListNamedQueries","description":"<p>Provides a list of all available query IDs.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNamedQueriesOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNamedQueriesInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListQueryExecutions":{"post":{"operationId":"ListQueryExecutions","description":"<p>Provides a list of all available query execution IDs.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListQueryExecutionsOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListQueryExecutionsInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#StartQueryExecution":{"post":{"operationId":"StartQueryExecution","description":"<p>Runs (executes) the SQL query statements contained in the <code>Query</code> string.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartQueryExecutionOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartQueryExecutionInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#StopQueryExecution":{"post":{"operationId":"StopQueryExecution","description":"<p>Stops a query execution.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopQueryExecutionOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopQueryExecutionInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"servers":[{"url":"https://athena.amazonaws.com/"},{"url":"http://athena.amazonaws.com/"}],"components":{"parameters":{"Action":{"name":"Action","in":"query","required":true,"schema":{"type":"string"}},"Version":{"name":"Version","in":"query","required":true,"schema":{"type":"string"}},"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"BatchGetNamedQueryOutput":{"type":"object","properties":{"NamedQueries":{"$ref":"#/components/schemas/NamedQueryList"},"UnprocessedNamedQueryIds":{"$ref":"#/components/schemas/UnprocessedNamedQueryIdList"}}},"BatchGetNamedQueryInput":{"type":"object","required":["NamedQueryIds"],"properties":{"NamedQueryIds":{"$ref":"#/components/schemas/NamedQueryIdList"}}},"InternalServerException":{},"InvalidRequestException":{},"BatchGetQueryExecutionOutput":{"type":"object","properties":{"QueryExecutions":{"$ref":"#/components/schemas/QueryExecutionList"},"UnprocessedQueryExecutionIds":{"$ref":"#/components/schemas/UnprocessedQueryExecutionIdList"}}},"BatchGetQueryExecutionInput":{"type":"object","required":["QueryExecutionIds"],"properties":{"QueryExecutionIds":{"$ref":"#/components/schemas/QueryExecutionIdList"}}},"CreateNamedQueryOutput":{"type":"object","properties":{"NamedQueryId":{"$ref":"#/components/schemas/NamedQueryId"}}},"CreateNamedQueryInput":{"type":"object","required":["Name","Database","QueryString"],"properties":{"Name":{"$ref":"#/components/schemas/NameString"},"Description":{"$ref":"#/components/schemas/DescriptionString"},"Database":{"$ref":"#/components/schemas/DatabaseString"},"QueryString":{"$ref":"#/components/schemas/QueryString"},"ClientRequestToken":{"$ref":"#/components/schemas/IdempotencyToken"}}},"DeleteNamedQueryOutput":{"type":"object","properties":{}},"DeleteNamedQueryInput":{"type":"object","required":["NamedQueryId"],"properties":{"NamedQueryId":{"$ref":"#/components/schemas/NamedQueryId"}}},"GetNamedQueryOutput":{"type":"object","properties":{"NamedQuery":{"$ref":"#/components/schemas/NamedQuery"}}},"GetNamedQueryInput":{"type":"object","required":["NamedQueryId"],"properties":{"NamedQueryId":{"$ref":"#/components/schemas/NamedQueryId"}}},"GetQueryExecutionOutput":{"type":"object","properties":{"QueryExecution":{"$ref":"#/components/schemas/QueryExecution"}}},"GetQueryExecutionInput":{"type":"object","required":["QueryExecutionId"],"properties":{"QueryExecutionId":{"$ref":"#/components/schemas/QueryExecutionId"}}},"GetQueryResultsOutput":{"type":"object","properties":{"UpdateCount":{"$ref":"#/components/schemas/Long"},"ResultSet":{"$ref":"#/components/schemas/ResultSet"},"NextToken":{"$ref":"#/components/schemas/Token"}}},"GetQueryResultsInput":{"type":"object","required":["QueryExecutionId"],"properties":{"QueryExecutionId":{"$ref":"#/components/schemas/QueryExecutionId"},"NextToken":{"$ref":"#/components/schemas/Token"},"MaxResults":{"$ref":"#/components/schemas/MaxQueryResults"}}},"ListNamedQueriesOutput":{"type":"object","properties":{"NamedQueryIds":{"$ref":"#/components/schemas/NamedQueryIdList"},"NextToken":{"$ref":"#/components/schemas/Token"}}},"ListNamedQueriesInput":{"type":"object","properties":{"NextToken":{"$ref":"#/components/schemas/Token"},"MaxResults":{"$ref":"#/components/schemas/MaxNamedQueriesCount"}}},"ListQueryExecutionsOutput":{"type":"object","properties":{"QueryExecutionIds":{"$ref":"#/components/schemas/QueryExecutionIdList"},"NextToken":{"$ref":"#/components/schemas/Token"}}},"ListQueryExecutionsInput":{"type":"object","properties":{"NextToken":{"$ref":"#/components/schemas/Token"},"MaxResults":{"$ref":"#/components/schemas/MaxQueryExecutionsCount"}}},"StartQueryExecutionOutput":{"type":"object","properties":{"QueryExecutionId":{"$ref":"#/components/schemas/QueryExecutionId"}}},"StartQueryExecutionInput":{"type":"object","required":["QueryString","ResultConfiguration"],"properties":{"QueryString":{"$ref":"#/components/schemas/QueryString"},"ClientRequestToken":{"$ref":"#/components/schemas/IdempotencyToken"},"QueryExecutionContext":{"$ref":"#/components/schemas/QueryExecutionContext"},"ResultConfiguration":{"$ref":"#/components/schemas/ResultConfiguration"}}},"TooManyRequestsException":{},"StopQueryExecutionOutput":{"type":"object","properties":{}},"StopQueryExecutionInput":{"type":"object","required":["QueryExecutionId"],"properties":{"QueryExecutionId":{"$ref":"#/components/schemas/QueryExecutionId"}}},"NamedQueryIdList":{"type":"array","items":{"$ref":"#/components/schemas/NamedQueryId"},"minItems":1,"maxItems":50},"NamedQueryList":{"type":"array","items":{"$ref":"#/components/schemas/NamedQuery"}},"UnprocessedNamedQueryIdList":{"type":"array","items":{"$ref":"#/components/schemas/UnprocessedNamedQueryId"}},"QueryExecutionIdList":{"type":"array","items":{"$ref":"#/components/schemas/QueryExecutionId"},"minItems":1,"maxItems":50},"QueryExecutionList":{"type":"array","items":{"$ref":"#/components/schemas/QueryExecution"}},"UnprocessedQueryExecutionIdList":{"type":"array","items":{"$ref":"#/components/schemas/UnprocessedQueryExecutionId"}},"Boolean":{"type":"boolean"},"String":{"type":"string"},"Integer":{"type":"integer"},"ColumnNullable":{"type":"string","enum":["NOT_NULL","NULLABLE","UNKNOWN"]},"ColumnInfo":{"type":"object","required":["Name","Type"],"properties":{"CatalogName":{"$ref":"#/components/schemas/String"},"SchemaName":{"$ref":"#/components/schemas/String"},"TableName":{"$ref":"#/components/schemas/String"},"Name":{"$ref":"#/components/schemas/String"},"Label":{"$ref":"#/components/schemas/String"},"Type":{"$ref":"#/components/schemas/String"},"Precision":{"$ref":"#/components/schemas/Integer"},"Scale":{"$ref":"#/components/schemas/Integer"},"Nullable":{"$ref":"#/components/schemas/ColumnNullable"},"CaseSensitive":{"$ref":"#/components/schemas/Boolean"}},"description":"Information about the columns in a query execution result."},"ColumnInfoList":{"type":"array","items":{"$ref":"#/components/schemas/ColumnInfo"}},"NameString":{"type":"string","minLength":1,"maxLength":128},"DescriptionString":{"type":"string","minLength":1,"maxLength":1024},"DatabaseString":{"type":"string","minLength":1,"maxLength":32},"QueryString":{"type":"string","minLength":1,"maxLength":262144},"IdempotencyToken":{"type":"string","minLength":32,"maxLength":128},"NamedQueryId":{"type":"string"},"Date":{"type":"string","format":"date-time"},"datumString":{"type":"string"},"Datum":{"type":"object","properties":{"VarCharValue":{"$ref":"#/components/schemas/datumString"}},"description":"A piece of data (a field in the table)."},"EncryptionOption":{"type":"string","enum":["SSE_S3","SSE_KMS","CSE_KMS"]},"EncryptionConfiguration":{"type":"object","required":["EncryptionOption"],"properties":{"EncryptionOption":{"$ref":"#/components/schemas/EncryptionOption"},"KmsKey":{"$ref":"#/components/schemas/String"}},"description":"If query results are encrypted in Amazon S3, indicates the encryption option used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key information."},"ErrorCode":{"type":"string","description":"The error code returned when the query execution failed to process, or when the processing request for the named query failed.","minLength":1,"maxLength":256},"ErrorMessage":{"type":"string"},"NamedQuery":{"type":"object","required":["Name","Database","QueryString"],"properties":{"Name":{"$ref":"#/components/schemas/NameString"},"Description":{"$ref":"#/components/schemas/DescriptionString"},"Database":{"$ref":"#/components/schemas/DatabaseString"},"QueryString":{"$ref":"#/components/schemas/QueryString"},"NamedQueryId":{"$ref":"#/components/schemas/NamedQueryId"}},"description":"A query, where <code>QueryString</code> is the SQL query statements that comprise the query."},"QueryExecutionId":{"type":"string"},"QueryExecution":{"type":"object","properties":{"QueryExecutionId":{"$ref":"#/components/schemas/QueryExecutionId"},"Query":{"$ref":"#/components/schemas/QueryString"},"StatementType":{"$ref":"#/components/schemas/StatementType"},"ResultConfiguration":{"$ref":"#/components/schemas/ResultConfiguration"},"QueryExecutionContext":{"$ref":"#/components/schemas/QueryExecutionContext"},"Status":{"$ref":"#/components/schemas/QueryExecutionStatus"},"Statistics":{"$ref":"#/components/schemas/QueryExecutionStatistics"}},"description":"Information about a single instance of a query execution."},"Token":{"type":"string"},"MaxQueryResults":{"type":"integer","minimum":0,"maximum":1000},"Long":{"type":"integer"},"ResultSet":{"type":"object","properties":{"Rows":{"$ref":"#/components/schemas/RowList"},"ResultSetMetadata":{"$ref":"#/components/schemas/ResultSetMetadata"}},"description":"The metadata and rows that comprise a query result set. The metadata describes the column structure and data types."},"MaxNamedQueriesCount":{"type":"integer","minimum":0,"maximum":50},"MaxQueryExecutionsCount":{"type":"integer","minimum":0,"maximum":50},"StatementType":{"type":"string","enum":["DDL","DML","UTILITY"]},"ResultConfiguration":{"type":"object","required":["OutputLocation"],"properties":{"OutputLocation":{"$ref":"#/components/schemas/String"},"EncryptionConfiguration":{"$ref":"#/components/schemas/EncryptionConfiguration"}},"description":"The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results."},"QueryExecutionContext":{"type":"object","properties":{"Database":{"$ref":"#/components/schemas/DatabaseString"}},"description":"The database in which the query execution occurs."},"QueryExecutionStatus":{"type":"object","properties":{"State":{"$ref":"#/components/schemas/QueryExecutionState"},"StateChangeReason":{"$ref":"#/components/schemas/String"},"SubmissionDateTime":{"$ref":"#/components/schemas/Date"},"CompletionDateTime":{"$ref":"#/components/schemas/Date"}},"description":"The completion date, current state, submission time, and state change reason (if applicable) for the query execution."},"QueryExecutionStatistics":{"type":"object","properties":{"EngineExecutionTimeInMillis":{"$ref":"#/components/schemas/Long"},"DataScannedInBytes":{"$ref":"#/components/schemas/Long"}},"description":"The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run."},"QueryExecutionState":{"type":"string","enum":["QUEUED","RUNNING","SUCCEEDED","FAILED","CANCELLED"]},"RowList":{"type":"array","items":{"$ref":"#/components/schemas/Row"}},"ResultSetMetadata":{"type":"object","properties":{"ColumnInfo":{"$ref":"#/components/schemas/ColumnInfoList"}},"description":"The metadata that describes the column structure and data types of a table of query results. "},"datumList":{"type":"array","items":{"$ref":"#/components/schemas/Datum"}},"Row":{"type":"object","properties":{"Data":{"$ref":"#/components/schemas/datumList"}},"description":"The rows that comprise a query result table."},"UnprocessedNamedQueryId":{"type":"object","properties":{"NamedQueryId":{"$ref":"#/components/schemas/NamedQueryId"},"ErrorCode":{"$ref":"#/components/schemas/ErrorCode"},"ErrorMessage":{"$ref":"#/components/schemas/ErrorMessage"}},"description":"Information about a named query ID that could not be processed."},"UnprocessedQueryExecutionId":{"type":"object","properties":{"QueryExecutionId":{"$ref":"#/components/schemas/QueryExecutionId"},"ErrorCode":{"$ref":"#/components/schemas/ErrorCode"},"ErrorMessage":{"$ref":"#/components/schemas/ErrorMessage"}},"description":"Describes a query execution that failed to process."}}}}