{ "version":"2.0", "metadata":{ "apiVersion":"2017-05-18", "endpointPrefix":"athena", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon Athena", "serviceId":"Athena", "signatureVersion":"v4", "targetPrefix":"AmazonAthena", "uid":"athena-2017-05-18" }, "operations":{ "BatchGetNamedQuery":{ "name":"BatchGetNamedQuery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetNamedQueryInput"}, "output":{"shape":"BatchGetNamedQueryOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

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.

" }, "BatchGetPreparedStatement":{ "name":"BatchGetPreparedStatement", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetPreparedStatementInput"}, "output":{"shape":"BatchGetPreparedStatementOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

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 in `UnprocessedPreparedStatementNames`.

" }, "BatchGetQueryExecution":{ "name":"BatchGetQueryExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetQueryExecutionInput"}, "output":{"shape":"BatchGetQueryExecutionOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

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.

" }, "CancelCapacityReservation":{ "name":"CancelCapacityReservation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelCapacityReservationInput"}, "output":{"shape":"CancelCapacityReservationOutput"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServerException"} ], "documentation":"

Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.

", "idempotent":true }, "CreateCapacityReservation":{ "name":"CreateCapacityReservation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCapacityReservationInput"}, "output":{"shape":"CreateCapacityReservationOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Creates a capacity reservation with the specified name and number of requested data processing units.

", "idempotent":true }, "CreateDataCatalog":{ "name":"CreateDataCatalog", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDataCatalogInput"}, "output":{"shape":"CreateDataCatalogOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

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.

" }, "CreateNamedQuery":{ "name":"CreateNamedQuery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNamedQueryInput"}, "output":{"shape":"CreateNamedQueryOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

", "idempotent":true }, "CreateNotebook":{ "name":"CreateNotebook", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNotebookInput"}, "output":{"shape":"CreateNotebookOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Creates an empty `ipynb` file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

" }, "CreatePreparedStatement":{ "name":"CreatePreparedStatement", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePreparedStatementInput"}, "output":{"shape":"CreatePreparedStatementOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Creates a prepared statement for use with SQL queries in Athena.

" }, "CreatePresignedNotebookUrl":{ "name":"CreatePresignedNotebookUrl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePresignedNotebookUrlRequest"}, "output":{"shape":"CreatePresignedNotebookUrlResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "CreateWorkGroup":{ "name":"CreateWorkGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWorkGroupInput"}, "output":{"shape":"CreateWorkGroupOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

" }, "DeleteCapacityReservation":{ "name":"DeleteCapacityReservation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCapacityReservationInput"}, "output":{"shape":"DeleteCapacityReservationOutput"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServerException"} ], "documentation":"

Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by `GetCapacityReservation`, and deleted reservations do not appear in the output of `ListCapacityReservations`.

", "idempotent":true }, "DeleteDataCatalog":{ "name":"DeleteDataCatalog", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDataCatalogInput"}, "output":{"shape":"DeleteDataCatalogOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Deletes a data catalog.

" }, "DeleteNamedQuery":{ "name":"DeleteNamedQuery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNamedQueryInput"}, "output":{"shape":"DeleteNamedQueryOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Deletes the named query if you have access to the workgroup in which the query was saved.

", "idempotent":true }, "DeleteNotebook":{ "name":"DeleteNotebook", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNotebookInput"}, "output":{"shape":"DeleteNotebookOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Deletes the specified notebook.

" }, "DeletePreparedStatement":{ "name":"DeletePreparedStatement", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePreparedStatementInput"}, "output":{"shape":"DeletePreparedStatementOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes the prepared statement with the specified name from the specified workgroup.

" }, "DeleteWorkGroup":{ "name":"DeleteWorkGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteWorkGroupInput"}, "output":{"shape":"DeleteWorkGroupOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

", "idempotent":true }, "ExportNotebook":{ "name":"ExportNotebook", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ExportNotebookInput"}, "output":{"shape":"ExportNotebookOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Exports the specified notebook and its metadata.

" }, "GetCalculationExecution":{ "name":"GetCalculationExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCalculationExecutionRequest"}, "output":{"shape":"GetCalculationExecutionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes a previously submitted calculation execution.

" }, "GetCalculationExecutionCode":{ "name":"GetCalculationExecutionCode", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCalculationExecutionCodeRequest"}, "output":{"shape":"GetCalculationExecutionCodeResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves the unencrypted code that was executed for the calculation.

" }, "GetCalculationExecutionStatus":{ "name":"GetCalculationExecutionStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCalculationExecutionStatusRequest"}, "output":{"shape":"GetCalculationExecutionStatusResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets the status of a current calculation.

" }, "GetCapacityAssignmentConfiguration":{ "name":"GetCapacityAssignmentConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCapacityAssignmentConfigurationInput"}, "output":{"shape":"GetCapacityAssignmentConfigurationOutput"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets the capacity assignment configuration for a capacity reservation, if one exists.

" }, "GetCapacityReservation":{ "name":"GetCapacityReservation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCapacityReservationInput"}, "output":{"shape":"GetCapacityReservationOutput"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServerException"} ], "documentation":"

Returns information about the capacity reservation with the specified name.

" }, "GetDataCatalog":{ "name":"GetDataCatalog", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDataCatalogInput"}, "output":{"shape":"GetDataCatalogOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Returns the specified data catalog.

" }, "GetDatabase":{ "name":"GetDatabase", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDatabaseInput"}, "output":{"shape":"GetDatabaseOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"MetadataException"} ], "documentation":"

Returns a database object for the specified database and data catalog.

" }, "GetNamedQuery":{ "name":"GetNamedQuery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetNamedQueryInput"}, "output":{"shape":"GetNamedQueryOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

" }, "GetNotebookMetadata":{ "name":"GetNotebookMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetNotebookMetadataInput"}, "output":{"shape":"GetNotebookMetadataOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Retrieves notebook metadata for the specified notebook ID.

" }, "GetPreparedStatement":{ "name":"GetPreparedStatement", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPreparedStatementInput"}, "output":{"shape":"GetPreparedStatementOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves the prepared statement with the specified name from the specified workgroup.

" }, "GetQueryExecution":{ "name":"GetQueryExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetQueryExecutionInput"}, "output":{"shape":"GetQueryExecutionOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

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.

" }, "GetQueryResults":{ "name":"GetQueryResults", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetQueryResultsInput"}, "output":{"shape":"GetQueryResultsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

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.

" }, "GetQueryRuntimeStatistics":{ "name":"GetQueryRuntimeStatistics", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetQueryRuntimeStatisticsInput"}, "output":{"shape":"GetQueryRuntimeStatisticsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Query execution runtime statistics are returned only when QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. Stage-level input and output row count and data size statistics are not shown when a query has row-level filters defined in Lake Formation.

" }, "GetSession":{ "name":"GetSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSessionRequest"}, "output":{"shape":"GetSessionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets the full details of a previously created session, including the session status and configuration.

" }, "GetSessionStatus":{ "name":"GetSessionStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSessionStatusRequest"}, "output":{"shape":"GetSessionStatusResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets the current status of a session.

" }, "GetTableMetadata":{ "name":"GetTableMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTableMetadataInput"}, "output":{"shape":"GetTableMetadataOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"MetadataException"} ], "documentation":"

Returns table metadata for the specified catalog, database, and table.

" }, "GetWorkGroup":{ "name":"GetWorkGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetWorkGroupInput"}, "output":{"shape":"GetWorkGroupOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Returns information about the workgroup with the specified name.

" }, "ImportNotebook":{ "name":"ImportNotebook", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportNotebookInput"}, "output":{"shape":"ImportNotebookOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Imports a single `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.

" }, "ListApplicationDPUSizes":{ "name":"ListApplicationDPUSizes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListApplicationDPUSizesInput"}, "output":{"shape":"ListApplicationDPUSizesOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Returns the supported DPU sizes for the supported application runtimes (for example, `Athena notebook version 1`).

" }, "ListCalculationExecutions":{ "name":"ListCalculationExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCalculationExecutionsRequest"}, "output":{"shape":"ListCalculationExecutionsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.

" }, "ListCapacityReservations":{ "name":"ListCapacityReservations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCapacityReservationsInput"}, "output":{"shape":"ListCapacityReservationsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Lists the capacity reservations for the current account.

" }, "ListDataCatalogs":{ "name":"ListDataCatalogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDataCatalogsInput"}, "output":{"shape":"ListDataCatalogsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

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.

" }, "ListDatabases":{ "name":"ListDatabases", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDatabasesInput"}, "output":{"shape":"ListDatabasesOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"MetadataException"} ], "documentation":"

Lists the databases in the specified data catalog.

" }, "ListEngineVersions":{ "name":"ListEngineVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEngineVersionsInput"}, "output":{"shape":"ListEngineVersionsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Returns a list of engine versions that are available to choose from, including the Auto option.

" }, "ListExecutors":{ "name":"ListExecutors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListExecutorsRequest"}, "output":{"shape":"ListExecutorsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

" }, "ListNamedQueries":{ "name":"ListNamedQueries", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListNamedQueriesInput"}, "output":{"shape":"ListNamedQueriesOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

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.

" }, "ListNotebookMetadata":{ "name":"ListNotebookMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListNotebookMetadataInput"}, "output":{"shape":"ListNotebookMetadataOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Displays the notebook files for the specified workgroup in paginated format.

" }, "ListNotebookSessions":{ "name":"ListNotebookSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListNotebookSessionsRequest"}, "output":{"shape":"ListNotebookSessionsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists, in descending order, the sessions that have been created in a notebook that are in an active state like `CREATING`, `CREATED`, `IDLE` or `BUSY`. Newer sessions are listed first; older sessions are listed later.

" }, "ListPreparedStatements":{ "name":"ListPreparedStatements", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPreparedStatementsInput"}, "output":{"shape":"ListPreparedStatementsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Lists the prepared statements in the specified workgroup.

" }, "ListQueryExecutions":{ "name":"ListQueryExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListQueryExecutionsInput"}, "output":{"shape":"ListQueryExecutionsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. 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.

" }, "ListSessions":{ "name":"ListSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSessionsRequest"}, "output":{"shape":"ListSessionsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists the sessions in a workgroup that are in an active state like `CREATING`, `CREATED`, `IDLE`, or `BUSY`. Newer sessions are listed first; older sessions are listed later.

" }, "ListTableMetadata":{ "name":"ListTableMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTableMetadataInput"}, "output":{"shape":"ListTableMetadataOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"MetadataException"} ], "documentation":"

Lists the metadata for the tables in the specified data catalog database.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceInput"}, "output":{"shape":"ListTagsForResourceOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists the tags associated with an Athena resource.

" }, "ListWorkGroups":{ "name":"ListWorkGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListWorkGroupsInput"}, "output":{"shape":"ListWorkGroupsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Lists available workgroups for the account.

" }, "PutCapacityAssignmentConfiguration":{ "name":"PutCapacityAssignmentConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutCapacityAssignmentConfigurationInput"}, "output":{"shape":"PutCapacityAssignmentConfigurationOutput"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServerException"} ], "documentation":"

Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.

", "idempotent":true }, "StartCalculationExecution":{ "name":"StartCalculationExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartCalculationExecutionRequest"}, "output":{"shape":"StartCalculationExecutionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.

The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.

" }, "StartQueryExecution":{ "name":"StartQueryExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartQueryExecutionInput"}, "output":{"shape":"StartQueryExecutionOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

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.

", "idempotent":true }, "StartSession":{ "name":"StartSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartSessionRequest"}, "output":{"shape":"StartSessionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"SessionAlreadyExistsException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Creates a session for running calculations within a workgroup. The session is ready when it reaches an `IDLE` state.

