{ "openapi": "3.0.0", "info": { "version": "2017-05-18", "x-release": "v4", "title": "Amazon Athena", "description": "
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 What is Amazon Athena in the Amazon Athena User Guide.
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 Accessing Amazon Athena with JDBC.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
", "x-logo": { "url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png", "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-driver": "external" } ], "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://docs.aws.amazon.com/athena/" }, "servers": [ { "url": "http://athena.{region}.amazonaws.com", "variables": { "region": { "description": "The AWS region", "enum": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "us-gov-west-1", "us-gov-east-1", "ca-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "eu-south-1", "af-south-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-southeast-1", "ap-southeast-2", "ap-east-1", "ap-south-1", "sa-east-1", "me-south-1" ], "default": "us-east-1" } }, "description": "The Amazon Athena multi-region endpoint" }, { "url": "https://athena.{region}.amazonaws.com", "variables": { "region": { "description": "The AWS region", "enum": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "us-gov-west-1", "us-gov-east-1", "ca-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "eu-south-1", "af-south-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-southeast-1", "ap-southeast-2", "ap-east-1", "ap-south-1", "sa-east-1", "me-south-1" ], "default": "us-east-1" } }, "description": "The Amazon Athena multi-region endpoint" }, { "url": "http://athena.{region}.amazonaws.com.cn", "variables": { "region": { "description": "The AWS region", "enum": [ "cn-north-1", "cn-northwest-1" ], "default": "cn-north-1" } }, "description": "The Amazon Athena endpoint for China (Beijing) and China (Ningxia)" }, { "url": "https://athena.{region}.amazonaws.com.cn", "variables": { "region": { "description": "The AWS region", "enum": [ "cn-north-1", "cn-northwest-1" ], "default": "cn-north-1" } }, "description": "The Amazon Athena endpoint for China (Beijing) and China (Ningxia)" } ], "x-hasEquivalentPaths": true, "paths": { "/#X-Amz-Target=AmazonAthena.BatchGetNamedQuery": { "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. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput 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": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchGetNamedQueryInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.BatchGetNamedQuery" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.BatchGetPreparedStatement": { "post": { "operationId": "BatchGetPreparedStatement", "description": "Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed inUnprocessedPreparedStatementNames
.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchGetPreparedStatementOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchGetPreparedStatementInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.BatchGetPreparedStatement"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.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. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput 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": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchGetQueryExecutionInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.BatchGetQueryExecution"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.CreateDataCatalog": {
"post": {
"operationId": "CreateDataCatalog",
"description": "Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDataCatalogOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDataCatalogInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.CreateDataCatalog"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.CreateNamedQuery": {
"post": {
"operationId": "CreateNamedQuery",
"description": "Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
", "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": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNamedQueryInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.CreateNamedQuery" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.CreateNotebook": { "post": { "operationId": "CreateNotebook", "description": "Creates an emptyipynb
file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNotebookOutput"
}
}
}
},
"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": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNotebookInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.CreateNotebook"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.CreatePreparedStatement": {
"post": {
"operationId": "CreatePreparedStatement",
"description": "Creates a prepared statement for use with SQL queries in Athena.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePreparedStatementOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePreparedStatementInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.CreatePreparedStatement"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.CreatePresignedNotebookUrl": {
"post": {
"operationId": "CreatePresignedNotebookUrl",
"description": "Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl
must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePresignedNotebookUrlResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePresignedNotebookUrlRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.CreatePresignedNotebookUrl"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.CreateWorkGroup": {
"post": {
"operationId": "CreateWorkGroup",
"description": "Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWorkGroupOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWorkGroupInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.CreateWorkGroup"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.DeleteDataCatalog": {
"post": {
"operationId": "DeleteDataCatalog",
"description": "Deletes a data catalog.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteDataCatalogOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteDataCatalogInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.DeleteDataCatalog"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.DeleteNamedQuery": {
"post": {
"operationId": "DeleteNamedQuery",
"description": "Deletes the named query if you have access to the workgroup in which the query was saved.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
", "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": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteNamedQueryInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.DeleteNamedQuery" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.DeleteNotebook": { "post": { "operationId": "DeleteNotebook", "description": "Deletes the specified notebook.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteNotebookOutput" } } } }, "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": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteNotebookInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.DeleteNotebook" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.DeletePreparedStatement": { "post": { "operationId": "DeletePreparedStatement", "description": "Deletes the prepared statement with the specified name from the specified workgroup.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePreparedStatementOutput" } } } }, "480": { "description": "InternalServerException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerException" } } } }, "481": { "description": "InvalidRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequestException" } } } }, "482": { "description": "ResourceNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePreparedStatementInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.DeletePreparedStatement" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.DeleteWorkGroup": { "post": { "operationId": "DeleteWorkGroup", "description": "Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWorkGroupOutput" } } } }, "480": { "description": "InternalServerException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerException" } } } }, "481": { "description": "InvalidRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequestException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWorkGroupInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.DeleteWorkGroup" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.ExportNotebook": { "post": { "operationId": "ExportNotebook", "description": "Exports the specified notebook and its metadata.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportNotebookOutput" } } } }, "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": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportNotebookInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.ExportNotebook" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.GetCalculationExecution": { "post": { "operationId": "GetCalculationExecution", "description": "Describes a previously submitted calculation execution.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCalculationExecutionResponse" } } } }, "480": { "description": "InternalServerException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerException" } } } }, "481": { "description": "InvalidRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequestException" } } } }, "482": { "description": "ResourceNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCalculationExecutionRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.GetCalculationExecution" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.GetCalculationExecutionCode": { "post": { "operationId": "GetCalculationExecutionCode", "description": "Retrieves the unencrypted code that was executed for the calculation.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCalculationExecutionCodeResponse" } } } }, "480": { "description": "InternalServerException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerException" } } } }, "481": { "description": "InvalidRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequestException" } } } }, "482": { "description": "ResourceNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCalculationExecutionCodeRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.GetCalculationExecutionCode" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.GetCalculationExecutionStatus": { "post": { "operationId": "GetCalculationExecutionStatus", "description": "Gets the status of a current calculation.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCalculationExecutionStatusResponse" } } } }, "480": { "description": "InternalServerException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerException" } } } }, "481": { "description": "InvalidRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequestException" } } } }, "482": { "description": "ResourceNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCalculationExecutionStatusRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.GetCalculationExecutionStatus" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.GetDataCatalog": { "post": { "operationId": "GetDataCatalog", "description": "Returns the specified data catalog.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDataCatalogOutput" } } } }, "480": { "description": "InternalServerException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerException" } } } }, "481": { "description": "InvalidRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequestException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDataCatalogInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.GetDataCatalog" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.GetDatabase": { "post": { "operationId": "GetDatabase", "description": "Returns a database object for the specified database and data catalog.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDatabaseOutput" } } } }, "480": { "description": "InternalServerException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerException" } } } }, "481": { "description": "InvalidRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequestException" } } } }, "482": { "description": "MetadataException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDatabaseInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.GetDatabase" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.GetNamedQuery": { "post": { "operationId": "GetNamedQuery", "description": "Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.", "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": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNamedQueryInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.GetNamedQuery" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.GetNotebookMetadata": { "post": { "operationId": "GetNotebookMetadata", "description": "Retrieves notebook metadata for the specified notebook ID.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNotebookMetadataOutput" } } } }, "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": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNotebookMetadataInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.GetNotebookMetadata" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.GetPreparedStatement": { "post": { "operationId": "GetPreparedStatement", "description": "Retrieves the prepared statement with the specified name from the specified workgroup.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPreparedStatementOutput" } } } }, "480": { "description": "InternalServerException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerException" } } } }, "481": { "description": "InvalidRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequestException" } } } }, "482": { "description": "ResourceNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPreparedStatementInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.GetPreparedStatement" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.GetQueryExecution": { "post": { "operationId": "GetQueryExecution", "description": "Returns information about a single execution of a query if you have access to the workgroup in which the query ran. 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": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetQueryExecutionInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.GetQueryExecution" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.GetQueryResults": { "post": { "operationId": "GetQueryResults", "description": "Streams the results of a single query execution specified by QueryExecutionId
from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.
To stream query results successfully, the IAM principal with permission to call GetQueryResults
also must have permissions to the Amazon S3 GetObject
action for the Athena query results location.
IAM principals with permission to the Amazon S3 GetObject
action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults
action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.
ipynb
file to a Spark enabled workgroup. The maximum file size that can be imported is 10 megabytes. If an ipynb
file with the same name already exists in the workgroup, throws an error.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportNotebookOutput"
}
}
}
},
"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": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportNotebookInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.ImportNotebook"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.ListApplicationDPUSizes": {
"post": {
"operationId": "ListApplicationDPUSizes",
"description": "Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1
). ",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListApplicationDPUSizesOutput"
}
}
}
},
"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": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListApplicationDPUSizesInput"
}
}
}
},
"parameters": [
{
"name": "MaxResults",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination limit",
"required": false
},
{
"name": "NextToken",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination token",
"required": false
},
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.ListApplicationDPUSizes"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.ListCalculationExecutions": {
"post": {
"operationId": "ListCalculationExecutions",
"description": "Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListCalculationExecutionsResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListCalculationExecutionsRequest"
}
}
}
},
"parameters": [
{
"name": "MaxResults",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination limit",
"required": false
},
{
"name": "NextToken",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination token",
"required": false
},
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.ListCalculationExecutions"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.ListDataCatalogs": {
"post": {
"operationId": "ListDataCatalogs",
"description": "Lists the data catalogs in the current Amazon Web Services account.
In the Athena console, data catalogs are listed as \"data sources\" on the Data sources page under the Data source name column.
Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
", "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" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListNamedQueriesInput" } } } }, "parameters": [ { "name": "MaxResults", "in": "query", "schema": { "type": "string" }, "description": "Pagination limit", "required": false }, { "name": "NextToken", "in": "query", "schema": { "type": "string" }, "description": "Pagination token", "required": false }, { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.ListNamedQueries" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.ListNotebookMetadata": { "post": { "operationId": "ListNotebookMetadata", "description": "Displays the notebook files for the specified workgroup in paginated format.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListNotebookMetadataOutput" } } } }, "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": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListNotebookMetadataInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.ListNotebookMetadata" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.ListNotebookSessions": { "post": { "operationId": "ListNotebookSessions", "description": "Lists, in descending order, the sessions that have been created in a notebook that are in an active state likeCREATING
, CREATED
, IDLE
or BUSY
. Newer sessions are listed first; older sessions are listed later.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListNotebookSessionsResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListNotebookSessionsRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.ListNotebookSessions"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.ListPreparedStatements": {
"post": {
"operationId": "ListPreparedStatements",
"description": "Lists the prepared statements in the specified workgroup.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListPreparedStatementsOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListPreparedStatementsInput"
}
}
}
},
"parameters": [
{
"name": "MaxResults",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination limit",
"required": false
},
{
"name": "NextToken",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination token",
"required": false
},
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.ListPreparedStatements"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.ListQueryExecutions": {
"post": {
"operationId": "ListQueryExecutions",
"description": "Provides a list of available query execution IDs for the queries in the specified workgroup. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
", "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" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListQueryExecutionsInput" } } } }, "parameters": [ { "name": "MaxResults", "in": "query", "schema": { "type": "string" }, "description": "Pagination limit", "required": false }, { "name": "NextToken", "in": "query", "schema": { "type": "string" }, "description": "Pagination token", "required": false }, { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.ListQueryExecutions" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.ListSessions": { "post": { "operationId": "ListSessions", "description": "Lists the sessions in a workgroup that are in an active state likeCREATING
, CREATED
, IDLE
, or BUSY
. Newer sessions are listed first; older sessions are listed later.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListSessionsResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListSessionsRequest"
}
}
}
},
"parameters": [
{
"name": "MaxResults",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination limit",
"required": false
},
{
"name": "NextToken",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination token",
"required": false
},
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.ListSessions"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.ListTableMetadata": {
"post": {
"operationId": "ListTableMetadata",
"description": "Lists the metadata for the tables in the specified data catalog database.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTableMetadataOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "MetadataException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTableMetadataInput"
}
}
}
},
"parameters": [
{
"name": "MaxResults",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination limit",
"required": false
},
{
"name": "NextToken",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination token",
"required": false
},
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.ListTableMetadata"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.ListTagsForResource": {
"post": {
"operationId": "ListTagsForResource",
"description": "Lists the tags associated with an Athena workgroup or data catalog resource.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTagsForResourceOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTagsForResourceInput"
}
}
}
},
"parameters": [
{
"name": "MaxResults",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination limit",
"required": false
},
{
"name": "NextToken",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination token",
"required": false
},
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.ListTagsForResource"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.ListWorkGroups": {
"post": {
"operationId": "ListWorkGroups",
"description": "Lists available workgroups for the account.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListWorkGroupsOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListWorkGroupsInput"
}
}
}
},
"parameters": [
{
"name": "MaxResults",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination limit",
"required": false
},
{
"name": "NextToken",
"in": "query",
"schema": {
"type": "string"
},
"description": "Pagination token",
"required": false
},
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.ListWorkGroups"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.StartCalculationExecution": {
"post": {
"operationId": "StartCalculationExecution",
"description": "Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartCalculationExecutionResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartCalculationExecutionRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.StartCalculationExecution"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.StartQueryExecution": {
"post": {
"operationId": "StartQueryExecution",
"description": "Runs the SQL query statements contained in the Query
. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.",
"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": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartQueryExecutionInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.StartQueryExecution"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.StartSession": {
"post": {
"operationId": "StartSession",
"description": "Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE
state.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartSessionResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
},
"483": {
"description": "SessionAlreadyExistsException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionAlreadyExistsException"
}
}
}
},
"484": {
"description": "TooManyRequestsException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TooManyRequestsException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartSessionRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.StartSession"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.StopCalculationExecution": {
"post": {
"operationId": "StopCalculationExecution",
"description": "Requests the cancellation of a calculation. A StopCalculationExecution
call on a calculation that is already in a terminal state (for example, STOPPED
, FAILED
, or COMPLETED
) succeeds but has no effect.
Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.
Stops a query execution. Requires you to have access to the workgroup in which the query ran.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
", "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": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopQueryExecutionInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.StopQueryExecution" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.TagResource": { "post": { "operationId": "TagResource", "description": "Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResourceOutput" } } } }, "480": { "description": "InternalServerException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerException" } } } }, "481": { "description": "InvalidRequestException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequestException" } } } }, "482": { "description": "ResourceNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResourceInput" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AmazonAthena.TagResource" ] } } ] }, "parameters": [ { "$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" } ] }, "/#X-Amz-Target=AmazonAthena.TerminateSession": { "post": { "operationId": "TerminateSession", "description": "Terminates an active session. ATerminateSession
call on a session that is already inactive (for example, in a FAILED
, TERMINATED
or TERMINATING
state) succeeds but has no effect. Calculations running in the session when TerminateSession
is called are forcefully stopped, but may display as FAILED
instead of STOPPED
.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TerminateSessionResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TerminateSessionRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.TerminateSession"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.UntagResource": {
"post": {
"operationId": "UntagResource",
"description": "Removes one or more tags from a data catalog or workgroup resource.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UntagResourceOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UntagResourceInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.UntagResource"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.UpdateDataCatalog": {
"post": {
"operationId": "UpdateDataCatalog",
"description": "Updates the data catalog that has the specified name.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDataCatalogOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDataCatalogInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.UpdateDataCatalog"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.UpdateNamedQuery": {
"post": {
"operationId": "UpdateNamedQuery",
"description": "Updates a NamedQuery object. The database or workgroup cannot be updated.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateNamedQueryOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateNamedQueryInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.UpdateNamedQuery"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.UpdateNotebook": {
"post": {
"operationId": "UpdateNotebook",
"description": "Updates the contents of a Spark notebook.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateNotebookOutput"
}
}
}
},
"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": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateNotebookInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.UpdateNotebook"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.UpdateNotebookMetadata": {
"post": {
"operationId": "UpdateNotebookMetadata",
"description": "Updates the metadata for a notebook.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateNotebookMetadataOutput"
}
}
}
},
"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": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateNotebookMetadataInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.UpdateNotebookMetadata"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.UpdatePreparedStatement": {
"post": {
"operationId": "UpdatePreparedStatement",
"description": "Updates a prepared statement.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePreparedStatementOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePreparedStatementInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.UpdatePreparedStatement"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
},
"/#X-Amz-Target=AmazonAthena.UpdateWorkGroup": {
"post": {
"operationId": "UpdateWorkGroup",
"description": "Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates
can be specified.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWorkGroupOutput"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWorkGroupInput"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"AmazonAthena.UpdateWorkGroup"
]
}
}
]
},
"parameters": [
{
"$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"
}
]
}
},
"components": {
"parameters": {
"X-Amz-Content-Sha256": {
"name": "X-Amz-Content-Sha256",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Date": {
"name": "X-Amz-Date",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Algorithm": {
"name": "X-Amz-Algorithm",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Credential": {
"name": "X-Amz-Credential",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Security-Token": {
"name": "X-Amz-Security-Token",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Signature": {
"name": "X-Amz-Signature",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-SignedHeaders": {
"name": "X-Amz-SignedHeaders",
"in": "header",
"schema": {
"type": "string"
},
"required": false
}
},
"securitySchemes": {
"hmac": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"description": "Amazon Signature authorization v4",
"x-amazon-apigateway-authtype": "awsSigv4"
}
},
"schemas": {
"BatchGetNamedQueryOutput": {
"type": "object",
"properties": {
"NamedQueries": {
"allOf": [
{
"$ref": "#/components/schemas/NamedQueryList"
},
{
"description": "Information about the named query IDs submitted."
}
]
},
"UnprocessedNamedQueryIds": {
"allOf": [
{
"$ref": "#/components/schemas/UnprocessedNamedQueryIdList"
},
{
"description": "Information about provided query IDs."
}
]
}
}
},
"BatchGetNamedQueryInput": {
"type": "object",
"required": [
"NamedQueryIds"
],
"title": "BatchGetNamedQueryInput",
"properties": {
"NamedQueryIds": {
"allOf": [
{
"$ref": "#/components/schemas/NamedQueryIdList"
},
{
"description": "An array of query IDs."
}
]
}
},
"description": "Contains an array of named query IDs."
},
"InternalServerException": {},
"InvalidRequestException": {},
"BatchGetPreparedStatementOutput": {
"type": "object",
"properties": {
"PreparedStatements": {
"allOf": [
{
"$ref": "#/components/schemas/PreparedStatementDetailsList"
},
{
"description": "The list of prepared statements returned."
}
]
},
"UnprocessedPreparedStatementNames": {
"allOf": [
{
"$ref": "#/components/schemas/UnprocessedPreparedStatementNameList"
},
{
"description": "A list of one or more prepared statements that were requested but could not be returned."
}
]
}
}
},
"BatchGetPreparedStatementInput": {
"type": "object",
"required": [
"PreparedStatementNames",
"WorkGroup"
],
"title": "BatchGetPreparedStatementInput",
"properties": {
"PreparedStatementNames": {
"allOf": [
{
"$ref": "#/components/schemas/PreparedStatementNameList"
},
{
"description": "A list of prepared statement names to return."
}
]
},
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The name of the workgroup to which the prepared statements belong."
}
]
}
}
},
"BatchGetQueryExecutionOutput": {
"type": "object",
"properties": {
"QueryExecutions": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecutionList"
},
{
"description": "Information about a query execution."
}
]
},
"UnprocessedQueryExecutionIds": {
"allOf": [
{
"$ref": "#/components/schemas/UnprocessedQueryExecutionIdList"
},
{
"description": "Information about the query executions that failed to run."
}
]
}
}
},
"BatchGetQueryExecutionInput": {
"type": "object",
"required": [
"QueryExecutionIds"
],
"title": "BatchGetQueryExecutionInput",
"properties": {
"QueryExecutionIds": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecutionIdList"
},
{
"description": "An array of query execution IDs."
}
]
}
},
"description": "Contains an array of query execution IDs."
},
"CreateDataCatalogOutput": {
"type": "object",
"properties": {}
},
"CreateDataCatalogInput": {
"type": "object",
"required": [
"Name",
"Type"
],
"title": "CreateDataCatalogInput",
"properties": {
"Name": {
"allOf": [
{
"$ref": "#/components/schemas/CatalogNameString"
},
{
"description": "The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena."
}
]
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/DataCatalogType"
},
{
"description": "The type of data catalog to create: LAMBDA
for a federated catalog, HIVE
for an external hive metastore, or GLUE
for an Glue Data Catalog."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/DescriptionString"
},
{
"description": "A description of the data catalog to be created."
}
]
},
"Parameters": {
"allOf": [
{
"$ref": "#/components/schemas/ParametersMap"
},
{
"description": "Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
For the HIVE
data catalog type, use the following syntax. The metadata-function
parameter is required. The sdk-version
parameter is optional and defaults to the currently supported version.
metadata-function=lambda_arn, sdk-version=version_number
For the LAMBDA
data catalog type, use one of the following sets of required parameters, but not both.
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
The GLUE
type takes a catalog ID parameter and is required. The catalog_id
is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.
catalog-id=catalog_id
The GLUE
data catalog type also applies to the default AwsDataCatalog
that already exists in your account, of which you can have only one and cannot modify.
Queries that specify a Glue Data Catalog other than the default AwsDataCatalog
must be run on Athena engine version 2.
In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT
error.
A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery
request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString
, an error is returned.
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
ipynb
file to be created in the Spark workgroup, without the .ipynb
extension."
}
]
},
"ClientRequestToken": {
"allOf": [
{
"$ref": "#/components/schemas/ClientRequestToken"
},
{
"description": "A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
EnforceWorkGroupConfiguration
) in the WorkGroupConfiguration
override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupDescriptionString"
},
{
"description": "The workgroup description."
}
]
},
"Tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagList"
},
{
"description": "A list of comma separated tags to add to the workgroup that is created."
}
]
}
}
},
"DeleteDataCatalogOutput": {
"type": "object",
"properties": {}
},
"DeleteDataCatalogInput": {
"type": "object",
"required": [
"Name"
],
"title": "DeleteDataCatalogInput",
"properties": {
"Name": {
"allOf": [
{
"$ref": "#/components/schemas/CatalogNameString"
},
{
"description": "The name of the data catalog to delete."
}
]
}
}
},
"DeleteNamedQueryOutput": {
"type": "object",
"properties": {}
},
"DeleteNamedQueryInput": {
"type": "object",
"required": [
"NamedQueryId"
],
"title": "DeleteNamedQueryInput",
"properties": {
"NamedQueryId": {
"allOf": [
{
"$ref": "#/components/schemas/NamedQueryId"
},
{
"description": "The unique ID of the query to delete."
}
]
}
}
},
"DeleteNotebookOutput": {
"type": "object",
"properties": {}
},
"DeleteNotebookInput": {
"type": "object",
"required": [
"NotebookId"
],
"title": "DeleteNotebookInput",
"properties": {
"NotebookId": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookId"
},
{
"description": "The ID of the notebook to delete."
}
]
}
}
},
"DeletePreparedStatementOutput": {
"type": "object",
"properties": {}
},
"DeletePreparedStatementInput": {
"type": "object",
"required": [
"StatementName",
"WorkGroup"
],
"title": "DeletePreparedStatementInput",
"properties": {
"StatementName": {
"allOf": [
{
"$ref": "#/components/schemas/StatementName"
},
{
"description": "The name of the prepared statement to delete."
}
]
},
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The workgroup to which the statement to be deleted belongs."
}
]
}
}
},
"DeleteWorkGroupOutput": {
"type": "object",
"properties": {}
},
"DeleteWorkGroupInput": {
"type": "object",
"required": [
"WorkGroup"
],
"title": "DeleteWorkGroupInput",
"properties": {
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The unique name of the workgroup to delete."
}
]
},
"RecursiveDeleteOption": {
"allOf": [
{
"$ref": "#/components/schemas/BoxedBoolean"
},
{
"description": "The option to delete the workgroup and its contents even if the workgroup contains any named queries, query executions, or notebooks."
}
]
}
}
},
"ExportNotebookOutput": {
"type": "object",
"properties": {
"NotebookMetadata": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookMetadata"
},
{
"description": "The notebook metadata, including notebook ID, notebook name, and workgroup name."
}
]
},
"Payload": {
"allOf": [
{
"$ref": "#/components/schemas/Payload"
},
{
"description": "The content of the exported notebook."
}
]
}
}
},
"ExportNotebookInput": {
"type": "object",
"required": [
"NotebookId"
],
"title": "ExportNotebookInput",
"properties": {
"NotebookId": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookId"
},
{
"description": "The ID of the notebook to export."
}
]
}
}
},
"GetCalculationExecutionResponse": {
"type": "object",
"properties": {
"CalculationExecutionId": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationExecutionId"
},
{
"description": "The calculation execution UUID."
}
]
},
"SessionId": {
"allOf": [
{
"$ref": "#/components/schemas/SessionId"
},
{
"description": "The session ID that the calculation ran in."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/DescriptionString"
},
{
"description": "The description of the calculation execution."
}
]
},
"WorkingDirectory": {
"allOf": [
{
"$ref": "#/components/schemas/S3Uri"
},
{
"description": "The Amazon S3 location in which calculation results are stored."
}
]
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationStatus"
},
{
"description": "Contains information about the status of the calculation."
}
]
},
"Statistics": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationStatistics"
},
{
"description": "Contains information about the data processing unit (DPU) execution time and progress. This field is populated only when statistics are available."
}
]
},
"Result": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationResult"
},
{
"description": "Contains result information. This field is populated only if the calculation is completed."
}
]
}
}
},
"GetCalculationExecutionRequest": {
"type": "object",
"required": [
"CalculationExecutionId"
],
"title": "GetCalculationExecutionRequest",
"properties": {
"CalculationExecutionId": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationExecutionId"
},
{
"description": "The calculation execution UUID."
}
]
}
}
},
"GetCalculationExecutionCodeResponse": {
"type": "object",
"properties": {
"CodeBlock": {
"allOf": [
{
"$ref": "#/components/schemas/CodeBlock"
},
{
"description": "The unencrypted code that was executed for the calculation."
}
]
}
}
},
"GetCalculationExecutionCodeRequest": {
"type": "object",
"required": [
"CalculationExecutionId"
],
"title": "GetCalculationExecutionCodeRequest",
"properties": {
"CalculationExecutionId": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationExecutionId"
},
{
"description": "The calculation execution UUID."
}
]
}
}
},
"GetCalculationExecutionStatusResponse": {
"type": "object",
"properties": {
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationStatus"
},
{
"description": "Contains information about the calculation execution status."
}
]
},
"Statistics": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationStatistics"
},
{
"description": "Contains information about the DPU execution time and progress."
}
]
}
}
},
"GetCalculationExecutionStatusRequest": {
"type": "object",
"required": [
"CalculationExecutionId"
],
"title": "GetCalculationExecutionStatusRequest",
"properties": {
"CalculationExecutionId": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationExecutionId"
},
{
"description": "The calculation execution UUID."
}
]
}
}
},
"GetDataCatalogOutput": {
"type": "object",
"properties": {
"DataCatalog": {
"allOf": [
{
"$ref": "#/components/schemas/DataCatalog"
},
{
"description": "The data catalog returned."
}
]
}
}
},
"GetDataCatalogInput": {
"type": "object",
"required": [
"Name"
],
"title": "GetDataCatalogInput",
"properties": {
"Name": {
"allOf": [
{
"$ref": "#/components/schemas/CatalogNameString"
},
{
"description": "The name of the data catalog to return."
}
]
}
}
},
"GetDatabaseOutput": {
"type": "object",
"properties": {
"Database": {
"allOf": [
{
"$ref": "#/components/schemas/Database"
},
{
"description": "The database returned."
}
]
}
}
},
"GetDatabaseInput": {
"type": "object",
"required": [
"CatalogName",
"DatabaseName"
],
"title": "GetDatabaseInput",
"properties": {
"CatalogName": {
"allOf": [
{
"$ref": "#/components/schemas/CatalogNameString"
},
{
"description": "The name of the data catalog that contains the database to return."
}
]
},
"DatabaseName": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The name of the database to return."
}
]
}
}
},
"MetadataException": {},
"GetNamedQueryOutput": {
"type": "object",
"properties": {
"NamedQuery": {
"allOf": [
{
"$ref": "#/components/schemas/NamedQuery"
},
{
"description": "Information about the query."
}
]
}
}
},
"GetNamedQueryInput": {
"type": "object",
"required": [
"NamedQueryId"
],
"title": "GetNamedQueryInput",
"properties": {
"NamedQueryId": {
"allOf": [
{
"$ref": "#/components/schemas/NamedQueryId"
},
{
"description": "The unique ID of the query. Use ListNamedQueries to get query IDs."
}
]
}
}
},
"GetNotebookMetadataOutput": {
"type": "object",
"properties": {
"NotebookMetadata": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookMetadata"
},
{
"description": "The metadata that is returned for the specified notebook ID."
}
]
}
}
},
"GetNotebookMetadataInput": {
"type": "object",
"required": [
"NotebookId"
],
"title": "GetNotebookMetadataInput",
"properties": {
"NotebookId": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookId"
},
{
"description": "The ID of the notebook whose metadata is to be retrieved."
}
]
}
}
},
"GetPreparedStatementOutput": {
"type": "object",
"properties": {
"PreparedStatement": {
"allOf": [
{
"$ref": "#/components/schemas/PreparedStatement"
},
{
"description": "The name of the prepared statement that was retrieved."
}
]
}
}
},
"GetPreparedStatementInput": {
"type": "object",
"required": [
"StatementName",
"WorkGroup"
],
"title": "GetPreparedStatementInput",
"properties": {
"StatementName": {
"allOf": [
{
"$ref": "#/components/schemas/StatementName"
},
{
"description": "The name of the prepared statement to retrieve."
}
]
},
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The workgroup to which the statement to be retrieved belongs."
}
]
}
}
},
"GetQueryExecutionOutput": {
"type": "object",
"properties": {
"QueryExecution": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecution"
},
{
"description": "Information about the query execution."
}
]
}
}
},
"GetQueryExecutionInput": {
"type": "object",
"required": [
"QueryExecutionId"
],
"title": "GetQueryExecutionInput",
"properties": {
"QueryExecutionId": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecutionId"
},
{
"description": "The unique ID of the query execution."
}
]
}
}
},
"GetQueryResultsOutput": {
"type": "object",
"properties": {
"UpdateCount": {
"allOf": [
{
"$ref": "#/components/schemas/Long"
},
{
"description": "The number of rows inserted with a CREATE TABLE AS SELECT
statement. "
}
]
},
"ResultSet": {
"allOf": [
{
"$ref": "#/components/schemas/ResultSet"
},
{
"description": "The results of the query execution."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
}
}
},
"GetQueryResultsInput": {
"type": "object",
"required": [
"QueryExecutionId"
],
"title": "GetQueryResultsInput",
"properties": {
"QueryExecutionId": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecutionId"
},
{
"description": "The unique ID of the query execution."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxQueryResults"
},
{
"description": "The maximum number of results (rows) to return in this request."
}
]
}
}
},
"GetQueryRuntimeStatisticsOutput": {
"type": "object",
"properties": {
"QueryRuntimeStatistics": {
"allOf": [
{
"$ref": "#/components/schemas/QueryRuntimeStatistics"
},
{
"description": "Runtime statistics about the query execution."
}
]
}
}
},
"GetQueryRuntimeStatisticsInput": {
"type": "object",
"required": [
"QueryExecutionId"
],
"title": "GetQueryRuntimeStatisticsInput",
"properties": {
"QueryExecutionId": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecutionId"
},
{
"description": "The unique ID of the query execution."
}
]
}
}
},
"GetSessionResponse": {
"type": "object",
"properties": {
"SessionId": {
"allOf": [
{
"$ref": "#/components/schemas/SessionId"
},
{
"description": "The session ID."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/DescriptionString"
},
{
"description": "The session description."
}
]
},
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The workgroup to which the session belongs."
}
]
},
"EngineVersion": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The engine version used by the session (for example, PySpark engine version 3
). You can get a list of engine versions by calling ListEngineVersions."
}
]
},
"EngineConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/EngineConfiguration"
},
{
"description": "Contains engine configuration information like DPU usage."
}
]
},
"NotebookVersion": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The notebook version."
}
]
},
"SessionConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/SessionConfiguration"
},
{
"description": "Contains the workgroup configuration information used by the session."
}
]
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/SessionStatus"
},
{
"description": "Contains information about the status of the session."
}
]
},
"Statistics": {
"allOf": [
{
"$ref": "#/components/schemas/SessionStatistics"
},
{
"description": "Contains the DPU execution time."
}
]
}
}
},
"GetSessionRequest": {
"type": "object",
"required": [
"SessionId"
],
"title": "GetSessionRequest",
"properties": {
"SessionId": {
"allOf": [
{
"$ref": "#/components/schemas/SessionId"
},
{
"description": "The session ID."
}
]
}
}
},
"GetSessionStatusResponse": {
"type": "object",
"properties": {
"SessionId": {
"allOf": [
{
"$ref": "#/components/schemas/SessionId"
},
{
"description": "The session ID."
}
]
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/SessionStatus"
},
{
"description": "Contains information about the status of the session."
}
]
}
}
},
"GetSessionStatusRequest": {
"type": "object",
"required": [
"SessionId"
],
"title": "GetSessionStatusRequest",
"properties": {
"SessionId": {
"allOf": [
{
"$ref": "#/components/schemas/SessionId"
},
{
"description": "The session ID."
}
]
}
}
},
"GetTableMetadataOutput": {
"type": "object",
"properties": {
"TableMetadata": {
"allOf": [
{
"$ref": "#/components/schemas/TableMetadata"
},
{
"description": "An object that contains table metadata."
}
]
}
}
},
"GetTableMetadataInput": {
"type": "object",
"required": [
"CatalogName",
"DatabaseName",
"TableName"
],
"title": "GetTableMetadataInput",
"properties": {
"CatalogName": {
"allOf": [
{
"$ref": "#/components/schemas/CatalogNameString"
},
{
"description": "The name of the data catalog that contains the database and table metadata to return."
}
]
},
"DatabaseName": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The name of the database that contains the table metadata to return."
}
]
},
"TableName": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The name of the table for which metadata is returned."
}
]
}
}
},
"GetWorkGroupOutput": {
"type": "object",
"properties": {
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroup"
},
{
"description": "Information about the workgroup."
}
]
}
}
},
"GetWorkGroupInput": {
"type": "object",
"required": [
"WorkGroup"
],
"title": "GetWorkGroupInput",
"properties": {
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The name of the workgroup."
}
]
}
}
},
"ImportNotebookOutput": {
"type": "object",
"properties": {
"NotebookId": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookId"
},
{
"description": "The ID assigned to the imported notebook."
}
]
}
}
},
"ImportNotebookInput": {
"type": "object",
"required": [
"WorkGroup",
"Name",
"Payload",
"Type"
],
"title": "ImportNotebookInput",
"properties": {
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The name of the Spark enabled workgroup to import the notebook to."
}
]
},
"Name": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookName"
},
{
"description": "The name of the notebook to import."
}
]
},
"Payload": {
"allOf": [
{
"$ref": "#/components/schemas/Payload"
},
{
"description": "The notebook content to be imported."
}
]
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookType"
},
{
"description": "The notebook content type. Currently, the only valid type is IPYNB
."
}
]
},
"ClientRequestToken": {
"allOf": [
{
"$ref": "#/components/schemas/ClientRequestToken"
},
{
"description": "A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only once).
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
NextToken
from the response object of the previous page call."
}
]
}
}
},
"ListApplicationDPUSizesInput": {
"type": "object",
"title": "ListApplicationDPUSizesInput",
"properties": {
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxApplicationDPUSizesCount"
},
{
"description": "Specifies the maximum number of results to return."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated."
}
]
}
}
},
"ListCalculationExecutionsResponse": {
"type": "object",
"properties": {
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/SessionManagerToken"
},
{
"description": "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."
}
]
},
"Calculations": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationsList"
},
{
"description": "A list of CalculationSummary objects."
}
]
}
}
},
"ListCalculationExecutionsRequest": {
"type": "object",
"required": [
"SessionId"
],
"title": "ListCalculationExecutionsRequest",
"properties": {
"SessionId": {
"allOf": [
{
"$ref": "#/components/schemas/SessionId"
},
{
"description": "The session ID."
}
]
},
"StateFilter": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationExecutionState"
},
{
"description": "A filter for a specific calculation execution state. A description of each state follows.
CREATING
- The calculation is in the process of being created.
CREATED
- The calculation has been created and is ready to run.
QUEUED
- The calculation has been queued for processing.
RUNNING
- The calculation is running.
CANCELING
- A request to cancel the calculation has been received and the system is working to stop it.
CANCELED
- The calculation is no longer running as the result of a cancel request.
COMPLETED
- The calculation has completed without error.
FAILED
- The calculation failed and is no longer running.
NextToken
from the response object of the previous page call."
}
]
}
}
},
"ListDataCatalogsOutput": {
"type": "object",
"properties": {
"DataCatalogsSummary": {
"allOf": [
{
"$ref": "#/components/schemas/DataCatalogSummaryList"
},
{
"description": "A summary list of data catalogs."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
}
}
},
"ListDataCatalogsInput": {
"type": "object",
"title": "ListDataCatalogsInput",
"properties": {
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxDataCatalogsCount"
},
{
"description": "Specifies the maximum number of data catalogs to return."
}
]
}
}
},
"ListDatabasesOutput": {
"type": "object",
"properties": {
"DatabaseList": {
"allOf": [
{
"$ref": "#/components/schemas/DatabaseList"
},
{
"description": "A list of databases from a data catalog."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
}
}
},
"ListDatabasesInput": {
"type": "object",
"required": [
"CatalogName"
],
"title": "ListDatabasesInput",
"properties": {
"CatalogName": {
"allOf": [
{
"$ref": "#/components/schemas/CatalogNameString"
},
{
"description": "The name of the data catalog that contains the databases to return."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxDatabasesCount"
},
{
"description": "Specifies the maximum number of results to return."
}
]
}
}
},
"ListEngineVersionsOutput": {
"type": "object",
"properties": {
"EngineVersions": {
"allOf": [
{
"$ref": "#/components/schemas/EngineVersionsList"
},
{
"description": "A list of engine versions that are available to choose from."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
}
}
},
"ListEngineVersionsInput": {
"type": "object",
"title": "ListEngineVersionsInput",
"properties": {
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxEngineVersionsCount"
},
{
"description": "The maximum number of engine versions to return in this request."
}
]
}
}
},
"ListExecutorsResponse": {
"type": "object",
"required": [
"SessionId"
],
"properties": {
"SessionId": {
"allOf": [
{
"$ref": "#/components/schemas/SessionId"
},
{
"description": "The session ID."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/SessionManagerToken"
},
{
"description": "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."
}
]
},
"ExecutorsSummary": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutorsSummaryList"
},
{
"description": "Contains summary information about the executor."
}
]
}
}
},
"ListExecutorsRequest": {
"type": "object",
"required": [
"SessionId"
],
"title": "ListExecutorsRequest",
"properties": {
"SessionId": {
"allOf": [
{
"$ref": "#/components/schemas/SessionId"
},
{
"description": "The session ID."
}
]
},
"ExecutorStateFilter": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutorState"
},
{
"description": "A filter for a specific executor state. A description of each state follows.
CREATING
- The executor is being started, including acquiring resources.
CREATED
- The executor has been started.
REGISTERED
- The executor has been registered.
TERMINATING
- The executor is in the process of shutting down.
TERMINATED
- The executor is no longer running.
FAILED
- Due to a failure, the executor is no longer running.
NextToken
from the response object of the previous page call."
}
]
}
}
},
"ListNamedQueriesOutput": {
"type": "object",
"properties": {
"NamedQueryIds": {
"allOf": [
{
"$ref": "#/components/schemas/NamedQueryIdList"
},
{
"description": "The list of unique query IDs."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
}
}
},
"ListNamedQueriesInput": {
"type": "object",
"title": "ListNamedQueriesInput",
"properties": {
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxNamedQueriesCount"
},
{
"description": "The maximum number of queries to return in this request."
}
]
},
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned."
}
]
}
}
},
"ListNotebookMetadataOutput": {
"type": "object",
"properties": {
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
},
"NotebookMetadataList": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookMetadataArray"
},
{
"description": "The list of notebook metadata for the specified workgroup."
}
]
}
}
},
"ListNotebookMetadataInput": {
"type": "object",
"required": [
"WorkGroup"
],
"title": "ListNotebookMetadataInput",
"properties": {
"Filters": {
"allOf": [
{
"$ref": "#/components/schemas/FilterDefinition"
},
{
"description": "Search filter string."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxNotebooksCount"
},
{
"description": "Specifies the maximum number of results to return."
}
]
},
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The name of the Spark enabled workgroup to retrieve notebook metadata for."
}
]
}
}
},
"ListNotebookSessionsResponse": {
"type": "object",
"required": [
"NotebookSessionsList"
],
"properties": {
"NotebookSessionsList": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookSessionsList"
},
{
"description": "A list of the sessions belonging to the notebook."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
}
}
},
"ListNotebookSessionsRequest": {
"type": "object",
"required": [
"NotebookId"
],
"title": "ListNotebookSessionsRequest",
"properties": {
"NotebookId": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookId"
},
{
"description": "The ID of the notebook to list sessions for."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxSessionsCount"
},
{
"description": "The maximum number of notebook sessions to return."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
}
}
},
"ListPreparedStatementsOutput": {
"type": "object",
"properties": {
"PreparedStatements": {
"allOf": [
{
"$ref": "#/components/schemas/PreparedStatementsList"
},
{
"description": "The list of prepared statements for the workgroup."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
}
}
},
"ListPreparedStatementsInput": {
"type": "object",
"required": [
"WorkGroup"
],
"title": "ListPreparedStatementsInput",
"properties": {
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The workgroup to list the prepared statements for."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxPreparedStatementsCount"
},
{
"description": "The maximum number of results to return in this request."
}
]
}
}
},
"ListQueryExecutionsOutput": {
"type": "object",
"properties": {
"QueryExecutionIds": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecutionIdList"
},
{
"description": "The unique IDs of each query execution as an array of strings."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "A token to be used by the next request if this request is truncated."
}
]
}
}
},
"ListQueryExecutionsInput": {
"type": "object",
"title": "ListQueryExecutionsInput",
"properties": {
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxQueryExecutionsCount"
},
{
"description": "The maximum number of query executions to return in this request."
}
]
},
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The name of the workgroup from which queries are being returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned."
}
]
}
}
},
"ListSessionsResponse": {
"type": "object",
"properties": {
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/SessionManagerToken"
},
{
"description": "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."
}
]
},
"Sessions": {
"allOf": [
{
"$ref": "#/components/schemas/SessionsList"
},
{
"description": "A list of sessions."
}
]
}
}
},
"ListSessionsRequest": {
"type": "object",
"required": [
"WorkGroup"
],
"title": "ListSessionsRequest",
"properties": {
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The workgroup to which the session belongs."
}
]
},
"StateFilter": {
"allOf": [
{
"$ref": "#/components/schemas/SessionState"
},
{
"description": "A filter for a specific session state. A description of each state follows.
CREATING
- The session is being started, including acquiring resources.
CREATED
- The session has been started.
IDLE
- The session is able to accept a calculation.
BUSY
- The session is processing another task and is unable to accept a calculation.
TERMINATING
- The session is in the process of shutting down.
TERMINATED
- The session and its resources are no longer running.
DEGRADED
- The session has no healthy coordinators.
FAILED
- Due to a failure, the session and its resources are no longer running.
NextToken
from the response object of the previous page call."
}
]
}
}
},
"ListTableMetadataOutput": {
"type": "object",
"properties": {
"TableMetadataList": {
"allOf": [
{
"$ref": "#/components/schemas/TableMetadataList"
},
{
"description": "A list of table metadata."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
}
}
},
"ListTableMetadataInput": {
"type": "object",
"required": [
"CatalogName",
"DatabaseName"
],
"title": "ListTableMetadataInput",
"properties": {
"CatalogName": {
"allOf": [
{
"$ref": "#/components/schemas/CatalogNameString"
},
{
"description": "The name of the data catalog for which table metadata should be returned."
}
]
},
"DatabaseName": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The name of the database for which table metadata should be returned."
}
]
},
"Expression": {
"allOf": [
{
"$ref": "#/components/schemas/ExpressionString"
},
{
"description": "A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxTableMetadataCount"
},
{
"description": "Specifies the maximum number of results to return."
}
]
}
}
},
"ListTagsForResourceOutput": {
"type": "object",
"properties": {
"Tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagList"
},
{
"description": "The list of tags associated with the specified resource."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "A token to be used by the next request if this request is truncated."
}
]
}
}
},
"ListTagsForResourceInput": {
"type": "object",
"required": [
"ResourceARN"
],
"title": "ListTagsForResourceInput",
"properties": {
"ResourceARN": {
"allOf": [
{
"$ref": "#/components/schemas/AmazonResourceName"
},
{
"description": "Lists the tags for the resource with the specified ARN."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the resource with the specified ARN."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxTagsCount"
},
{
"description": "The maximum number of results to be returned per request that lists the tags for the resource."
}
]
}
}
},
"ListWorkGroupsOutput": {
"type": "object",
"properties": {
"WorkGroups": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupsList"
},
{
"description": "A list of WorkGroupSummary objects that include the names, descriptions, creation times, and states for each workgroup."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
}
}
},
"ListWorkGroupsInput": {
"type": "object",
"title": "ListWorkGroupsInput",
"properties": {
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/Token"
},
{
"description": "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."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxWorkGroupsCount"
},
{
"description": "The maximum number of workgroups to return in this request."
}
]
}
}
},
"StartCalculationExecutionResponse": {
"type": "object",
"properties": {
"CalculationExecutionId": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationExecutionId"
},
{
"description": "The calculation execution UUID."
}
]
},
"State": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationExecutionState"
},
{
"description": " CREATING
- The calculation is in the process of being created.
CREATED
- The calculation has been created and is ready to run.
QUEUED
- The calculation has been queued for processing.
RUNNING
- The calculation is running.
CANCELING
- A request to cancel the calculation has been received and the system is working to stop it.
CANCELED
- The calculation is no longer running as the result of a cancel request.
COMPLETED
- The calculation has completed without error.
FAILED
- The calculation failed and is no longer running.
A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another StartCalculationExecutionRequest
is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution
request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString
, an error is returned.
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
The state of the session. A description of each state follows.
CREATING
- The session is being started, including acquiring resources.
CREATED
- The session has been started.
IDLE
- The session is able to accept a calculation.
BUSY
- The session is processing another task and is unable to accept a calculation.
TERMINATING
- The session is in the process of shutting down.
TERMINATED
- The session and its resources are no longer running.
DEGRADED
- The session has no healthy coordinators.
FAILED
- Due to a failure, the session and its resources are no longer running.
Athena notebook version 1
. If you specify a value for NotebookVersion
, you must also specify a value for NotebookId
. See EngineConfiguration$AdditionalConfigs."
}
]
},
"SessionIdleTimeoutInMinutes": {
"allOf": [
{
"$ref": "#/components/schemas/SessionIdleTimeoutInMinutes"
},
{
"description": "The idle timeout in minutes for the session."
}
]
},
"ClientRequestToken": {
"allOf": [
{
"$ref": "#/components/schemas/IdempotencyToken"
},
{
"description": "A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest
is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
CREATING
- The calculation is in the process of being created.
CREATED
- The calculation has been created and is ready to run.
QUEUED
- The calculation has been queued for processing.
RUNNING
- The calculation is running.
CANCELING
- A request to cancel the calculation has been received and the system is working to stop it.
CANCELED
- The calculation is no longer running as the result of a cancel request.
COMPLETED
- The calculation has completed without error.
FAILED
- The calculation failed and is no longer running.
The state of the session. A description of each state follows.
CREATING
- The session is being started, including acquiring resources.
CREATED
- The session has been started.
IDLE
- The session is able to accept a calculation.
BUSY
- The session is processing another task and is unable to accept a calculation.
TERMINATING
- The session is in the process of shutting down.
TERMINATED
- The session and its resources are no longer running.
DEGRADED
- The session has no healthy coordinators.
FAILED
- Due to a failure, the session and its resources are no longer running.
LAMBDA
for a federated catalog, HIVE
for an external hive metastore, or GLUE
for an Glue Data Catalog."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/DescriptionString"
},
{
"description": "New or modified text that describes the data catalog."
}
]
},
"Parameters": {
"allOf": [
{
"$ref": "#/components/schemas/ParametersMap"
},
{
"description": "Specifies the Lambda function or functions to use for updating the data catalog. This is a mapping whose values depend on the catalog type.
For the HIVE
data catalog type, use the following syntax. The metadata-function
parameter is required. The sdk-version
parameter is optional and defaults to the currently supported version.
metadata-function=lambda_arn, sdk-version=version_number
For the LAMBDA
data catalog type, use one of the following sets of required parameters, but not both.
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
IPYNB
."
}
]
},
"SessionId": {
"allOf": [
{
"$ref": "#/components/schemas/SessionId"
},
{
"description": "The active notebook session ID. Required if the notebook has an active session."
}
]
},
"ClientRequestToken": {
"allOf": [
{
"$ref": "#/components/schemas/ClientRequestToken"
},
{
"description": "A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
BUCKET_OWNER_FULL_CONTROL
. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide."
}
]
}
},
"description": "Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. When Athena stores query results in Amazon S3, the canned ACL is set with the x-amz-acl
request header. For more information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User Guide."
},
"Age": {
"type": "integer",
"minimum": 0,
"maximum": 10080
},
"AmazonResourceName": {
"type": "string",
"minLength": 1,
"maxLength": 1011
},
"NameString": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"SupportedDPUSizeList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Integer"
}
},
"ApplicationDPUSizes": {
"type": "object",
"properties": {
"ApplicationRuntimeId": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The name of the supported application runtime (for example, Athena notebook version 1
)."
}
]
},
"SupportedDPUSizes": {
"allOf": [
{
"$ref": "#/components/schemas/SupportedDPUSizeList"
},
{
"description": "A list of the supported DPU sizes that the application runtime supports."
}
]
}
},
"description": "Contains the application runtime IDs and their supported DPU sizes."
},
"ApplicationDPUSizesList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationDPUSizes"
}
},
"ErrorCategory": {
"type": "integer",
"minimum": 1,
"maximum": 3
},
"ErrorType": {
"type": "integer",
"minimum": 0,
"maximum": 9999
},
"Boolean": {
"type": "boolean"
},
"String": {
"type": "string"
},
"AthenaError": {
"type": "object",
"properties": {
"ErrorCategory": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorCategory"
},
{
"description": "An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.
1 - System
2 - User
3 - Other
" } ] }, "ErrorType": { "allOf": [ { "$ref": "#/components/schemas/ErrorType" }, { "description": "An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide." } ] }, "Retryable": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "True if the query might succeed if resubmitted." } ] }, "ErrorMessage": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "Contains a short description of the error that occurred." } ] } }, "description": "Provides information about an Athena query error. TheAthenaError
feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. AthenaError
includes an ErrorCategory
field that specifies whether the cause of the failed query is due to system error, user error, or other error."
},
"AuthToken": {
"type": "string",
"maxLength": 2048
},
"AwsAccountId": {
"type": "string",
"pattern": "^[0-9]+$",
"minLength": 12,
"maxLength": 12
},
"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"
}
},
"PreparedStatementNameList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatementName"
}
},
"WorkGroupName": {
"type": "string",
"pattern": "[a-zA-Z0-9._-]{1,128}"
},
"PreparedStatementDetailsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreparedStatement"
}
},
"UnprocessedPreparedStatementNameList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UnprocessedPreparedStatementName"
}
},
"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"
}
},
"BoxedBoolean": {
"type": "boolean"
},
"BytesScannedCutoffValue": {
"type": "integer",
"minimum": 10000000
},
"CodeBlock": {
"type": "string",
"maxLength": 68000
},
"CalculationConfiguration": {
"type": "object",
"properties": {
"CodeBlock": {
"allOf": [
{
"$ref": "#/components/schemas/CodeBlock"
},
{
"description": "A string that contains the code for the calculation."
}
]
}
},
"description": "Contains configuration information for the calculation."
},
"CalculationExecutionId": {
"type": "string",
"minLength": 1,
"maxLength": 36
},
"CalculationExecutionState": {
"type": "string",
"enum": [
"CREATING",
"CREATED",
"QUEUED",
"RUNNING",
"CANCELING",
"CANCELED",
"COMPLETED",
"FAILED"
]
},
"S3Uri": {
"type": "string",
"pattern": "^(https|s3|S3)://([^/]+)/?(.*)$",
"maxLength": 1024
},
"CalculationResultType": {
"type": "string",
"pattern": "\\w+\\/[-+.\\w]+",
"minLength": 1,
"maxLength": 256
},
"CalculationResult": {
"type": "object",
"properties": {
"StdOutS3Uri": {
"allOf": [
{
"$ref": "#/components/schemas/S3Uri"
},
{
"description": "The Amazon S3 location of the stdout
file for the calculation."
}
]
},
"StdErrorS3Uri": {
"allOf": [
{
"$ref": "#/components/schemas/S3Uri"
},
{
"description": "The Amazon S3 location of the stderr
error messages file for the calculation."
}
]
},
"ResultS3Uri": {
"allOf": [
{
"$ref": "#/components/schemas/S3Uri"
},
{
"description": "The Amazon S3 location of the folder for the calculation results."
}
]
},
"ResultType": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationResultType"
},
{
"description": "The data format of the calculation result."
}
]
}
},
"description": "Contains information about an application-specific calculation result."
},
"Long": {
"type": "integer"
},
"DescriptionString": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"CalculationStatistics": {
"type": "object",
"properties": {
"DpuExecutionInMillis": {
"allOf": [
{
"$ref": "#/components/schemas/Long"
},
{
"description": "The data processing unit execution time in milliseconds for the calculation."
}
]
},
"Progress": {
"allOf": [
{
"$ref": "#/components/schemas/DescriptionString"
},
{
"description": "The progress of the calculation."
}
]
}
},
"description": "Contains statistics for a notebook calculation."
},
"Date": {
"type": "string",
"format": "date-time"
},
"CalculationStatus": {
"type": "object",
"properties": {
"SubmissionDateTime": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The date and time the calculation was submitted for processing."
}
]
},
"CompletionDateTime": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The date and time the calculation completed processing."
}
]
},
"State": {
"allOf": [
{
"$ref": "#/components/schemas/CalculationExecutionState"
},
{
"description": "The state of the calculation execution. A description of each state follows.
CREATING
- The calculation is in the process of being created.
CREATED
- The calculation has been created and is ready to run.
QUEUED
- The calculation has been queued for processing.
RUNNING
- The calculation is running.
CANCELING
- A request to cancel the calculation has been received and the system is working to stop it.
CANCELED
- The calculation is no longer running as the result of a cancel request.
COMPLETED
- The calculation has completed without error.
FAILED
- The calculation failed and is no longer running.
DECIMAL
data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits."
}
]
},
"Scale": {
"allOf": [
{
"$ref": "#/components/schemas/Integer"
},
{
"description": "For DECIMAL
data types, specifies the total number of digits in the fractional part of the value. Defaults to 0."
}
]
},
"Nullable": {
"allOf": [
{
"$ref": "#/components/schemas/ColumnNullable"
},
{
"description": "Indicates the column's nullable status."
}
]
},
"CaseSensitive": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "Indicates whether values in the column are case-sensitive."
}
]
}
},
"description": "Information about the columns in a query execution result."
},
"ColumnInfoList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ColumnInfo"
}
},
"ColumnList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Column"
}
},
"CoordinatorDpuSize": {
"type": "integer",
"minimum": 1,
"maximum": 1
},
"DataCatalogType": {
"type": "string",
"enum": [
"LAMBDA",
"GLUE",
"HIVE"
]
},
"ParametersMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ParametersMapValue"
}
},
"TagList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
},
"DatabaseString": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"QueryString": {
"type": "string",
"minLength": 1,
"maxLength": 262144
},
"IdempotencyToken": {
"type": "string",
"minLength": 32,
"maxLength": 128
},
"NamedQueryId": {
"type": "string",
"pattern": "\\S+",
"minLength": 1,
"maxLength": 128
},
"NotebookName": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"x-pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]\\+"
},
"NotebookId": {
"type": "string",
"pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
"minLength": 1,
"maxLength": 36
},
"StatementName": {
"type": "string",
"pattern": "[a-zA-Z_][a-zA-Z0-9_@:]{1,256}",
"minLength": 1,
"maxLength": 256
},
"SessionId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"WorkGroupConfiguration": {
"type": "object",
"properties": {
"ResultConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/ResultConfiguration"
},
{
"description": "The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Working with query results, recent queries, and output files."
}
]
},
"EnforceWorkGroupConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/BoxedBoolean"
},
{
"description": "If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings."
}
]
},
"PublishCloudWatchMetricsEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/BoxedBoolean"
},
{
"description": "Indicates that the Amazon CloudWatch metrics are enabled for the workgroup."
}
]
},
"BytesScannedCutoffPerQuery": {
"allOf": [
{
"$ref": "#/components/schemas/BytesScannedCutoffValue"
},
{
"description": "The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan."
}
]
},
"RequesterPaysEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/BoxedBoolean"
},
{
"description": "If set to true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false
, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false
. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide."
}
]
},
"EngineVersion": {
"allOf": [
{
"$ref": "#/components/schemas/EngineVersion"
},
{
"description": "The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality
workgroup run on the preview engine regardless of this setting."
}
]
},
"AdditionalConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "Specifies a user defined JSON string that is passed to the notebook engine."
}
]
},
"ExecutionRole": {
"allOf": [
{
"$ref": "#/components/schemas/RoleArn"
},
{
"description": "Role used in a session for accessing the user's resources."
}
]
},
"CustomerContentEncryptionConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/CustomerContentEncryptionConfiguration"
},
{
"description": "Specifies the KMS key that is used to encrypt the user's data stores in Athena."
}
]
},
"EnableMinimumEncryptionConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/BoxedBoolean"
},
{
"description": "Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries.
The EnforceWorkGroupConfiguration
setting takes precedence over the EnableMinimumEncryptionConfiguration
flag. This means that if EnforceWorkGroupConfiguration
is true, the EnableMinimumEncryptionConfiguration
flag is ignored, and the workgroup configuration for encryption is used.
EnforceWorkGroupConfiguration
(true/false) in the WorkGroupConfiguration
. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. "
},
"WorkGroupDescriptionString": {
"type": "string",
"minLength": 0,
"maxLength": 1024
},
"KmsKey": {
"type": "string",
"pattern": "^arn:aws[a-z\\-]*:kms:([a-z0-9\\-]+):\\d{12}:key/?[a-zA-Z_0-9+=,.@\\-_/]+$|^arn:aws[a-z\\-]*:kms:([a-z0-9\\-]+):\\d{12}:alias/?[a-zA-Z_0-9+=,.@\\-_/]+$|^alias/[a-zA-Z0-9/_-]+$|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
"minLength": 1,
"maxLength": 2048
},
"CustomerContentEncryptionConfiguration": {
"type": "object",
"required": [
"KmsKey"
],
"properties": {
"KmsKey": {
"allOf": [
{
"$ref": "#/components/schemas/KmsKey"
},
{
"description": "The KMS key that is used to encrypt the user's data stores in Athena."
}
]
}
},
"description": "Specifies the KMS key that is used to encrypt the user's data stores in Athena."
},
"DataCatalog": {
"type": "object",
"required": [
"Name",
"Type"
],
"properties": {
"Name": {
"allOf": [
{
"$ref": "#/components/schemas/CatalogNameString"
},
{
"description": "The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/DescriptionString"
},
{
"description": "An optional description of the data catalog."
}
]
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/DataCatalogType"
},
{
"description": "The type of data catalog to create: LAMBDA
for a federated catalog, HIVE
for an external hive metastore, or GLUE
for an Glue Data Catalog."
}
]
},
"Parameters": {
"allOf": [
{
"$ref": "#/components/schemas/ParametersMap"
},
{
"description": "Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type.
For the HIVE
data catalog type, use the following syntax. The metadata-function
parameter is required. The sdk-version
parameter is optional and defaults to the currently supported version.
metadata-function=lambda_arn, sdk-version=version_number
For the LAMBDA
data catalog type, use one of the following sets of required parameters, but not both.
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
The GLUE
type takes a catalog ID parameter and is required. The catalog_id
is the account ID of the Amazon Web Services account to which the Glue catalog belongs.
catalog-id=catalog_id
The GLUE
data catalog type also applies to the default AwsDataCatalog
that already exists in your account, of which you can have only one and cannot modify.
Queries that specify a Glue Data Catalog other than the default AwsDataCatalog
must be run on Athena engine version 2.
Contains information about a data catalog in an Amazon Web Services account.
In the Athena console, data catalogs are listed as \"data sources\" on the Data sources page under the Data source name column.
Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3
), server-side encryption with KMS-managed keys (SSE_KMS
), or client-side encryption with KMS-managed keys (CSE_KMS
) is used.
If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
" } ] }, "KmsKey": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "ForSSE_KMS
and CSE_KMS
, this is the KMS key ARN or ID."
}
]
}
},
"description": "If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS
or CSE_KMS
) and key information."
},
"MaxConcurrentDpus": {
"type": "integer",
"minimum": 2,
"maximum": 5000
},
"EngineConfiguration": {
"type": "object",
"required": [
"MaxConcurrentDpus"
],
"properties": {
"CoordinatorDpuSize": {
"allOf": [
{
"$ref": "#/components/schemas/CoordinatorDpuSize"
},
{
"description": "The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session."
}
]
},
"MaxConcurrentDpus": {
"allOf": [
{
"$ref": "#/components/schemas/MaxConcurrentDpus"
},
{
"description": "The maximum number of DPUs that can run concurrently."
}
]
},
"DefaultExecutorDpuSize": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultExecutorDpuSize"
},
{
"description": "The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena."
}
]
},
"AdditionalConfigs": {
"allOf": [
{
"$ref": "#/components/schemas/ParametersMap"
},
{
"description": "Contains additional notebook engine MAP<string, string>
parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId
to AdditionalConfigs
that has the value of the Athena notebook ID."
}
]
}
},
"description": "Contains data processing unit (DPU) configuration settings and parameter mappings for a notebook engine."
},
"EngineVersion": {
"type": "object",
"properties": {
"SelectedEngineVersion": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The engine version requested by the user. Possible values are determined by the output of ListEngineVersions
, including AUTO. The default is AUTO."
}
]
},
"EffectiveEngineVersion": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup
or UpdateWorkGroup
operation, the EffectiveEngineVersion
field is ignored."
}
]
}
},
"description": "The Athena engine version for running queries, or the PySpark engine version for running sessions."
},
"EngineVersionsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EngineVersion"
},
"minItems": 0,
"maxItems": 10
},
"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"
},
"ExecutionParameter": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"ExecutionParameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExecutionParameter"
},
"minItems": 1
},
"ExecutorId": {
"type": "string",
"pattern": ".*",
"maxLength": 100000
},
"ExecutorState": {
"type": "string",
"enum": [
"CREATING",
"CREATED",
"REGISTERED",
"TERMINATING",
"TERMINATED",
"FAILED"
]
},
"ExecutorType": {
"type": "string",
"enum": [
"COORDINATOR",
"GATEWAY",
"WORKER"
]
},
"ExecutorsSummary": {
"type": "object",
"required": [
"ExecutorId"
],
"properties": {
"ExecutorId": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutorId"
},
{
"description": "The UUID of the executor."
}
]
},
"ExecutorType": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutorType"
},
{
"description": "The type of executor used for the application (COORDINATOR
, GATEWAY
, or WORKER
)."
}
]
},
"StartDateTime": {
"allOf": [
{
"$ref": "#/components/schemas/Long"
},
{
"description": "The date and time that the executor started."
}
]
},
"TerminationDateTime": {
"allOf": [
{
"$ref": "#/components/schemas/Long"
},
{
"description": "The date and time that the executor was terminated."
}
]
},
"ExecutorState": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutorState"
},
{
"description": "The processing state of the executor. A description of each state follows.
CREATING
- The executor is being started, including acquiring resources.
CREATED
- The executor has been started.
REGISTERED
- The executor has been registered.
TERMINATING
- The executor is in the process of shutting down.
TERMINATED
- The executor is no longer running.
FAILED
- Due to a failure, the executor is no longer running.
IPYNB
."
}
]
},
"LastModifiedTime": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The time when the notebook was last modified."
}
]
}
},
"description": "Contains metadata for notebook, including the notebook name, ID, workgroup, and time created."
},
"Payload": {
"type": "string",
"minLength": 1,
"maxLength": 10485760
},
"ExpressionString": {
"type": "string",
"minLength": 0,
"maxLength": 256
},
"FilterDefinition": {
"type": "object",
"properties": {
"Name": {
"allOf": [
{
"$ref": "#/components/schemas/NotebookName"
},
{
"description": "The name of the notebook to search for."
}
]
}
},
"description": "A string for searching notebook names."
},
"NamedQuery": {
"type": "object",
"required": [
"Name",
"Database",
"QueryString"
],
"properties": {
"Name": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The query name."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/DescriptionString"
},
{
"description": "The query description."
}
]
},
"Database": {
"allOf": [
{
"$ref": "#/components/schemas/DatabaseString"
},
{
"description": "The database to which the query belongs."
}
]
},
"QueryString": {
"allOf": [
{
"$ref": "#/components/schemas/QueryString"
},
{
"description": "The SQL statements that make up the query."
}
]
},
"NamedQueryId": {
"allOf": [
{
"$ref": "#/components/schemas/NamedQueryId"
},
{
"description": "The unique identifier of the query."
}
]
},
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The name of the workgroup that contains the named query."
}
]
}
},
"description": "A query, where QueryString
contains the SQL statements that make up the query."
},
"PreparedStatement": {
"type": "object",
"properties": {
"StatementName": {
"allOf": [
{
"$ref": "#/components/schemas/StatementName"
},
{
"description": "The name of the prepared statement."
}
]
},
"QueryStatement": {
"allOf": [
{
"$ref": "#/components/schemas/QueryString"
},
{
"description": "The query string for the prepared statement."
}
]
},
"WorkGroupName": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The name of the workgroup to which the prepared statement belongs."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/DescriptionString"
},
{
"description": "The description of the prepared statement."
}
]
},
"LastModifiedTime": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The last modified time of the prepared statement."
}
]
}
},
"description": "A prepared SQL statement for use with Athena."
},
"QueryExecutionId": {
"type": "string",
"pattern": "\\S+",
"minLength": 1,
"maxLength": 128
},
"QueryExecution": {
"type": "object",
"properties": {
"QueryExecutionId": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecutionId"
},
{
"description": "The unique identifier for each query execution."
}
]
},
"Query": {
"allOf": [
{
"$ref": "#/components/schemas/QueryString"
},
{
"description": "The SQL query statements which the query execution ran."
}
]
},
"StatementType": {
"allOf": [
{
"$ref": "#/components/schemas/StatementType"
},
{
"description": "The type of query statement that was run. DDL
indicates DDL query statements. DML
indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT
. UTILITY
indicates query statements other than DDL and DML, such as SHOW CREATE TABLE
, or DESCRIBE TABLE
."
}
]
},
"ResultConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/ResultConfiguration"
},
{
"description": "The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup."
}
]
},
"ResultReuseConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/ResultReuseConfiguration"
},
{
"description": "Specifies the query result reuse behavior that was used for the query."
}
]
},
"QueryExecutionContext": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecutionContext"
},
{
"description": "The database in which the query execution occurred."
}
]
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecutionStatus"
},
{
"description": "The completion date, current state, submission time, and state change reason (if applicable) for the query execution."
}
]
},
"Statistics": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecutionStatistics"
},
{
"description": "Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run."
}
]
},
"WorkGroup": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The name of the workgroup in which the query ran."
}
]
},
"EngineVersion": {
"allOf": [
{
"$ref": "#/components/schemas/EngineVersion"
},
{
"description": "The engine version that executed the query."
}
]
},
"ExecutionParameters": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutionParameters"
},
{
"description": "A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur."
}
]
},
"SubstatementType": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The kind of query statement that was run."
}
]
}
},
"description": "Information about a single instance of a query execution."
},
"Token": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"MaxQueryResults": {
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"ResultSet": {
"type": "object",
"properties": {
"Rows": {
"allOf": [
{
"$ref": "#/components/schemas/RowList"
},
{
"description": "The rows in the table."
}
]
},
"ResultSetMetadata": {
"allOf": [
{
"$ref": "#/components/schemas/ResultSetMetadata"
},
{
"description": "The metadata that describes the column structure and data types of a table of query results."
}
]
}
},
"description": "The metadata and rows that make up a query result set. The metadata describes the column structure and data types. To return a ResultSet
object, use GetQueryResults."
},
"QueryRuntimeStatistics": {
"type": "object",
"properties": {
"Timeline": {
"$ref": "#/components/schemas/QueryRuntimeStatisticsTimeline"
},
"Rows": {
"$ref": "#/components/schemas/QueryRuntimeStatisticsRows"
},
"OutputStage": {
"allOf": [
{
"$ref": "#/components/schemas/QueryStage"
},
{
"description": "Stage statistics such as input and output rows and bytes, execution time, and stage state. This information also includes substages and the query stage plan."
}
]
}
},
"description": "The query execution timeline, statistics on input and output rows and bytes, and the different query stages that form the query execution plan."
},
"SessionConfiguration": {
"type": "object",
"properties": {
"ExecutionRole": {
"allOf": [
{
"$ref": "#/components/schemas/RoleArn"
},
{
"description": "The ARN of the execution role used for the session."
}
]
},
"WorkingDirectory": {
"allOf": [
{
"$ref": "#/components/schemas/ResultOutputLocation"
},
{
"description": "The Amazon S3 location that stores information for the notebook."
}
]
},
"IdleTimeoutSeconds": {
"allOf": [
{
"$ref": "#/components/schemas/Long"
},
{
"description": "The idle timeout in seconds for the session."
}
]
},
"EncryptionConfiguration": {
"$ref": "#/components/schemas/EncryptionConfiguration"
}
},
"description": "Contains session configuration information."
},
"SessionStatus": {
"type": "object",
"properties": {
"StartDateTime": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The date and time that the session started."
}
]
},
"LastModifiedDateTime": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The most recent date and time that the session was modified."
}
]
},
"EndDateTime": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The date and time that the session ended."
}
]
},
"IdleSinceDateTime": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The date and time starting at which the session became idle. Can be empty if the session is not currently idle."
}
]
},
"State": {
"allOf": [
{
"$ref": "#/components/schemas/SessionState"
},
{
"description": "The state of the session. A description of each state follows.
CREATING
- The session is being started, including acquiring resources.
CREATED
- The session has been started.
IDLE
- The session is able to accept a calculation.
BUSY
- The session is processing another task and is unable to accept a calculation.
TERMINATING
- The session is in the process of shutting down.
TERMINATED
- The session and its resources are no longer running.
DEGRADED
- The session has no healthy coordinators.
FAILED
- Due to a failure, the session and its resources are no longer running.
EXTERNAL_TABLE
is supported."
}
]
},
"Columns": {
"allOf": [
{
"$ref": "#/components/schemas/ColumnList"
},
{
"description": "A list of the columns in the table."
}
]
},
"PartitionKeys": {
"allOf": [
{
"$ref": "#/components/schemas/ColumnList"
},
{
"description": "A list of the partition keys in the table."
}
]
},
"Parameters": {
"allOf": [
{
"$ref": "#/components/schemas/ParametersMap"
},
{
"description": "A set of custom key/value pairs for table properties."
}
]
}
},
"description": "Contains metadata for a table."
},
"WorkGroup": {
"type": "object",
"required": [
"Name"
],
"properties": {
"Name": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupName"
},
{
"description": "The workgroup name."
}
]
},
"State": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupState"
},
{
"description": "The state of the workgroup: ENABLED or DISABLED."
}
]
},
"Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupConfiguration"
},
{
"description": "The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration
(true/false) in the WorkGroupConfiguration
. See WorkGroupConfiguration$EnforceWorkGroupConfiguration."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/WorkGroupDescriptionString"
},
{
"description": "The workgroup description."
}
]
},
"CreationTime": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The date and time the workgroup was created."
}
]
}
},
"description": "A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration
(true/false) in the WorkGroupConfiguration
. See WorkGroupConfiguration$EnforceWorkGroupConfiguration."
},
"NotebookType": {
"type": "string",
"enum": [
"IPYNB"
]
},
"KeyString": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"x-pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
},
"MaxApplicationDPUSizesCount": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"MaxCalculationsCount": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"SessionManagerToken": {
"type": "string",
"maxLength": 2048
},
"MaxDataCatalogsCount": {
"type": "integer",
"minimum": 2,
"maximum": 50
},
"MaxDatabasesCount": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"MaxEngineVersionsCount": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"MaxListExecutorsCount": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"MaxNamedQueriesCount": {
"type": "integer",
"minimum": 0,
"maximum": 50
},
"MaxNotebooksCount": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"NotebookMetadataArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotebookMetadata"
}
},
"MaxSessionsCount": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"NotebookSessionsList": {
"type": "array",
"description": "A list of notebook sessions.",
"items": {
"$ref": "#/components/schemas/NotebookSessionSummary"
},
"minItems": 0,
"maxItems": 10
},
"MaxPreparedStatementsCount": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"PreparedStatementsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreparedStatementSummary"
},
"minItems": 0,
"maxItems": 50
},
"MaxQueryExecutionsCount": {
"type": "integer",
"minimum": 0,
"maximum": 50
},
"SessionState": {
"type": "string",
"enum": [
"CREATING",
"CREATED",
"IDLE",
"BUSY",
"TERMINATING",
"TERMINATED",
"DEGRADED",
"FAILED"
]
},
"SessionsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionSummary"
},
"minItems": 0,
"maxItems": 100
},
"MaxTableMetadataCount": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"TableMetadataList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableMetadata"
}
},
"MaxTagsCount": {
"type": "integer",
"minimum": 75
},
"MaxWorkGroupsCount": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"WorkGroupsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkGroupSummary"
},
"minItems": 0,
"maxItems": 50
},
"NamedQueryDescriptionString": {
"type": "string",
"minLength": 0,
"maxLength": 1024
},
"NotebookSessionSummary": {
"type": "object",
"properties": {
"SessionId": {
"allOf": [
{
"$ref": "#/components/schemas/SessionId"
},
{
"description": "The notebook session ID."
}
]
},
"CreationTime": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The time when the notebook session was created."
}
]
}
},
"description": "Contains the notebook session ID and notebook session creation time."
},
"ParametersMapValue": {
"type": "string",
"maxLength": 51200
},
"PreparedStatementSummary": {
"type": "object",
"properties": {
"StatementName": {
"allOf": [
{
"$ref": "#/components/schemas/StatementName"
},
{
"description": "The name of the prepared statement."
}
]
},
"LastModifiedTime": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The last modified time of the prepared statement."
}
]
}
},
"description": "The name and last modified time of the prepared statement."
},
"StatementType": {
"type": "string",
"enum": [
"DDL",
"DML",
"UTILITY"
]
},
"ResultConfiguration": {
"type": "object",
"properties": {
"OutputLocation": {
"allOf": [
{
"$ref": "#/components/schemas/ResultOutputLocation"
},
{
"description": "The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/
. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. For more information, see Working with query results, recent queries, and output files. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration."
}
]
},
"EncryptionConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/EncryptionConfiguration"
},
{
"description": "If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS
or CSE_KMS
) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings."
}
]
},
"ExpectedBucketOwner": {
"allOf": [
{
"$ref": "#/components/schemas/AwsAccountId"
},
{
"description": "The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner
when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner
Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.
This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner
setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.
BUCKET_OWNER_FULL_CONTROL
. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings."
}
]
}
},
"description": "The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the workgroup settings."
},
"ResultReuseConfiguration": {
"type": "object",
"properties": {
"ResultReuseByAgeConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/ResultReuseByAgeConfiguration"
},
{
"description": "Specifies whether previous query results are reused, and if so, their maximum age."
}
]
}
},
"description": "Specifies the query result reuse behavior for the query."
},
"QueryExecutionContext": {
"type": "object",
"properties": {
"Database": {
"allOf": [
{
"$ref": "#/components/schemas/DatabaseString"
},
{
"description": "The name of the database used in the query execution. The database must exist in the catalog."
}
]
},
"Catalog": {
"allOf": [
{
"$ref": "#/components/schemas/CatalogNameString"
},
{
"description": "The name of the data catalog used in the query execution."
}
]
}
},
"description": "The database and data catalog context in which the query execution occurs."
},
"QueryExecutionStatus": {
"type": "object",
"properties": {
"State": {
"allOf": [
{
"$ref": "#/components/schemas/QueryExecutionState"
},
{
"description": "The state of query execution. QUEUED
indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING
indicates that the query is in execution phase. SUCCEEDED
indicates that the query completed without errors. FAILED
indicates that the query experienced an error and did not complete processing. CANCELLED
indicates that a user input interrupted query execution.
Athena automatically retries your queries in cases of certain transient errors. As a result, you may see the query state transition from RUNNING
or FAILED
to QUEUED
.
s3://path/to/query/bucket/
. For more information, see Working with query results, recent queries, and output files. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration
(true/false) in the WorkGroupConfiguration
. See WorkGroupConfiguration$EnforceWorkGroupConfiguration."
}
]
},
"RemoveOutputLocation": {
"allOf": [
{
"$ref": "#/components/schemas/BoxedBoolean"
},
{
"description": "If set to \"true\", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the OutputLocation
in ResultConfigurationUpdates
(the client-side setting), the OutputLocation
in the workgroup's ResultConfiguration
will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings."
}
]
},
"EncryptionConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/EncryptionConfiguration"
},
{
"description": "The encryption configuration for query and calculation results."
}
]
},
"RemoveEncryptionConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/BoxedBoolean"
},
{
"description": "If set to \"true\", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the EncryptionConfiguration
in ResultConfigurationUpdates
(the client-side setting), the EncryptionConfiguration
in the workgroup's ResultConfiguration
will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings."
}
]
},
"ExpectedBucketOwner": {
"allOf": [
{
"$ref": "#/components/schemas/AwsAccountId"
},
{
"description": "The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner
when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner
Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.
If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner
setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.
ExpectedBucketOwner
in ResultConfigurationUpdates
(the client-side setting), the ExpectedBucketOwner
in the workgroup's ResultConfiguration
is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings."
}
]
},
"AclConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/AclConfiguration"
},
{
"description": "The ACL configuration for the query results."
}
]
},
"RemoveAclConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/BoxedBoolean"
},
{
"description": "If set to true
, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to false
or not set, and a value is present in the AclConfiguration
of ResultConfigurationUpdates
, the AclConfiguration
in the workgroup's ResultConfiguration
is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings."
}
]
}
},
"description": "The information about the updates in the query results, such as output location and encryption configuration for the query results."
},
"ResultReuseByAgeConfiguration": {
"type": "object",
"required": [
"Enabled"
],
"properties": {
"Enabled": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "True if previous query results can be reused when the query is run; otherwise, false. The default is false."
}
]
},
"MaxAgeInMinutes": {
"allOf": [
{
"$ref": "#/components/schemas/Age"
},
{
"description": "Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60."
}
]
}
},
"description": "Specifies whether previous query results are reused, and if so, their maximum age."
},
"RowList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Row"
}
},
"ResultSetMetadata": {
"type": "object",
"properties": {
"ColumnInfo": {
"allOf": [
{
"$ref": "#/components/schemas/ColumnInfoList"
},
{
"description": "Information about the columns returned in a query result metadata."
}
]
}
},
"description": "The metadata that describes the column structure and data types of a table of query results. To return a ResultSetMetadata
object, use GetQueryResults."
},
"RoleArn": {
"type": "string",
"pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$",
"minLength": 20,
"maxLength": 2048
},
"datumList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Datum"
}
},
"Row": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/datumList"
},
{
"description": "The data that populates a row in a query result table."
}
]
}
},
"description": "The rows that make up a query result table."
},
"SessionIdleTimeoutInMinutes": {
"type": "integer",
"minimum": 1,
"maximum": 480
},
"SessionSummary": {
"type": "object",
"properties": {
"SessionId": {
"allOf": [
{
"$ref": "#/components/schemas/SessionId"
},
{
"description": "The session ID."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/DescriptionString"
},
{
"description": "The session description."
}
]
},
"EngineVersion": {
"allOf": [
{
"$ref": "#/components/schemas/EngineVersion"
},
{
"description": "The engine version used by the session (for example, PySpark engine version 3
)."
}
]
},
"NotebookVersion": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The notebook version."
}
]
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/SessionStatus"
},
{
"description": "Contains information about the session status."
}
]
}
},
"description": "Contains summary information about a session."
},
"Timestamp": {
"type": "string",
"format": "date-time"
},
"TableTypeString": {
"type": "string",
"maxLength": 255
},
"TagKey": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"TagValue": {
"type": "string",
"minLength": 0,
"maxLength": 256
},
"Tag": {
"type": "object",
"properties": {
"Key": {
"allOf": [
{
"$ref": "#/components/schemas/TagKey"
},
{
"description": "A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource. "
}
]
},
"Value": {
"allOf": [
{
"$ref": "#/components/schemas/TagValue"
},
{
"description": "A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive. "
}
]
}
},
"description": "A label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas. "
},
"TagKeyList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagKey"
}
},
"UnprocessedNamedQueryId": {
"type": "object",
"properties": {
"NamedQueryId": {
"allOf": [
{
"$ref": "#/components/schemas/NamedQueryId"
},
{
"description": "The unique identifier of the named query."
}
]
},
"ErrorCode": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorCode"
},
{
"description": "The error code returned when the processing request for the named query failed, if applicable."
}
]
},
"ErrorMessage": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorMessage"
},
{
"description": "The error message returned when the processing request for the named query failed, if applicable."
}
]
}
},
"description": "Information about a named query ID that could not be processed."
},
"UnprocessedPreparedStatementName": {
"type": "object",
"properties": {
"StatementName": {
"allOf": [
{
"$ref": "#/components/schemas/StatementName"
},
{
"description": "The name of a prepared statement that could not be returned due to an error."
}
]
},
"ErrorCode": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorCode"
},
{
"description": "The error code returned when the request for the prepared statement failed."
}
]
},
"ErrorMessage": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorMessage"
},
{
"description": "The error message containing the reason why the prepared statement could not be returned. The following error messages are possible:
INVALID_INPUT
- The name of the prepared statement that was provided is not valid (for example, the name is too long).
STATEMENT_NOT_FOUND
- A prepared statement with the name provided could not be found.
UNAUTHORIZED
- The requester does not have permission to access the workgroup that contains the prepared statement.
true
, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false
, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false
. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide."
}
]
},
"EngineVersion": {
"allOf": [
{
"$ref": "#/components/schemas/EngineVersion"
},
{
"description": "The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality
workgroup run on the preview engine regardless of this setting."
}
]
},
"RemoveCustomerContentEncryptionConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/BoxedBoolean"
},
{
"description": "Removes content encryption configuration for a workgroup."
}
]
},
"AdditionalConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "Contains a user defined string in JSON format for a Spark-enabled workgroup."
}
]
},
"ExecutionRole": {
"allOf": [
{
"$ref": "#/components/schemas/RoleArn"
},
{
"description": "Contains the ARN of the execution role for the workgroup"
}
]
},
"CustomerContentEncryptionConfiguration": {
"$ref": "#/components/schemas/CustomerContentEncryptionConfiguration"
},
"EnableMinimumEncryptionConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/BoxedBoolean"
},
{
"description": "Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.
The EnforceWorkGroupConfiguration
setting takes precedence over the EnableMinimumEncryptionConfiguration
flag. This means that if EnforceWorkGroupConfiguration
is true, the EnableMinimumEncryptionConfiguration
flag is ignored, and the workgroup configuration for encryption is used.
AmazonAthenaPreviewFunctionality
workgroup run on the preview engine regardless of this setting."
}
]
}
},
"description": "The summary information for the workgroup, which includes its name, state, description, and the date and time it was created."
}
}
},
"security": [
{
"hmac": []
}
]
}