" }, "StopCalculationExecution":{ "name":"StopCalculationExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopCalculationExecutionRequest"}, "output":{"shape":"StopCalculationExecutionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "StopQueryExecution":{ "name":"StopQueryExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopQueryExecutionInput"}, "output":{"shape":"StopQueryExecutionOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Stops a query execution. Requires you to have access to the workgroup in which the query ran.

", "idempotent":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceInput"}, "output":{"shape":"TagResourceOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. 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, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources 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.

" }, "TerminateSession":{ "name":"TerminateSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateSessionRequest"}, "output":{"shape":"TerminateSessionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Terminates an active session. A `TerminateSession` 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`.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceInput"}, "output":{"shape":"UntagResourceOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Removes one or more tags from an Athena resource.

" }, "UpdateCapacityReservation":{ "name":"UpdateCapacityReservation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateCapacityReservationInput"}, "output":{"shape":"UpdateCapacityReservationOutput"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServerException"} ], "documentation":"

Updates the number of requested data processing units for the capacity reservation with the specified name.

" }, "UpdateDataCatalog":{ "name":"UpdateDataCatalog", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDataCatalogInput"}, "output":{"shape":"UpdateDataCatalogOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Updates the data catalog that has the specified name.

" }, "UpdateNamedQuery":{ "name":"UpdateNamedQuery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateNamedQueryInput"}, "output":{"shape":"UpdateNamedQueryOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Updates a NamedQuery object. The database or workgroup cannot be updated.

", "idempotent":true }, "UpdateNotebook":{ "name":"UpdateNotebook", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateNotebookInput"}, "output":{"shape":"UpdateNotebookOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Updates the contents of a Spark notebook.

" }, "UpdateNotebookMetadata":{ "name":"UpdateNotebookMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateNotebookMetadataInput"}, "output":{"shape":"UpdateNotebookMetadataOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Updates the metadata for a notebook.

" }, "UpdatePreparedStatement":{ "name":"UpdatePreparedStatement", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePreparedStatementInput"}, "output":{"shape":"UpdatePreparedStatementOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates a prepared statement.

" }, "UpdateWorkGroup":{ "name":"UpdateWorkGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateWorkGroupInput"}, "output":{"shape":"UpdateWorkGroupOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only `ConfigurationUpdates` can be specified.

" } }, "shapes":{ "AclConfiguration":{ "type":"structure", "required":["S3AclOption"], "members":{ "S3AclOption":{ "shape":"S3AclOption", "documentation":"

The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is `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.

" } }, "documentation":"

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", "max":10080, "min":0 }, "AllocatedDpusInteger":{ "type":"integer", "box":true, "min":0 }, "AmazonResourceName":{ "type":"string", "max":1011, "min":1 }, "ApplicationDPUSizes":{ "type":"structure", "members":{ "ApplicationRuntimeId":{ "shape":"NameString", "documentation":"

The name of the supported application runtime (for example, `Athena notebook version 1`).

" }, "SupportedDPUSizes":{ "shape":"SupportedDPUSizeList", "documentation":"

A list of the supported DPU sizes that the application runtime supports.

" } }, "documentation":"

Contains the application runtime IDs and their supported DPU sizes.

" }, "ApplicationDPUSizesList":{ "type":"list", "member":{"shape":"ApplicationDPUSizes"} }, "AthenaError":{ "type":"structure", "members":{ "ErrorCategory":{ "shape":"ErrorCategory", "documentation":"

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":{ "shape":"ErrorType", "documentation":"

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":{ "shape":"Boolean", "documentation":"

True if the query might succeed if resubmitted.

" }, "ErrorMessage":{ "shape":"String", "documentation":"

Contains a short description of the error that occurred.

" } }, "documentation":"

Provides information about an Athena query error. The `AthenaError` 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", "max":2048 }, "AuthenticationType":{ "type":"string", "enum":["DIRECTORY_IDENTITY"] }, "AwsAccountId":{ "type":"string", "max":12, "min":12, "pattern":"^[0-9]+$" }, "BatchGetNamedQueryInput":{ "type":"structure", "required":["NamedQueryIds"], "members":{ "NamedQueryIds":{ "shape":"NamedQueryIdList", "documentation":"

An array of query IDs.

" } }, "documentation":"

Contains an array of named query IDs.

" }, "BatchGetNamedQueryOutput":{ "type":"structure", "members":{ "NamedQueries":{ "shape":"NamedQueryList", "documentation":"

Information about the named query IDs submitted.

" }, "UnprocessedNamedQueryIds":{ "shape":"UnprocessedNamedQueryIdList", "documentation":"

Information about provided query IDs.

" } } }, "BatchGetPreparedStatementInput":{ "type":"structure", "required":[ "PreparedStatementNames", "WorkGroup" ], "members":{ "PreparedStatementNames":{ "shape":"PreparedStatementNameList", "documentation":"

A list of prepared statement names to return.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup to which the prepared statements belong.

" } } }, "BatchGetPreparedStatementOutput":{ "type":"structure", "members":{ "PreparedStatements":{ "shape":"PreparedStatementDetailsList", "documentation":"

The list of prepared statements returned.

" }, "UnprocessedPreparedStatementNames":{ "shape":"UnprocessedPreparedStatementNameList", "documentation":"

A list of one or more prepared statements that were requested but could not be returned.

" } } }, "BatchGetQueryExecutionInput":{ "type":"structure", "required":["QueryExecutionIds"], "members":{ "QueryExecutionIds":{ "shape":"QueryExecutionIdList", "documentation":"

An array of query execution IDs.

" } }, "documentation":"

Contains an array of query execution IDs.

" }, "BatchGetQueryExecutionOutput":{ "type":"structure", "members":{ "QueryExecutions":{ "shape":"QueryExecutionList", "documentation":"

Information about a query execution.

" }, "UnprocessedQueryExecutionIds":{ "shape":"UnprocessedQueryExecutionIdList", "documentation":"

Information about the query executions that failed to run.

" } } }, "Boolean":{"type":"boolean"}, "BoxedBoolean":{"type":"boolean"}, "BytesScannedCutoffValue":{ "type":"long", "min":10000000 }, "CalculationConfiguration":{ "type":"structure", "members":{ "CodeBlock":{ "shape":"CodeBlock", "documentation":"

A string that contains the code for the calculation.

" } }, "documentation":"

Contains configuration information for the calculation.

" }, "CalculationExecutionId":{ "type":"string", "max":36, "min":1 }, "CalculationExecutionState":{ "type":"string", "enum":[ "CREATING", "CREATED", "QUEUED", "RUNNING", "CANCELING", "CANCELED", "COMPLETED", "FAILED" ] }, "CalculationResult":{ "type":"structure", "members":{ "StdOutS3Uri":{ "shape":"S3Uri", "documentation":"

The Amazon S3 location of the `stdout` file for the calculation.

" }, "StdErrorS3Uri":{ "shape":"S3Uri", "documentation":"

The Amazon S3 location of the `stderr` error messages file for the calculation.

" }, "ResultS3Uri":{ "shape":"S3Uri", "documentation":"

The Amazon S3 location of the folder for the calculation results.

" }, "ResultType":{ "shape":"CalculationResultType", "documentation":"

The data format of the calculation result.

" } }, "documentation":"

Contains information about an application-specific calculation result.

" }, "CalculationResultType":{ "type":"string", "max":256, "min":1, "pattern":"\\w+\\/[-+.\\w]+" }, "CalculationStatistics":{ "type":"structure", "members":{ "DpuExecutionInMillis":{ "shape":"Long", "documentation":"

The data processing unit execution time in milliseconds for the calculation.

" }, "Progress":{ "shape":"DescriptionString", "documentation":"

The progress of the calculation.

" } }, "documentation":"

Contains statistics for a notebook calculation.

" }, "CalculationStatus":{ "type":"structure", "members":{ "SubmissionDateTime":{ "shape":"Date", "documentation":"

The date and time the calculation was submitted for processing.

" }, "CompletionDateTime":{ "shape":"Date", "documentation":"

The date and time the calculation completed processing.

" }, "State":{ "shape":"CalculationExecutionState", "documentation":"

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.

" }, "StateChangeReason":{ "shape":"DescriptionString", "documentation":"

The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

" } }, "documentation":"

Contains information about the status of a notebook calculation.

" }, "CalculationSummary":{ "type":"structure", "members":{ "CalculationExecutionId":{ "shape":"CalculationExecutionId", "documentation":"

The calculation execution UUID.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

A description of the calculation.

" }, "Status":{ "shape":"CalculationStatus", "documentation":"

Contains information about the status of the calculation.

" } }, "documentation":"

Summary information for a notebook calculation.

" }, "CalculationsList":{ "type":"list", "member":{"shape":"CalculationSummary"}, "max":100, "min":0 }, "CancelCapacityReservationInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"CapacityReservationName", "documentation":"

The name of the capacity reservation to cancel.

" } } }, "CancelCapacityReservationOutput":{ "type":"structure", "members":{ } }, "CapacityAllocation":{ "type":"structure", "required":[ "Status", "RequestTime" ], "members":{ "Status":{ "shape":"CapacityAllocationStatus", "documentation":"

The status of the capacity allocation.

" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message of the capacity allocation.

" }, "RequestTime":{ "shape":"Timestamp", "documentation":"

The time when the capacity allocation was requested.

" }, "RequestCompletionTime":{ "shape":"Timestamp", "documentation":"

The time when the capacity allocation request was completed.

" } }, "documentation":"

Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.

" }, "CapacityAllocationStatus":{ "type":"string", "enum":[ "PENDING", "SUCCEEDED", "FAILED" ] }, "CapacityAssignment":{ "type":"structure", "members":{ "WorkGroupNames":{ "shape":"WorkGroupNamesList", "documentation":"

The list of workgroup names for the capacity assignment.

" } }, "documentation":"

A mapping between one or more workgroups and a capacity reservation.

" }, "CapacityAssignmentConfiguration":{ "type":"structure", "members":{ "CapacityReservationName":{ "shape":"CapacityReservationName", "documentation":"

The name of the reservation that the capacity assignment configuration is for.

" }, "CapacityAssignments":{ "shape":"CapacityAssignmentsList", "documentation":"

The list of assignments that make up the capacity assignment configuration.

" } }, "documentation":"

Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.

" }, "CapacityAssignmentsList":{ "type":"list", "member":{"shape":"CapacityAssignment"} }, "CapacityReservation":{ "type":"structure", "required":[ "Name", "Status", "TargetDpus", "AllocatedDpus", "CreationTime" ], "members":{ "Name":{ "shape":"CapacityReservationName", "documentation":"

The name of the capacity reservation.

" }, "Status":{ "shape":"CapacityReservationStatus", "documentation":"

The status of the capacity reservation.

" }, "TargetDpus":{ "shape":"TargetDpusInteger", "documentation":"

The number of data processing units requested.

" }, "AllocatedDpus":{ "shape":"AllocatedDpusInteger", "documentation":"

The number of data processing units currently allocated.

" }, "LastAllocation":{"shape":"CapacityAllocation"}, "LastSuccessfulAllocationTime":{ "shape":"Timestamp", "documentation":"

The time of the most recent capacity allocation that succeeded.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The time in UTC epoch millis when the capacity reservation was created.

" } }, "documentation":"

A reservation for a specified number of data processing units (DPUs). When a reservation is initially created, it has no DPUs. Athena allocates DPUs until the allocated amount equals the requested amount.

" }, "CapacityReservationName":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9._-]+" }, "CapacityReservationStatus":{ "type":"string", "enum":[ "PENDING", "ACTIVE", "CANCELLING", "CANCELLED", "FAILED", "UPDATE_PENDING" ] }, "CapacityReservationsList":{ "type":"list", "member":{"shape":"CapacityReservation"} }, "CatalogNameString":{ "type":"string", "max":256, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" }, "ClientRequestToken":{ "type":"string", "max":36, "min":1, "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, "CodeBlock":{ "type":"string", "max":68000 }, "Column":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"NameString", "documentation":"

The name of the column.

" }, "Type":{ "shape":"TypeString", "documentation":"

The data type of the column.

" }, "Comment":{ "shape":"CommentString", "documentation":"

Optional information about the column.

" } }, "documentation":"

Contains metadata for a column in a table.

" }, "ColumnInfo":{ "type":"structure", "required":[ "Name", "Type" ], "members":{ "CatalogName":{ "shape":"String", "documentation":"

The catalog to which the query results belong.

" }, "SchemaName":{ "shape":"String", "documentation":"

The schema name (database name) to which the query results belong.

" }, "TableName":{ "shape":"String", "documentation":"

The table name for the query results.

" }, "Name":{ "shape":"String", "documentation":"

The name of the column.

" }, "Label":{ "shape":"String", "documentation":"

A column label.

" }, "Type":{ "shape":"String", "documentation":"

The data type of the column.

" }, "Precision":{ "shape":"Integer", "documentation":"

For `DECIMAL` data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.

" }, "Scale":{ "shape":"Integer", "documentation":"

For `DECIMAL` data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.

" }, "Nullable":{ "shape":"ColumnNullable", "documentation":"

Unsupported constraint. This value always shows as `UNKNOWN`.

" }, "CaseSensitive":{ "shape":"Boolean", "documentation":"

Indicates whether values in the column are case-sensitive.

" } }, "documentation":"

Information about the columns in a query execution result.

" }, "ColumnInfoList":{ "type":"list", "member":{"shape":"ColumnInfo"} }, "ColumnList":{ "type":"list", "member":{"shape":"Column"} }, "ColumnNullable":{ "type":"string", "enum":[ "NOT_NULL", "NULLABLE", "UNKNOWN" ] }, "CommentString":{ "type":"string", "max":255, "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" }, "CoordinatorDpuSize":{ "type":"integer", "box":true, "max":1, "min":1 }, "CreateCapacityReservationInput":{ "type":"structure", "required":[ "TargetDpus", "Name" ], "members":{ "TargetDpus":{ "shape":"TargetDpusInteger", "documentation":"

The number of requested data processing units.

" }, "Name":{ "shape":"CapacityReservationName", "documentation":"

The name of the capacity reservation to create.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags for the capacity reservation.

" } } }, "CreateCapacityReservationOutput":{ "type":"structure", "members":{ } }, "CreateDataCatalogInput":{ "type":"structure", "required":[ "Name", "Type" ], "members":{ "Name":{ "shape":"CatalogNameString", "documentation":"

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":{ "shape":"DataCatalogType", "documentation":"

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":{ "shape":"DescriptionString", "documentation":"

A description of the data catalog to be created.

" }, "Parameters":{ "shape":"ParametersMap", "documentation":"

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.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of comma separated tags to add to the data catalog that is created.

" } } }, "CreateDataCatalogOutput":{ "type":"structure", "members":{ } }, "CreateNamedQueryInput":{ "type":"structure", "required":[ "Name", "Database", "QueryString" ], "members":{ "Name":{ "shape":"NameString", "documentation":"

The query name.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

The query description.

" }, "Database":{ "shape":"DatabaseString", "documentation":"

The database to which the query belongs.

" }, "QueryString":{ "shape":"QueryString", "documentation":"

The contents of the query with all query statements.

" }, "ClientRequestToken":{ "shape":"IdempotencyToken", "documentation":"

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.

", "idempotencyToken":true }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup in which the named query is being created.

" } } }, "CreateNamedQueryOutput":{ "type":"structure", "members":{ "NamedQueryId":{ "shape":"NamedQueryId", "documentation":"

The unique ID of the query.

" } } }, "CreateNotebookInput":{ "type":"structure", "required":[ "WorkGroup", "Name" ], "members":{ "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the Spark enabled workgroup in which the notebook will be created.

" }, "Name":{ "shape":"NotebookName", "documentation":"

The name of the `ipynb` file to be created in the Spark workgroup, without the `.ipynb` extension.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

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.

" } } }, "CreateNotebookOutput":{ "type":"structure", "members":{ "NotebookId":{ "shape":"NotebookId", "documentation":"

A unique identifier for the notebook.

" } } }, "CreatePreparedStatementInput":{ "type":"structure", "required":[ "StatementName", "WorkGroup", "QueryStatement" ], "members":{ "StatementName":{ "shape":"StatementName", "documentation":"

The name of the prepared statement.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup to which the prepared statement belongs.

" }, "QueryStatement":{ "shape":"QueryString", "documentation":"

The query string for the prepared statement.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

The description of the prepared statement.

" } } }, "CreatePreparedStatementOutput":{ "type":"structure", "members":{ } }, "CreatePresignedNotebookUrlRequest":{ "type":"structure", "required":["SessionId"], "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" } } }, "CreatePresignedNotebookUrlResponse":{ "type":"structure", "required":[ "NotebookUrl", "AuthToken", "AuthTokenExpirationTime" ], "members":{ "NotebookUrl":{ "shape":"String", "documentation":"

The URL of the notebook. The URL includes the authentication token and notebook file name and points directly to the opened notebook.

" }, "AuthToken":{ "shape":"AuthToken", "documentation":"

The authentication token for the notebook.

" }, "AuthTokenExpirationTime":{ "shape":"Long", "documentation":"

The UTC epoch time when the authentication token expires.

" } } }, "CreateWorkGroupInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"WorkGroupName", "documentation":"

The workgroup name.

" }, "Configuration":{ "shape":"WorkGroupConfiguration", "documentation":"

Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with `EnforceWorkGroupConfiguration`) in the `WorkGroupConfiguration` override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" }, "Description":{ "shape":"WorkGroupDescriptionString", "documentation":"

The workgroup description.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of comma separated tags to add to the workgroup that is created.

" } } }, "CreateWorkGroupOutput":{ "type":"structure", "members":{ } }, "CustomerContentEncryptionConfiguration":{ "type":"structure", "required":["KmsKey"], "members":{ "KmsKey":{ "shape":"KmsKey", "documentation":"

The customer managed KMS key that is used to encrypt the user's data stores in Athena.

" } }, "documentation":"

Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.

" }, "DataCatalog":{ "type":"structure", "required":[ "Name", "Type" ], "members":{ "Name":{ "shape":"CatalogNameString", "documentation":"

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":{ "shape":"DescriptionString", "documentation":"

An optional description of the data catalog.

" }, "Type":{ "shape":"DataCatalogType", "documentation":"

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":{ "shape":"ParametersMap", "documentation":"

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.

" } }, "documentation":"

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.

" }, "DataCatalogSummary":{ "type":"structure", "members":{ "CatalogName":{ "shape":"CatalogNameString", "documentation":"

The name of the data catalog. The catalog name is 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":{ "shape":"DataCatalogType", "documentation":"

The data catalog type.

" } }, "documentation":"

The summary information for the data catalog, which includes its name and type.

" }, "DataCatalogSummaryList":{ "type":"list", "member":{"shape":"DataCatalogSummary"} }, "DataCatalogType":{ "type":"string", "enum":[ "LAMBDA", "GLUE", "HIVE" ] }, "Database":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"NameString", "documentation":"

The name of the database.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

An optional description of the database.

" }, "Parameters":{ "shape":"ParametersMap", "documentation":"

A set of custom key/value pairs.

" } }, "documentation":"

Contains metadata information for a database in a data catalog.

" }, "DatabaseList":{ "type":"list", "member":{"shape":"Database"} }, "DatabaseString":{ "type":"string", "max":255, "min":1 }, "Date":{"type":"timestamp"}, "Datum":{ "type":"structure", "members":{ "VarCharValue":{ "shape":"datumString", "documentation":"

The value of the datum.

" } }, "documentation":"

A piece of data (a field in the table).

" }, "DefaultExecutorDpuSize":{ "type":"integer", "box":true, "max":1, "min":1 }, "DeleteCapacityReservationInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"CapacityReservationName", "documentation":"

The name of the capacity reservation to delete.

" } } }, "DeleteCapacityReservationOutput":{ "type":"structure", "members":{ } }, "DeleteDataCatalogInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"CatalogNameString", "documentation":"

The name of the data catalog to delete.

" } } }, "DeleteDataCatalogOutput":{ "type":"structure", "members":{ } }, "DeleteNamedQueryInput":{ "type":"structure", "required":["NamedQueryId"], "members":{ "NamedQueryId":{ "shape":"NamedQueryId", "documentation":"

The unique ID of the query to delete.

", "idempotencyToken":true } } }, "DeleteNamedQueryOutput":{ "type":"structure", "members":{ } }, "DeleteNotebookInput":{ "type":"structure", "required":["NotebookId"], "members":{ "NotebookId":{ "shape":"NotebookId", "documentation":"

The ID of the notebook to delete.

" } } }, "DeleteNotebookOutput":{ "type":"structure", "members":{ } }, "DeletePreparedStatementInput":{ "type":"structure", "required":[ "StatementName", "WorkGroup" ], "members":{ "StatementName":{ "shape":"StatementName", "documentation":"

The name of the prepared statement to delete.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The workgroup to which the statement to be deleted belongs.

" } } }, "DeletePreparedStatementOutput":{ "type":"structure", "members":{ } }, "DeleteWorkGroupInput":{ "type":"structure", "required":["WorkGroup"], "members":{ "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The unique name of the workgroup to delete.

" }, "RecursiveDeleteOption":{ "shape":"BoxedBoolean", "documentation":"

The option to delete the workgroup and its contents even if the workgroup contains any named queries, query executions, or notebooks.

" } } }, "DeleteWorkGroupOutput":{ "type":"structure", "members":{ } }, "DescriptionString":{ "type":"string", "max":1024, "min":1 }, "EncryptionConfiguration":{ "type":"structure", "required":["EncryptionOption"], "members":{ "EncryptionOption":{ "shape":"EncryptionOption", "documentation":"

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":{ "shape":"String", "documentation":"

For `SSE_KMS` and `CSE_KMS`, this is the KMS key ARN or ID.

" } }, "documentation":"

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.

" }, "EncryptionOption":{ "type":"string", "enum":[ "SSE_S3", "SSE_KMS", "CSE_KMS" ] }, "EngineConfiguration":{ "type":"structure", "required":["MaxConcurrentDpus"], "members":{ "CoordinatorDpuSize":{ "shape":"CoordinatorDpuSize", "documentation":"

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. The default is 1.

" }, "MaxConcurrentDpus":{ "shape":"MaxConcurrentDpus", "documentation":"

The maximum number of DPUs that can run concurrently.

" }, "DefaultExecutorDpuSize":{ "shape":"DefaultExecutorDpuSize", "documentation":"

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. The default is 1.

" }, "AdditionalConfigs":{ "shape":"ParametersMap", "documentation":"

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.

" }, "SparkProperties":{ "shape":"ParametersMap", "documentation":"

Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.

" } }, "documentation":"

Contains data processing unit (DPU) configuration settings and parameter mappings for a notebook engine.

" }, "EngineVersion":{ "type":"structure", "members":{ "SelectedEngineVersion":{ "shape":"NameString", "documentation":"

The engine version requested by the user. Possible values are determined by the output of `ListEngineVersions`, including AUTO. The default is AUTO.

" }, "EffectiveEngineVersion":{ "shape":"NameString", "documentation":"

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.

" } }, "documentation":"

The Athena engine version for running queries, or the PySpark engine version for running sessions.

" }, "EngineVersionsList":{ "type":"list", "member":{"shape":"EngineVersion"}, "max":10, "min":0 }, "ErrorCategory":{ "type":"integer", "box":true, "max":3, "min":1 }, "ErrorCode":{ "type":"string", "documentation":"

The error code returned when the query execution failed to process, or when the processing request for the named query failed.

", "max":256, "min":1 }, "ErrorMessage":{"type":"string"}, "ErrorType":{ "type":"integer", "box":true, "max":9999, "min":0 }, "ExecutionParameter":{ "type":"string", "max":1024, "min":1 }, "ExecutionParameters":{ "type":"list", "member":{"shape":"ExecutionParameter"}, "min":1 }, "ExecutorId":{ "type":"string", "max":100000, "pattern":".*" }, "ExecutorState":{ "type":"string", "enum":[ "CREATING", "CREATED", "REGISTERED", "TERMINATING", "TERMINATED", "FAILED" ] }, "ExecutorType":{ "type":"string", "enum":[ "COORDINATOR", "GATEWAY", "WORKER" ] }, "ExecutorsSummary":{ "type":"structure", "required":["ExecutorId"], "members":{ "ExecutorId":{ "shape":"ExecutorId", "documentation":"

The UUID of the executor.

" }, "ExecutorType":{ "shape":"ExecutorType", "documentation":"

The type of executor used for the application (`COORDINATOR`, `GATEWAY`, or `WORKER`).

" }, "StartDateTime":{ "shape":"Long", "documentation":"

The date and time that the executor started.

" }, "TerminationDateTime":{ "shape":"Long", "documentation":"

The date and time that the executor was terminated.

" }, "ExecutorState":{ "shape":"ExecutorState", "documentation":"

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.

" }, "ExecutorSize":{ "shape":"Long", "documentation":"

The smallest unit of compute that a session can request from Athena. Size is measured in data processing unit (DPU) values, a relative measure of processing power.

" } }, "documentation":"

Contains summary information about an executor.

" }, "ExecutorsSummaryList":{ "type":"list", "member":{"shape":"ExecutorsSummary"} }, "ExportNotebookInput":{ "type":"structure", "required":["NotebookId"], "members":{ "NotebookId":{ "shape":"NotebookId", "documentation":"

The ID of the notebook to export.

" } } }, "ExportNotebookOutput":{ "type":"structure", "members":{ "NotebookMetadata":{ "shape":"NotebookMetadata", "documentation":"

The notebook metadata, including notebook ID, notebook name, and workgroup name.

" }, "Payload":{ "shape":"Payload", "documentation":"

The content of the exported notebook.

" } } }, "ExpressionString":{ "type":"string", "max":256, "min":0 }, "FilterDefinition":{ "type":"structure", "members":{ "Name":{ "shape":"NotebookName", "documentation":"

The name of the notebook to search for.

" } }, "documentation":"

A string for searching notebook names.

" }, "GetCalculationExecutionCodeRequest":{ "type":"structure", "required":["CalculationExecutionId"], "members":{ "CalculationExecutionId":{ "shape":"CalculationExecutionId", "documentation":"

The calculation execution UUID.

" } } }, "GetCalculationExecutionCodeResponse":{ "type":"structure", "members":{ "CodeBlock":{ "shape":"CodeBlock", "documentation":"

The unencrypted code that was executed for the calculation.

" } } }, "GetCalculationExecutionRequest":{ "type":"structure", "required":["CalculationExecutionId"], "members":{ "CalculationExecutionId":{ "shape":"CalculationExecutionId", "documentation":"

The calculation execution UUID.

" } } }, "GetCalculationExecutionResponse":{ "type":"structure", "members":{ "CalculationExecutionId":{ "shape":"CalculationExecutionId", "documentation":"

The calculation execution UUID.

" }, "SessionId":{ "shape":"SessionId", "documentation":"

The session ID that the calculation ran in.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

The description of the calculation execution.

" }, "WorkingDirectory":{ "shape":"S3Uri", "documentation":"

The Amazon S3 location in which calculation results are stored.

" }, "Status":{ "shape":"CalculationStatus", "documentation":"

Contains information about the status of the calculation.

" }, "Statistics":{ "shape":"CalculationStatistics", "documentation":"

Contains information about the data processing unit (DPU) execution time and progress. This field is populated only when statistics are available.

" }, "Result":{ "shape":"CalculationResult", "documentation":"

Contains result information. This field is populated only if the calculation is completed.

" } } }, "GetCalculationExecutionStatusRequest":{ "type":"structure", "required":["CalculationExecutionId"], "members":{ "CalculationExecutionId":{ "shape":"CalculationExecutionId", "documentation":"

The calculation execution UUID.

" } } }, "GetCalculationExecutionStatusResponse":{ "type":"structure", "members":{ "Status":{ "shape":"CalculationStatus", "documentation":"

Contains information about the calculation execution status.

" }, "Statistics":{ "shape":"CalculationStatistics", "documentation":"

Contains information about the DPU execution time and progress.

" } } }, "GetCapacityAssignmentConfigurationInput":{ "type":"structure", "required":["CapacityReservationName"], "members":{ "CapacityReservationName":{ "shape":"CapacityReservationName", "documentation":"

The name of the capacity reservation to retrieve the capacity assignment configuration for.

" } } }, "GetCapacityAssignmentConfigurationOutput":{ "type":"structure", "required":["CapacityAssignmentConfiguration"], "members":{ "CapacityAssignmentConfiguration":{ "shape":"CapacityAssignmentConfiguration", "documentation":"

The requested capacity assignment configuration for the specified capacity reservation.

" } } }, "GetCapacityReservationInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"CapacityReservationName", "documentation":"

The name of the capacity reservation.

" } } }, "GetCapacityReservationOutput":{ "type":"structure", "required":["CapacityReservation"], "members":{ "CapacityReservation":{ "shape":"CapacityReservation", "documentation":"

The requested capacity reservation structure.

" } } }, "GetDataCatalogInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"CatalogNameString", "documentation":"

The name of the data catalog to return.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup. Required if making an IAM Identity Center request.

" } } }, "GetDataCatalogOutput":{ "type":"structure", "members":{ "DataCatalog":{ "shape":"DataCatalog", "documentation":"

The data catalog returned.

" } } }, "GetDatabaseInput":{ "type":"structure", "required":[ "CatalogName", "DatabaseName" ], "members":{ "CatalogName":{ "shape":"CatalogNameString", "documentation":"

The name of the data catalog that contains the database to return.

" }, "DatabaseName":{ "shape":"NameString", "documentation":"

The name of the database to return.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

" } } }, "GetDatabaseOutput":{ "type":"structure", "members":{ "Database":{ "shape":"Database", "documentation":"

The database returned.

" } } }, "GetNamedQueryInput":{ "type":"structure", "required":["NamedQueryId"], "members":{ "NamedQueryId":{ "shape":"NamedQueryId", "documentation":"

The unique ID of the query. Use ListNamedQueries to get query IDs.

" } } }, "GetNamedQueryOutput":{ "type":"structure", "members":{ "NamedQuery":{ "shape":"NamedQuery", "documentation":"

Information about the query.

" } } }, "GetNotebookMetadataInput":{ "type":"structure", "required":["NotebookId"], "members":{ "NotebookId":{ "shape":"NotebookId", "documentation":"

The ID of the notebook whose metadata is to be retrieved.

" } } }, "GetNotebookMetadataOutput":{ "type":"structure", "members":{ "NotebookMetadata":{ "shape":"NotebookMetadata", "documentation":"

The metadata that is returned for the specified notebook ID.

" } } }, "GetPreparedStatementInput":{ "type":"structure", "required":[ "StatementName", "WorkGroup" ], "members":{ "StatementName":{ "shape":"StatementName", "documentation":"

The name of the prepared statement to retrieve.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The workgroup to which the statement to be retrieved belongs.

" } } }, "GetPreparedStatementOutput":{ "type":"structure", "members":{ "PreparedStatement":{ "shape":"PreparedStatement", "documentation":"

The name of the prepared statement that was retrieved.

" } } }, "GetQueryExecutionInput":{ "type":"structure", "required":["QueryExecutionId"], "members":{ "QueryExecutionId":{ "shape":"QueryExecutionId", "documentation":"

The unique ID of the query execution.

" } } }, "GetQueryExecutionOutput":{ "type":"structure", "members":{ "QueryExecution":{ "shape":"QueryExecution", "documentation":"

Information about the query execution.

" } } }, "GetQueryResultsInput":{ "type":"structure", "required":["QueryExecutionId"], "members":{ "QueryExecutionId":{ "shape":"QueryExecutionId", "documentation":"

The unique ID of the query execution.

" }, "NextToken":{ "shape":"Token", "documentation":"

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":{ "shape":"MaxQueryResults", "documentation":"

The maximum number of results (rows) to return in this request.

" } } }, "GetQueryResultsOutput":{ "type":"structure", "members":{ "UpdateCount":{ "shape":"Long", "documentation":"

The number of rows inserted with a `CREATE TABLE AS SELECT` statement.

" }, "ResultSet":{ "shape":"ResultSet", "documentation":"

The results of the query execution.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "GetQueryRuntimeStatisticsInput":{ "type":"structure", "required":["QueryExecutionId"], "members":{ "QueryExecutionId":{ "shape":"QueryExecutionId", "documentation":"

The unique ID of the query execution.

" } } }, "GetQueryRuntimeStatisticsOutput":{ "type":"structure", "members":{ "QueryRuntimeStatistics":{ "shape":"QueryRuntimeStatistics", "documentation":"

Runtime statistics about the query execution.

" } } }, "GetSessionRequest":{ "type":"structure", "required":["SessionId"], "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" } } }, "GetSessionResponse":{ "type":"structure", "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

The session description.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The workgroup to which the session belongs.

" }, "EngineVersion":{ "shape":"NameString", "documentation":"

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":{ "shape":"EngineConfiguration", "documentation":"

Contains engine configuration information like DPU usage.

" }, "NotebookVersion":{ "shape":"NameString", "documentation":"

The notebook version.

" }, "SessionConfiguration":{ "shape":"SessionConfiguration", "documentation":"

Contains the workgroup configuration information used by the session.

" }, "Status":{ "shape":"SessionStatus", "documentation":"

Contains information about the status of the session.

" }, "Statistics":{ "shape":"SessionStatistics", "documentation":"

Contains the DPU execution time.

" } } }, "GetSessionStatusRequest":{ "type":"structure", "required":["SessionId"], "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" } } }, "GetSessionStatusResponse":{ "type":"structure", "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" }, "Status":{ "shape":"SessionStatus", "documentation":"

Contains information about the status of the session.

" } } }, "GetTableMetadataInput":{ "type":"structure", "required":[ "CatalogName", "DatabaseName", "TableName" ], "members":{ "CatalogName":{ "shape":"CatalogNameString", "documentation":"

The name of the data catalog that contains the database and table metadata to return.

" }, "DatabaseName":{ "shape":"NameString", "documentation":"

The name of the database that contains the table metadata to return.

" }, "TableName":{ "shape":"NameString", "documentation":"

The name of the table for which metadata is returned.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

" } } }, "GetTableMetadataOutput":{ "type":"structure", "members":{ "TableMetadata":{ "shape":"TableMetadata", "documentation":"

An object that contains table metadata.

" } } }, "GetWorkGroupInput":{ "type":"structure", "required":["WorkGroup"], "members":{ "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup.

" } } }, "GetWorkGroupOutput":{ "type":"structure", "members":{ "WorkGroup":{ "shape":"WorkGroup", "documentation":"

Information about the workgroup.

" } } }, "IdempotencyToken":{ "type":"string", "max":128, "min":32 }, "IdentityCenterApplicationArn":{ "type":"string", "max":255, "min":0, "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" }, "IdentityCenterConfiguration":{ "type":"structure", "members":{ "EnableIdentityCenter":{ "shape":"BoxedBoolean", "documentation":"

Specifies whether the workgroup is IAM Identity Center supported.

" }, "IdentityCenterInstanceArn":{ "shape":"IdentityCenterInstanceArn", "documentation":"

The IAM Identity Center instance ARN that the workgroup associates to.

" } }, "documentation":"

Specifies whether the workgroup is IAM Identity Center supported.

" }, "IdentityCenterInstanceArn":{ "type":"string", "max":255, "min":0, "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" }, "ImportNotebookInput":{ "type":"structure", "required":[ "WorkGroup", "Name", "Payload", "Type" ], "members":{ "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the Spark enabled workgroup to import the notebook to.

" }, "Name":{ "shape":"NotebookName", "documentation":"

The name of the notebook to import.

" }, "Payload":{ "shape":"Payload", "documentation":"

The notebook content to be imported.

" }, "Type":{ "shape":"NotebookType", "documentation":"

The notebook content type. Currently, the only valid type is `IPYNB`.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

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.

" } } }, "ImportNotebookOutput":{ "type":"structure", "members":{ "NotebookId":{ "shape":"NotebookId", "documentation":"

The ID assigned to the imported notebook.

" } } }, "Integer":{"type":"integer"}, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

Indicates a platform issue, which may be due to a transient condition or outage.

", "exception":true, "fault":true }, "InvalidRequestException":{ "type":"structure", "members":{ "AthenaErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

", "exception":true }, "KeyString":{ "type":"string", "max":255, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" }, "KmsKey":{ "type":"string", "max":2048, "min":1, "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}" }, "ListApplicationDPUSizesInput":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxApplicationDPUSizesCount", "documentation":"

Specifies the maximum number of results to return.

" }, "NextToken":{ "shape":"Token", "documentation":"

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

" } } }, "ListApplicationDPUSizesOutput":{ "type":"structure", "members":{ "ApplicationDPUSizes":{ "shape":"ApplicationDPUSizesList", "documentation":"

A list of the supported DPU sizes that the application runtime supports.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListCalculationExecutionsRequest":{ "type":"structure", "required":["SessionId"], "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" }, "StateFilter":{ "shape":"CalculationExecutionState", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxCalculationsCount", "documentation":"

The maximum number of calculation executions to return.

" }, "NextToken":{ "shape":"SessionManagerToken", "documentation":"

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.

" } } }, "ListCalculationExecutionsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"SessionManagerToken", "documentation":"

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":{ "shape":"CalculationsList", "documentation":"

A list of CalculationSummary objects.

" } } }, "ListCapacityReservationsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

" }, "MaxResults":{ "shape":"MaxCapacityReservationsCount", "documentation":"

Specifies the maximum number of results to return.

" } } }, "ListCapacityReservationsOutput":{ "type":"structure", "required":["CapacityReservations"], "members":{ "NextToken":{ "shape":"Token", "documentation":"

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.

" }, "CapacityReservations":{ "shape":"CapacityReservationsList", "documentation":"

The capacity reservations for the current account.

" } } }, "ListDataCatalogsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"

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":{ "shape":"MaxDataCatalogsCount", "documentation":"

Specifies the maximum number of data catalogs to return.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup. Required if making an IAM Identity Center request.

" } } }, "ListDataCatalogsOutput":{ "type":"structure", "members":{ "DataCatalogsSummary":{ "shape":"DataCatalogSummaryList", "documentation":"

A summary list of data catalogs.

" }, "NextToken":{ "shape":"Token", "documentation":"

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":"structure", "required":["CatalogName"], "members":{ "CatalogName":{ "shape":"CatalogNameString", "documentation":"

The name of the data catalog that contains the databases to return.

" }, "NextToken":{ "shape":"Token", "documentation":"

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":{ "shape":"MaxDatabasesCount", "documentation":"

Specifies the maximum number of results to return.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

" } } }, "ListDatabasesOutput":{ "type":"structure", "members":{ "DatabaseList":{ "shape":"DatabaseList", "documentation":"

A list of databases from a data catalog.

" }, "NextToken":{ "shape":"Token", "documentation":"

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":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"

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":{ "shape":"MaxEngineVersionsCount", "documentation":"

The maximum number of engine versions to return in this request.

" } } }, "ListEngineVersionsOutput":{ "type":"structure", "members":{ "EngineVersions":{ "shape":"EngineVersionsList", "documentation":"

A list of engine versions that are available to choose from.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListExecutorsRequest":{ "type":"structure", "required":["SessionId"], "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" }, "ExecutorStateFilter":{ "shape":"ExecutorState", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxListExecutorsCount", "documentation":"

The maximum number of executors to return.

" }, "NextToken":{ "shape":"SessionManagerToken", "documentation":"

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.

" } } }, "ListExecutorsResponse":{ "type":"structure", "required":["SessionId"], "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" }, "NextToken":{ "shape":"SessionManagerToken", "documentation":"

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":{ "shape":"ExecutorsSummaryList", "documentation":"

Contains summary information about the executor.

" } } }, "ListNamedQueriesInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"

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":{ "shape":"MaxNamedQueriesCount", "documentation":"

The maximum number of queries to return in this request.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

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.

" } } }, "ListNamedQueriesOutput":{ "type":"structure", "members":{ "NamedQueryIds":{ "shape":"NamedQueryIdList", "documentation":"

The list of unique query IDs.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListNotebookMetadataInput":{ "type":"structure", "required":["WorkGroup"], "members":{ "Filters":{ "shape":"FilterDefinition", "documentation":"

Search filter string.

" }, "NextToken":{ "shape":"Token", "documentation":"

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

" }, "MaxResults":{ "shape":"MaxNotebooksCount", "documentation":"

Specifies the maximum number of results to return.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the Spark enabled workgroup to retrieve notebook metadata for.

" } } }, "ListNotebookMetadataOutput":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"

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":{ "shape":"NotebookMetadataArray", "documentation":"

The list of notebook metadata for the specified workgroup.

" } } }, "ListNotebookSessionsRequest":{ "type":"structure", "required":["NotebookId"], "members":{ "NotebookId":{ "shape":"NotebookId", "documentation":"

The ID of the notebook to list sessions for.

" }, "MaxResults":{ "shape":"MaxSessionsCount", "documentation":"

The maximum number of notebook sessions to return.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListNotebookSessionsResponse":{ "type":"structure", "required":["NotebookSessionsList"], "members":{ "NotebookSessionsList":{ "shape":"NotebookSessionsList", "documentation":"

A list of the sessions belonging to the notebook.

" }, "NextToken":{ "shape":"Token", "documentation":"

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":"structure", "required":["WorkGroup"], "members":{ "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The workgroup to list the prepared statements for.

" }, "NextToken":{ "shape":"Token", "documentation":"

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":{ "shape":"MaxPreparedStatementsCount", "documentation":"

The maximum number of results to return in this request.

" } } }, "ListPreparedStatementsOutput":{ "type":"structure", "members":{ "PreparedStatements":{ "shape":"PreparedStatementsList", "documentation":"

The list of prepared statements for the workgroup.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListQueryExecutionsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"

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":{ "shape":"MaxQueryExecutionsCount", "documentation":"

The maximum number of query executions to return in this request.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

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.

" } } }, "ListQueryExecutionsOutput":{ "type":"structure", "members":{ "QueryExecutionIds":{ "shape":"QueryExecutionIdList", "documentation":"

The unique IDs of each query execution as an array of strings.

" }, "NextToken":{ "shape":"Token", "documentation":"

A token to be used by the next request if this request is truncated.

" } } }, "ListSessionsRequest":{ "type":"structure", "required":["WorkGroup"], "members":{ "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The workgroup to which the session belongs.

" }, "StateFilter":{ "shape":"SessionState", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxSessionsCount", "documentation":"

The maximum number of sessions to return.

" }, "NextToken":{ "shape":"SessionManagerToken", "documentation":"

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.

" } } }, "ListSessionsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"SessionManagerToken", "documentation":"

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":{ "shape":"SessionsList", "documentation":"

A list of sessions.

" } } }, "ListTableMetadataInput":{ "type":"structure", "required":[ "CatalogName", "DatabaseName" ], "members":{ "CatalogName":{ "shape":"CatalogNameString", "documentation":"

The name of the data catalog for which table metadata should be returned.

" }, "DatabaseName":{ "shape":"NameString", "documentation":"

The name of the database for which table metadata should be returned.

" }, "Expression":{ "shape":"ExpressionString", "documentation":"

A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

" }, "NextToken":{ "shape":"Token", "documentation":"

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":{ "shape":"MaxTableMetadataCount", "documentation":"

Specifies the maximum number of results to return.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

" } } }, "ListTableMetadataOutput":{ "type":"structure", "members":{ "TableMetadataList":{ "shape":"TableMetadataList", "documentation":"

A list of table metadata.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListTagsForResourceInput":{ "type":"structure", "required":["ResourceARN"], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"

Lists the tags for the resource with the specified ARN.

" }, "NextToken":{ "shape":"Token", "documentation":"

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":{ "shape":"MaxTagsCount", "documentation":"

The maximum number of results to be returned per request that lists the tags for the resource.

" } } }, "ListTagsForResourceOutput":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"

The list of tags associated with the specified resource.

" }, "NextToken":{ "shape":"Token", "documentation":"

A token to be used by the next request if this request is truncated.

" } } }, "ListWorkGroupsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"

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":{ "shape":"MaxWorkGroupsCount", "documentation":"

The maximum number of workgroups to return in this request.

" } } }, "ListWorkGroupsOutput":{ "type":"structure", "members":{ "WorkGroups":{ "shape":"WorkGroupsList", "documentation":"

A list of WorkGroupSummary objects that include the names, descriptions, creation times, and states for each workgroup.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "Long":{"type":"long"}, "MaxApplicationDPUSizesCount":{ "type":"integer", "max":100, "min":1 }, "MaxCalculationsCount":{ "type":"integer", "box":true, "max":100, "min":1 }, "MaxCapacityReservationsCount":{ "type":"integer", "box":true, "max":50, "min":1 }, "MaxConcurrentDpus":{ "type":"integer", "max":5000, "min":2 }, "MaxDataCatalogsCount":{ "type":"integer", "box":true, "max":50, "min":2 }, "MaxDatabasesCount":{ "type":"integer", "box":true, "max":50, "min":1 }, "MaxEngineVersionsCount":{ "type":"integer", "box":true, "max":10, "min":1 }, "MaxListExecutorsCount":{ "type":"integer", "box":true, "max":100, "min":1 }, "MaxNamedQueriesCount":{ "type":"integer", "box":true, "max":50, "min":0 }, "MaxNotebooksCount":{ "type":"integer", "box":true, "max":50, "min":1 }, "MaxPreparedStatementsCount":{ "type":"integer", "box":true, "max":50, "min":1 }, "MaxQueryExecutionsCount":{ "type":"integer", "box":true, "max":50, "min":0 }, "MaxQueryResults":{ "type":"integer", "box":true, "max":1000, "min":1 }, "MaxSessionsCount":{ "type":"integer", "box":true, "max":100, "min":1 }, "MaxTableMetadataCount":{ "type":"integer", "box":true, "max":50, "min":1 }, "MaxTagsCount":{ "type":"integer", "box":true, "min":75 }, "MaxWorkGroupsCount":{ "type":"integer", "box":true, "max":50, "min":1 }, "MetadataException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (`InvalidRequestException`) or from the Athena platform (`InternalServerException`). For example, if a user-created Lambda function is missing permissions, the Lambda `4XX` exception is returned in a `MetadataException`.

", "exception":true }, "NameString":{ "type":"string", "max":128, "min":1 }, "NamedQuery":{ "type":"structure", "required":[ "Name", "Database", "QueryString" ], "members":{ "Name":{ "shape":"NameString", "documentation":"

The query name.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

The query description.

" }, "Database":{ "shape":"DatabaseString", "documentation":"

The database to which the query belongs.

" }, "QueryString":{ "shape":"QueryString", "documentation":"

The SQL statements that make up the query.

" }, "NamedQueryId":{ "shape":"NamedQueryId", "documentation":"

The unique identifier of the query.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup that contains the named query.

" } }, "documentation":"

A query, where `QueryString` contains the SQL statements that make up the query.

" }, "NamedQueryDescriptionString":{ "type":"string", "max":1024, "min":0 }, "NamedQueryId":{ "type":"string", "max":128, "min":1, "pattern":"\\S+" }, "NamedQueryIdList":{ "type":"list", "member":{"shape":"NamedQueryId"}, "max":50, "min":1 }, "NamedQueryList":{ "type":"list", "member":{"shape":"NamedQuery"} }, "NotebookId":{ "type":"string", "max":36, "min":1, "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, "NotebookMetadata":{ "type":"structure", "members":{ "NotebookId":{ "shape":"NotebookId", "documentation":"

The notebook ID.

" }, "Name":{ "shape":"NotebookName", "documentation":"

The name of the notebook.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the Spark enabled workgroup to which the notebook belongs.

" }, "CreationTime":{ "shape":"Date", "documentation":"

The time when the notebook was created.

" }, "Type":{ "shape":"NotebookType", "documentation":"

The type of notebook. Currently, the only valid type is `IPYNB`.

" }, "LastModifiedTime":{ "shape":"Date", "documentation":"

The time when the notebook was last modified.

" } }, "documentation":"

Contains metadata for notebook, including the notebook name, ID, workgroup, and time created.

" }, "NotebookMetadataArray":{ "type":"list", "member":{"shape":"NotebookMetadata"} }, "NotebookName":{ "type":"string", "max":255, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]+" }, "NotebookSessionSummary":{ "type":"structure", "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The notebook session ID.

" }, "CreationTime":{ "shape":"Date", "documentation":"

The time when the notebook session was created.

" } }, "documentation":"

Contains the notebook session ID and notebook session creation time.

" }, "NotebookSessionsList":{ "type":"list", "member":{"shape":"NotebookSessionSummary"}, "documentation":"

A list of notebook sessions.

", "max":10, "min":0 }, "NotebookType":{ "type":"string", "enum":["IPYNB"] }, "ParametersMap":{ "type":"map", "key":{"shape":"KeyString"}, "value":{"shape":"ParametersMapValue"} }, "ParametersMapValue":{ "type":"string", "max":51200 }, "Payload":{ "type":"string", "max":10485760, "min":1 }, "PreparedStatement":{ "type":"structure", "members":{ "StatementName":{ "shape":"StatementName", "documentation":"

The name of the prepared statement.

" }, "QueryStatement":{ "shape":"QueryString", "documentation":"

The query string for the prepared statement.

" }, "WorkGroupName":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup to which the prepared statement belongs.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

The description of the prepared statement.

" }, "LastModifiedTime":{ "shape":"Date", "documentation":"

The last modified time of the prepared statement.

" } }, "documentation":"

A prepared SQL statement for use with Athena.

" }, "PreparedStatementDetailsList":{ "type":"list", "member":{"shape":"PreparedStatement"} }, "PreparedStatementNameList":{ "type":"list", "member":{"shape":"StatementName"} }, "PreparedStatementSummary":{ "type":"structure", "members":{ "StatementName":{ "shape":"StatementName", "documentation":"

The name of the prepared statement.

" }, "LastModifiedTime":{ "shape":"Date", "documentation":"

The last modified time of the prepared statement.

" } }, "documentation":"

The name and last modified time of the prepared statement.

" }, "PreparedStatementsList":{ "type":"list", "member":{"shape":"PreparedStatementSummary"}, "max":50, "min":0 }, "PutCapacityAssignmentConfigurationInput":{ "type":"structure", "required":[ "CapacityReservationName", "CapacityAssignments" ], "members":{ "CapacityReservationName":{ "shape":"CapacityReservationName", "documentation":"

The name of the capacity reservation to put a capacity assignment configuration for.

" }, "CapacityAssignments":{ "shape":"CapacityAssignmentsList", "documentation":"

The list of assignments for the capacity assignment configuration.

" } } }, "PutCapacityAssignmentConfigurationOutput":{ "type":"structure", "members":{ } }, "QueryExecution":{ "type":"structure", "members":{ "QueryExecutionId":{ "shape":"QueryExecutionId", "documentation":"

The unique identifier for each query execution.

" }, "Query":{ "shape":"QueryString", "documentation":"

The SQL query statements which the query execution ran.

" }, "StatementType":{ "shape":"StatementType", "documentation":"

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":{ "shape":"ResultConfiguration", "documentation":"

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":{ "shape":"ResultReuseConfiguration", "documentation":"

Specifies the query result reuse behavior that was used for the query.

" }, "QueryExecutionContext":{ "shape":"QueryExecutionContext", "documentation":"

The database in which the query execution occurred.

" }, "Status":{ "shape":"QueryExecutionStatus", "documentation":"

The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

" }, "Statistics":{ "shape":"QueryExecutionStatistics", "documentation":"

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":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup in which the query ran.

" }, "EngineVersion":{ "shape":"EngineVersion", "documentation":"

The engine version that executed the query.

" }, "ExecutionParameters":{ "shape":"ExecutionParameters", "documentation":"

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. The list of parameters is not returned in the response.

" }, "SubstatementType":{ "shape":"String", "documentation":"

The kind of query statement that was run.

" }, "QueryResultsS3AccessGrantsConfiguration":{ "shape":"QueryResultsS3AccessGrantsConfiguration", "documentation":"

Specifies whether Amazon S3 access grants are enabled for query results.

" } }, "documentation":"

Information about a single instance of a query execution.

" }, "QueryExecutionContext":{ "type":"structure", "members":{ "Database":{ "shape":"DatabaseString", "documentation":"

The name of the database used in the query execution. The database must exist in the catalog.

" }, "Catalog":{ "shape":"CatalogNameString", "documentation":"

The name of the data catalog used in the query execution.

" } }, "documentation":"

The database and data catalog context in which the query execution occurs.

" }, "QueryExecutionId":{ "type":"string", "max":128, "min":1, "pattern":"\\S+" }, "QueryExecutionIdList":{ "type":"list", "member":{"shape":"QueryExecutionId"}, "max":50, "min":1 }, "QueryExecutionList":{ "type":"list", "member":{"shape":"QueryExecution"} }, "QueryExecutionState":{ "type":"string", "enum":[ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ] }, "QueryExecutionStatistics":{ "type":"structure", "members":{ "EngineExecutionTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that the query took to execute.

" }, "DataScannedInBytes":{ "shape":"Long", "documentation":"

The number of bytes in the data that was queried.

" }, "DataManifestLocation":{ "shape":"String", "documentation":"

The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

" }, "TotalExecutionTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that Athena took to run the query.

" }, "QueryQueueTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

" }, "ServicePreProcessingTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that Athena took to preprocess the query before submitting the query to the query engine.

" }, "QueryPlanningTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

" }, "ServiceProcessingTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

" }, "ResultReuseInformation":{ "shape":"ResultReuseInformation", "documentation":"

Contains information about whether previous query results were reused for the query.

" } }, "documentation":"

The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.

" }, "QueryExecutionStatus":{ "type":"structure", "members":{ "State":{ "shape":"QueryExecutionState", "documentation":"

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`.

" }, "StateChangeReason":{ "shape":"String", "documentation":"

Further detail about the status of the query.

" }, "SubmissionDateTime":{ "shape":"Date", "documentation":"

The date and time that the query was submitted.

" }, "CompletionDateTime":{ "shape":"Date", "documentation":"

The date and time that the query completed.

" }, "AthenaError":{ "shape":"AthenaError", "documentation":"

Provides information about an Athena query error.

" } }, "documentation":"

The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

" }, "QueryResultsS3AccessGrantsConfiguration":{ "type":"structure", "required":[ "EnableS3AccessGrants", "AuthenticationType" ], "members":{ "EnableS3AccessGrants":{ "shape":"BoxedBoolean", "documentation":"

Specifies whether Amazon S3 access grants are enabled for query results.

" }, "CreateUserLevelPrefix":{ "shape":"BoxedBoolean", "documentation":"

When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

" }, "AuthenticationType":{ "shape":"AuthenticationType", "documentation":"

The authentication type used for Amazon S3 access grants. Currently, only `DIRECTORY_IDENTITY` is supported.

" } }, "documentation":"

Specifies whether Amazon S3 access grants are enabled for query results.

" }, "QueryRuntimeStatistics":{ "type":"structure", "members":{ "Timeline":{"shape":"QueryRuntimeStatisticsTimeline"}, "Rows":{"shape":"QueryRuntimeStatisticsRows"}, "OutputStage":{ "shape":"QueryStage", "documentation":"

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.

" } }, "documentation":"

The query execution timeline, statistics on input and output rows and bytes, and the different query stages that form the query execution plan.

" }, "QueryRuntimeStatisticsRows":{ "type":"structure", "members":{ "InputRows":{ "shape":"Long", "documentation":"

The number of rows read to execute the query.

" }, "InputBytes":{ "shape":"Long", "documentation":"

The number of bytes read to execute the query.

" }, "OutputBytes":{ "shape":"Long", "documentation":"

The number of bytes returned by the query.

" }, "OutputRows":{ "shape":"Long", "documentation":"

The number of rows returned by the query.

" } }, "documentation":"

Statistics such as input rows and bytes read by the query, rows and bytes output by the query, and the number of rows written by the query.

" }, "QueryRuntimeStatisticsTimeline":{ "type":"structure", "members":{ "QueryQueueTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

" }, "ServicePreProcessingTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that Athena spends on preprocessing before it submits the query to the engine.

" }, "QueryPlanningTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

" }, "EngineExecutionTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that the query took to execute.

" }, "ServiceProcessingTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

" }, "TotalExecutionTimeInMillis":{ "shape":"Long", "documentation":"

The number of milliseconds that Athena took to run the query.

" } }, "documentation":"

Timeline statistics such as query queue time, planning time, execution time, service processing time, and total execution time.

" }, "QueryStage":{ "type":"structure", "members":{ "StageId":{ "shape":"Long", "documentation":"

The identifier for a stage.

" }, "State":{ "shape":"String", "documentation":"

State of the stage after query execution.

" }, "OutputBytes":{ "shape":"Long", "documentation":"

The number of bytes output from the stage after execution.

" }, "OutputRows":{ "shape":"Long", "documentation":"

The number of rows output from the stage after execution.

" }, "InputBytes":{ "shape":"Long", "documentation":"

The number of bytes input into the stage for execution.

" }, "InputRows":{ "shape":"Long", "documentation":"

The number of rows input into the stage for execution.

" }, "ExecutionTime":{ "shape":"Long", "documentation":"

Time taken to execute this stage.

" }, "QueryStagePlan":{ "shape":"QueryStagePlanNode", "documentation":"

Stage plan information such as name, identifier, sub plans, and source stages.

" }, "SubStages":{ "shape":"QueryStages", "documentation":"

List of sub query stages that form this stage execution plan.

" } }, "documentation":"

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.

" }, "QueryStagePlanNode":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

Name of the query stage plan that describes the operation this stage is performing as part of query execution.

" }, "Identifier":{ "shape":"String", "documentation":"

Information about the operation this query stage plan node is performing.

" }, "Children":{ "shape":"QueryStagePlanNodes", "documentation":"

Stage plan information such as name, identifier, sub plans, and remote sources of child plan nodes/

" }, "RemoteSources":{ "shape":"StringList", "documentation":"

Source plan node IDs.

" } }, "documentation":"

Stage plan information such as name, identifier, sub plans, and remote sources.

" }, "QueryStagePlanNodes":{ "type":"list", "member":{"shape":"QueryStagePlanNode"} }, "QueryStages":{ "type":"list", "member":{"shape":"QueryStage"} }, "QueryString":{ "type":"string", "max":262144, "min":1 }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"}, "ResourceName":{ "shape":"AmazonResourceName", "documentation":"

The name of the Amazon resource.

" } }, "documentation":"

A resource, such as a workgroup, was not found.

", "exception":true }, "ResultConfiguration":{ "type":"structure", "members":{ "OutputLocation":{ "shape":"ResultOutputLocation", "documentation":"

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":{ "shape":"EncryptionConfiguration", "documentation":"

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":{ "shape":"AwsAccountId", "documentation":"

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.

" }, "AclConfiguration":{ "shape":"AclConfiguration", "documentation":"

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is `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.

" } }, "documentation":"

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.

" }, "ResultConfigurationUpdates":{ "type":"structure", "members":{ "OutputLocation":{ "shape":"ResultOutputLocation", "documentation":"

The location in Amazon S3 where your query and calculation results are stored, such as `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":{ "shape":"BoxedBoolean", "documentation":"

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":{ "shape":"EncryptionConfiguration", "documentation":"

The encryption configuration for query and calculation results.

" }, "RemoveEncryptionConfiguration":{ "shape":"BoxedBoolean", "documentation":"

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":{ "shape":"AwsAccountId", "documentation":"

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.

" }, "RemoveExpectedBucketOwner":{ "shape":"BoxedBoolean", "documentation":"

If set to \"true\", removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner. If set to \"false\" or not set, and a value is present in the `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":{ "shape":"AclConfiguration", "documentation":"

The ACL configuration for the query results.

" }, "RemoveAclConfiguration":{ "shape":"BoxedBoolean", "documentation":"

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.

" } }, "documentation":"

The information about the updates in the query results, such as output location and encryption configuration for the query results.

" }, "ResultOutputLocation":{"type":"string"}, "ResultReuseByAgeConfiguration":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

True if previous query results can be reused when the query is run; otherwise, false. The default is false.

" }, "MaxAgeInMinutes":{ "shape":"Age", "documentation":"

Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60.

" } }, "documentation":"

Specifies whether previous query results are reused, and if so, their maximum age.

" }, "ResultReuseConfiguration":{ "type":"structure", "members":{ "ResultReuseByAgeConfiguration":{ "shape":"ResultReuseByAgeConfiguration", "documentation":"

Specifies whether previous query results are reused, and if so, their maximum age.

" } }, "documentation":"

Specifies the query result reuse behavior for the query.

" }, "ResultReuseInformation":{ "type":"structure", "required":["ReusedPreviousResult"], "members":{ "ReusedPreviousResult":{ "shape":"Boolean", "documentation":"

True if a previous query result was reused; false if the result was generated from a new run of the query.

" } }, "documentation":"

Contains information about whether the result of a previous query was reused.

" }, "ResultSet":{ "type":"structure", "members":{ "Rows":{ "shape":"RowList", "documentation":"

The rows in the table.

" }, "ResultSetMetadata":{ "shape":"ResultSetMetadata", "documentation":"

The metadata that describes the column structure and data types of a table of query results.

" } }, "documentation":"

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.

" }, "ResultSetMetadata":{ "type":"structure", "members":{ "ColumnInfo":{ "shape":"ColumnInfoList", "documentation":"

Information about the columns returned in a query result metadata.

" } }, "documentation":"

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", "max":2048, "min":20, "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" }, "Row":{ "type":"structure", "members":{ "Data":{ "shape":"datumList", "documentation":"

The data that populates a row in a query result table.

" } }, "documentation":"

The rows that make up a query result table.

" }, "RowList":{ "type":"list", "member":{"shape":"Row"} }, "S3AclOption":{ "type":"string", "enum":["BUCKET_OWNER_FULL_CONTROL"] }, "S3Uri":{ "type":"string", "max":1024, "pattern":"^(https|s3|S3)://([^/]+)/?(.*)$" }, "SessionAlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The specified session already exists.

", "exception":true }, "SessionConfiguration":{ "type":"structure", "members":{ "ExecutionRole":{ "shape":"RoleArn", "documentation":"

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

" }, "WorkingDirectory":{ "shape":"ResultOutputLocation", "documentation":"

The Amazon S3 location that stores information for the notebook.

" }, "IdleTimeoutSeconds":{ "shape":"Long", "documentation":"

The idle timeout in seconds for the session.

" }, "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} }, "documentation":"

Contains session configuration information.

" }, "SessionId":{ "type":"string", "max":256, "min":1 }, "SessionIdleTimeoutInMinutes":{ "type":"integer", "box":true, "max":480, "min":1 }, "SessionManagerToken":{ "type":"string", "max":2048 }, "SessionState":{ "type":"string", "enum":[ "CREATING", "CREATED", "IDLE", "BUSY", "TERMINATING", "TERMINATED", "DEGRADED", "FAILED" ] }, "SessionStatistics":{ "type":"structure", "members":{ "DpuExecutionInMillis":{ "shape":"Long", "documentation":"

The data processing unit execution time for a session in milliseconds.

" } }, "documentation":"

Contains statistics for a session.

" }, "SessionStatus":{ "type":"structure", "members":{ "StartDateTime":{ "shape":"Date", "documentation":"

The date and time that the session started.

" }, "LastModifiedDateTime":{ "shape":"Date", "documentation":"

The most recent date and time that the session was modified.

" }, "EndDateTime":{ "shape":"Date", "documentation":"

The date and time that the session ended.

" }, "IdleSinceDateTime":{ "shape":"Date", "documentation":"

The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

" }, "State":{ "shape":"SessionState", "documentation":"

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.

" }, "StateChangeReason":{ "shape":"DescriptionString", "documentation":"

The reason for the session state change (for example, canceled because the session was terminated).

" } }, "documentation":"

Contains information about the status of a session.

" }, "SessionSummary":{ "type":"structure", "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

The session description.

" }, "EngineVersion":{ "shape":"EngineVersion", "documentation":"

The engine version used by the session (for example, `PySpark engine version 3`).

" }, "NotebookVersion":{ "shape":"NameString", "documentation":"

The notebook version.

" }, "Status":{ "shape":"SessionStatus", "documentation":"

Contains information about the session status.

" } }, "documentation":"

Contains summary information about a session.

" }, "SessionsList":{ "type":"list", "member":{"shape":"SessionSummary"}, "max":100, "min":0 }, "StartCalculationExecutionRequest":{ "type":"structure", "required":["SessionId"], "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

A description of the calculation.

" }, "CalculationConfiguration":{ "shape":"CalculationConfiguration", "documentation":"

Contains configuration information for the calculation.

", "deprecated":true, "deprecatedMessage":"Kepler Post GA Tasks : https://sim.amazon.com/issues/ATHENA-39828" }, "CodeBlock":{ "shape":"CodeBlock", "documentation":"

A string that contains the code of the calculation. Use this parameter instead of CalculationConfiguration$CodeBlock, which is deprecated.

" }, "ClientRequestToken":{ "shape":"IdempotencyToken", "documentation":"

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.

" } } }, "StartCalculationExecutionResponse":{ "type":"structure", "members":{ "CalculationExecutionId":{ "shape":"CalculationExecutionId", "documentation":"

The calculation execution UUID.

" }, "State":{ "shape":"CalculationExecutionState", "documentation":"

`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.

" } } }, "StartQueryExecutionInput":{ "type":"structure", "required":["QueryString"], "members":{ "QueryString":{ "shape":"QueryString", "documentation":"

The SQL query statements to be executed.

" }, "ClientRequestToken":{ "shape":"IdempotencyToken", "documentation":"

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. An error is returned if a parameter, such as `QueryString`, has changed. A call to `StartQueryExecution` that uses a previous client request token returns the same `QueryExecutionId` even if the requester doesn't have permission on the tables specified in `QueryString`.

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.

", "idempotencyToken":true }, "QueryExecutionContext":{ "shape":"QueryExecutionContext", "documentation":"

The database within which the query executes.

" }, "ResultConfiguration":{ "shape":"ResultConfiguration", "documentation":"

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup in which the query is being started.

" }, "ExecutionParameters":{ "shape":"ExecutionParameters", "documentation":"

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.

" }, "ResultReuseConfiguration":{ "shape":"ResultReuseConfiguration", "documentation":"

Specifies the query result reuse behavior for the query.

" } } }, "StartQueryExecutionOutput":{ "type":"structure", "members":{ "QueryExecutionId":{ "shape":"QueryExecutionId", "documentation":"

The unique ID of the query that ran as a result of this request.

" } } }, "StartSessionRequest":{ "type":"structure", "required":[ "WorkGroup", "EngineConfiguration" ], "members":{ "Description":{ "shape":"DescriptionString", "documentation":"

The session description.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The workgroup to which the session belongs.

" }, "EngineConfiguration":{ "shape":"EngineConfiguration", "documentation":"

Contains engine data processing unit (DPU) configuration settings and parameter mappings.

" }, "NotebookVersion":{ "shape":"NameString", "documentation":"

The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is `Athena notebook version 1`. If you specify a value for `NotebookVersion`, you must also specify a value for `NotebookId`. See EngineConfiguration$AdditionalConfigs.

" }, "SessionIdleTimeoutInMinutes":{ "shape":"SessionIdleTimeoutInMinutes", "documentation":"

The idle timeout in minutes for the session.

" }, "ClientRequestToken":{ "shape":"IdempotencyToken", "documentation":"

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.

" } } }, "StartSessionResponse":{ "type":"structure", "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" }, "State":{ "shape":"SessionState", "documentation":"

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.

" } } }, "StatementName":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z_][a-zA-Z0-9_@:]{1,256}" }, "StatementType":{ "type":"string", "enum":[ "DDL", "DML", "UTILITY" ] }, "StopCalculationExecutionRequest":{ "type":"structure", "required":["CalculationExecutionId"], "members":{ "CalculationExecutionId":{ "shape":"CalculationExecutionId", "documentation":"

The calculation execution UUID.

" } } }, "StopCalculationExecutionResponse":{ "type":"structure", "members":{ "State":{ "shape":"CalculationExecutionState", "documentation":"

`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.

" } } }, "StopQueryExecutionInput":{ "type":"structure", "required":["QueryExecutionId"], "members":{ "QueryExecutionId":{ "shape":"QueryExecutionId", "documentation":"

The unique ID of the query execution to stop.

", "idempotencyToken":true } } }, "StopQueryExecutionOutput":{ "type":"structure", "members":{ } }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "SupportedDPUSizeList":{ "type":"list", "member":{"shape":"Integer"} }, "TableMetadata":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"NameString", "documentation":"

The name of the table.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

The time that the table was created.

" }, "LastAccessTime":{ "shape":"Timestamp", "documentation":"

The last time the table was accessed.

" }, "TableType":{ "shape":"TableTypeString", "documentation":"

The type of table. In Athena, only `EXTERNAL_TABLE` is supported.

" }, "Columns":{ "shape":"ColumnList", "documentation":"

A list of the columns in the table.

" }, "PartitionKeys":{ "shape":"ColumnList", "documentation":"

A list of the partition keys in the table.

" }, "Parameters":{ "shape":"ParametersMap", "documentation":"

A set of custom key/value pairs for table properties.

" } }, "documentation":"

Contains metadata for a table.

" }, "TableMetadataList":{ "type":"list", "member":{"shape":"TableMetadata"} }, "TableTypeString":{ "type":"string", "max":255 }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

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":{ "shape":"TagValue", "documentation":"

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.

" } }, "documentation":"

A label that you assign to a resource. Athena resources include workgroups, data catalogs, and capacity reservations. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena resources by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources 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.

" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"} }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagResourceInput":{ "type":"structure", "required":[ "ResourceARN", "Tags" ], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"

Specifies the ARN of the Athena resource to which tags are to be added.

" }, "Tags":{ "shape":"TagList", "documentation":"

A collection of one or more tags, separated by commas, to be added to an Athena resource.

" } } }, "TagResourceOutput":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "TargetDpusInteger":{ "type":"integer", "box":true, "min":24 }, "TerminateSessionRequest":{ "type":"structure", "required":["SessionId"], "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The session ID.

" } } }, "TerminateSessionResponse":{ "type":"structure", "members":{ "State":{ "shape":"SessionState", "documentation":"

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.

" } } }, "ThrottleReason":{ "type":"string", "documentation":"

The reason for the query throttling, for example, when it exceeds the concurrent query limit.

", "enum":["CONCURRENT_QUERY_LIMIT_EXCEEDED"] }, "Timestamp":{"type":"timestamp"}, "Token":{ "type":"string", "max":1024, "min":1 }, "TooManyRequestsException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"}, "Reason":{"shape":"ThrottleReason"} }, "documentation":"

Indicates that the request was throttled.

", "exception":true }, "TypeString":{ "type":"string", "max":4096, "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" }, "UnprocessedNamedQueryId":{ "type":"structure", "members":{ "NamedQueryId":{ "shape":"NamedQueryId", "documentation":"

The unique identifier of the named query.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code returned when the processing request for the named query failed, if applicable.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message returned when the processing request for the named query failed, if applicable.

" } }, "documentation":"

Information about a named query ID that could not be processed.

" }, "UnprocessedNamedQueryIdList":{ "type":"list", "member":{"shape":"UnprocessedNamedQueryId"} }, "UnprocessedPreparedStatementName":{ "type":"structure", "members":{ "StatementName":{ "shape":"StatementName", "documentation":"

The name of a prepared statement that could not be returned due to an error.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code returned when the request for the prepared statement failed.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

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.

" } }, "documentation":"

The name of a prepared statement that could not be returned.

" }, "UnprocessedPreparedStatementNameList":{ "type":"list", "member":{"shape":"UnprocessedPreparedStatementName"} }, "UnprocessedQueryExecutionId":{ "type":"structure", "members":{ "QueryExecutionId":{ "shape":"QueryExecutionId", "documentation":"

The unique identifier of the query execution.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code returned when the query execution failed to process, if applicable.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message returned when the query execution failed to process, if applicable.

" } }, "documentation":"

Describes a query execution that failed to process.

" }, "UnprocessedQueryExecutionIdList":{ "type":"list", "member":{"shape":"UnprocessedQueryExecutionId"} }, "UntagResourceInput":{ "type":"structure", "required":[ "ResourceARN", "TagKeys" ], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"

Specifies the ARN of the resource from which tags are to be removed.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A comma-separated list of one or more tag keys whose tags are to be removed from the specified resource.

" } } }, "UntagResourceOutput":{ "type":"structure", "members":{ } }, "UpdateCapacityReservationInput":{ "type":"structure", "required":[ "TargetDpus", "Name" ], "members":{ "TargetDpus":{ "shape":"TargetDpusInteger", "documentation":"

The new number of requested data processing units.

" }, "Name":{ "shape":"CapacityReservationName", "documentation":"

The name of the capacity reservation.

" } } }, "UpdateCapacityReservationOutput":{ "type":"structure", "members":{ } }, "UpdateDataCatalogInput":{ "type":"structure", "required":[ "Name", "Type" ], "members":{ "Name":{ "shape":"CatalogNameString", "documentation":"

The name of the data catalog to update. 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":{ "shape":"DataCatalogType", "documentation":"

Specifies the type of data catalog to update. Specify `LAMBDA` for a federated catalog, `HIVE` for an external hive metastore, or `GLUE` for an Glue Data Catalog.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

New or modified text that describes the data catalog.

" }, "Parameters":{ "shape":"ParametersMap", "documentation":"

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`

" } } }, "UpdateDataCatalogOutput":{ "type":"structure", "members":{ } }, "UpdateNamedQueryInput":{ "type":"structure", "required":[ "NamedQueryId", "Name", "QueryString" ], "members":{ "NamedQueryId":{ "shape":"NamedQueryId", "documentation":"

The unique identifier (UUID) of the query.

" }, "Name":{ "shape":"NameString", "documentation":"

The name of the query.

" }, "Description":{ "shape":"NamedQueryDescriptionString", "documentation":"

The query description.

" }, "QueryString":{ "shape":"QueryString", "documentation":"

The contents of the query with all query statements.

" } } }, "UpdateNamedQueryOutput":{ "type":"structure", "members":{ } }, "UpdateNotebookInput":{ "type":"structure", "required":[ "NotebookId", "Payload", "Type" ], "members":{ "NotebookId":{ "shape":"NotebookId", "documentation":"

The ID of the notebook to update.

" }, "Payload":{ "shape":"Payload", "documentation":"

The updated content for the notebook.

" }, "Type":{ "shape":"NotebookType", "documentation":"

The notebook content type. Currently, the only valid type is `IPYNB`.

" }, "SessionId":{ "shape":"SessionId", "documentation":"

The active notebook session ID. Required if the notebook has an active session.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

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.

" } } }, "UpdateNotebookMetadataInput":{ "type":"structure", "required":[ "NotebookId", "Name" ], "members":{ "NotebookId":{ "shape":"NotebookId", "documentation":"

The ID of the notebook to update the metadata for.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

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.

" }, "Name":{ "shape":"NotebookName", "documentation":"

The name to update the notebook to.

" } } }, "UpdateNotebookMetadataOutput":{ "type":"structure", "members":{ } }, "UpdateNotebookOutput":{ "type":"structure", "members":{ } }, "UpdatePreparedStatementInput":{ "type":"structure", "required":[ "StatementName", "WorkGroup", "QueryStatement" ], "members":{ "StatementName":{ "shape":"StatementName", "documentation":"

The name of the prepared statement.

" }, "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The workgroup for the prepared statement.

" }, "QueryStatement":{ "shape":"QueryString", "documentation":"

The query string for the prepared statement.

" }, "Description":{ "shape":"DescriptionString", "documentation":"

The description of the prepared statement.

" } } }, "UpdatePreparedStatementOutput":{ "type":"structure", "members":{ } }, "UpdateWorkGroupInput":{ "type":"structure", "required":["WorkGroup"], "members":{ "WorkGroup":{ "shape":"WorkGroupName", "documentation":"

The specified workgroup that will be updated.

" }, "Description":{ "shape":"WorkGroupDescriptionString", "documentation":"

The workgroup description.

" }, "ConfigurationUpdates":{ "shape":"WorkGroupConfigurationUpdates", "documentation":"

Contains configuration updates for an Athena SQL workgroup.

" }, "State":{ "shape":"WorkGroupState", "documentation":"

The workgroup state that will be updated for the given workgroup.

" } } }, "UpdateWorkGroupOutput":{ "type":"structure", "members":{ } }, "WorkGroup":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"WorkGroupName", "documentation":"

The workgroup name.

" }, "State":{ "shape":"WorkGroupState", "documentation":"

The state of the workgroup: ENABLED or DISABLED.

" }, "Configuration":{ "shape":"WorkGroupConfiguration", "documentation":"

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":{ "shape":"WorkGroupDescriptionString", "documentation":"

The workgroup description.

" }, "CreationTime":{ "shape":"Date", "documentation":"

The date and time the workgroup was created.

" }, "IdentityCenterApplicationArn":{ "shape":"IdentityCenterApplicationArn", "documentation":"

The ARN of the IAM Identity Center enabled application associated with the workgroup.

" } }, "documentation":"

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.

" }, "WorkGroupConfiguration":{ "type":"structure", "members":{ "ResultConfiguration":{ "shape":"ResultConfiguration", "documentation":"

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":{ "shape":"BoxedBoolean", "documentation":"

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":{ "shape":"BoxedBoolean", "documentation":"

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

" }, "BytesScannedCutoffPerQuery":{ "shape":"BytesScannedCutoffValue", "documentation":"

The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

" }, "RequesterPaysEnabled":{ "shape":"BoxedBoolean", "documentation":"

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":{ "shape":"EngineVersion", "documentation":"

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":{ "shape":"NameString", "documentation":"

Specifies a user defined JSON string that is passed to the notebook engine.

" }, "ExecutionRole":{ "shape":"RoleArn", "documentation":"

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

" }, "CustomerContentEncryptionConfiguration":{ "shape":"CustomerContentEncryptionConfiguration", "documentation":"

Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

" }, "EnableMinimumEncryptionConfiguration":{ "shape":"BoxedBoolean", "documentation":"

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.

" }, "IdentityCenterConfiguration":{ "shape":"IdentityCenterConfiguration", "documentation":"

Specifies whether the workgroup is IAM Identity Center supported.

" }, "QueryResultsS3AccessGrantsConfiguration":{ "shape":"QueryResultsS3AccessGrantsConfiguration", "documentation":"

Specifies whether Amazon S3 access grants are enabled for query results.

" } }, "documentation":"

The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query and calculation results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query 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.

" }, "WorkGroupConfigurationUpdates":{ "type":"structure", "members":{ "EnforceWorkGroupConfiguration":{ "shape":"BoxedBoolean", "documentation":"

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.

" }, "ResultConfigurationUpdates":{ "shape":"ResultConfigurationUpdates", "documentation":"

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

" }, "PublishCloudWatchMetricsEnabled":{ "shape":"BoxedBoolean", "documentation":"

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

" }, "BytesScannedCutoffPerQuery":{ "shape":"BytesScannedCutoffValue", "documentation":"

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

" }, "RemoveBytesScannedCutoffPerQuery":{ "shape":"BoxedBoolean", "documentation":"

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

" }, "RequesterPaysEnabled":{ "shape":"BoxedBoolean", "documentation":"

If set to `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":{ "shape":"EngineVersion", "documentation":"

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":{ "shape":"BoxedBoolean", "documentation":"

Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.

" }, "AdditionalConfiguration":{ "shape":"NameString", "documentation":"

Contains a user defined string in JSON format for a Spark-enabled workgroup.

" }, "ExecutionRole":{ "shape":"RoleArn", "documentation":"

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

" }, "CustomerContentEncryptionConfiguration":{"shape":"CustomerContentEncryptionConfiguration"}, "EnableMinimumEncryptionConfiguration":{ "shape":"BoxedBoolean", "documentation":"

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.

" }, "QueryResultsS3AccessGrantsConfiguration":{ "shape":"QueryResultsS3AccessGrantsConfiguration", "documentation":"

Specifies whether Amazon S3 access grants are enabled for query results.

" } }, "documentation":"

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

" }, "WorkGroupDescriptionString":{ "type":"string", "max":1024, "min":0 }, "WorkGroupName":{ "type":"string", "pattern":"[a-zA-Z0-9._-]{1,128}" }, "WorkGroupNamesList":{ "type":"list", "member":{"shape":"WorkGroupName"} }, "WorkGroupState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "WorkGroupSummary":{ "type":"structure", "members":{ "Name":{ "shape":"WorkGroupName", "documentation":"

The name of the workgroup.

" }, "State":{ "shape":"WorkGroupState", "documentation":"

The state of the workgroup.

" }, "Description":{ "shape":"WorkGroupDescriptionString", "documentation":"

The workgroup description.

" }, "CreationTime":{ "shape":"Date", "documentation":"

The workgroup creation date and time.

" }, "EngineVersion":{ "shape":"EngineVersion", "documentation":"

The engine version setting for all queries on the workgroup. Queries on the `AmazonAthenaPreviewFunctionality` workgroup run on the preview engine regardless of this setting.

" }, "IdentityCenterApplicationArn":{ "shape":"IdentityCenterApplicationArn", "documentation":"

The ARN of the IAM Identity Center enabled application associated with the workgroup.

" } }, "documentation":"

The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.

" }, "WorkGroupsList":{ "type":"list", "member":{"shape":"WorkGroupSummary"}, "max":50, "min":0 }, "datumList":{ "type":"list", "member":{"shape":"Datum"} }, "datumString":{"type":"string"} }, "documentation":"

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.

" }