Amazon Athena is an interactive query service that lets you use standard SQL to\n analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and\n run ad-hoc queries and get results in seconds. Athena is serverless, so there is no\n infrastructure to set up or manage. You pay only for the queries you run. Athena scales\n automatically—executing queries in parallel—so results are fast, even with large\n datasets and complex queries. For more information, see What is Amazon\n Athena in the Amazon Athena User Guide.
\nIf you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or\n later with the Amazon Athena API. Earlier version drivers do not support the API. For\n more information and to download the driver, see Accessing\n Amazon Athena with JDBC.
\nFor code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.
", "smithy.api#title": "Amazon Athena" } }, "com.amazonaws.athena#AmazonResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 } } }, "com.amazonaws.athena#BatchGetNamedQuery": { "type": "operation", "input": { "target": "com.amazonaws.athena#BatchGetNamedQueryInput" }, "output": { "target": "com.amazonaws.athena#BatchGetNamedQueryOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Returns the details of a single named query or a list of up to 50 queries, which you\n provide as an array of query ID strings. Requires you to have access to the workgroup in\n which the queries were saved. Use ListNamedQueriesInput to get the\n list of named query IDs in the specified workgroup. If information could not be\n retrieved for a submitted query ID, information about the query ID submitted is listed\n under UnprocessedNamedQueryId. Named queries differ from executed\n queries. Use BatchGetQueryExecutionInput to get details about each\n unique query execution, and ListQueryExecutionsInput to get a list of\n query execution IDs.
" } }, "com.amazonaws.athena#BatchGetNamedQueryInput": { "type": "structure", "members": { "NamedQueryIds": { "target": "com.amazonaws.athena#NamedQueryIdList", "traits": { "smithy.api#documentation": "An array of query IDs.
", "smithy.api#required": {} } } } }, "com.amazonaws.athena#BatchGetNamedQueryOutput": { "type": "structure", "members": { "NamedQueries": { "target": "com.amazonaws.athena#NamedQueryList", "traits": { "smithy.api#documentation": "Information about the named query IDs submitted.
" } }, "UnprocessedNamedQueryIds": { "target": "com.amazonaws.athena#UnprocessedNamedQueryIdList", "traits": { "smithy.api#documentation": "Information about provided query IDs.
" } } } }, "com.amazonaws.athena#BatchGetQueryExecution": { "type": "operation", "input": { "target": "com.amazonaws.athena#BatchGetQueryExecutionInput" }, "output": { "target": "com.amazonaws.athena#BatchGetQueryExecutionOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Returns the details of a single query execution or a list of up to 50 query\n executions, which you provide as an array of query execution ID strings. Requires you to\n have access to the workgroup in which the queries ran. To get a list of query execution\n IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ\n from named (saved) queries. Use BatchGetNamedQueryInput to get details\n about named queries.
" } }, "com.amazonaws.athena#BatchGetQueryExecutionInput": { "type": "structure", "members": { "QueryExecutionIds": { "target": "com.amazonaws.athena#QueryExecutionIdList", "traits": { "smithy.api#documentation": "An array of query execution IDs.
", "smithy.api#required": {} } } } }, "com.amazonaws.athena#BatchGetQueryExecutionOutput": { "type": "structure", "members": { "QueryExecutions": { "target": "com.amazonaws.athena#QueryExecutionList", "traits": { "smithy.api#documentation": "Information about a query execution.
" } }, "UnprocessedQueryExecutionIds": { "target": "com.amazonaws.athena#UnprocessedQueryExecutionIdList", "traits": { "smithy.api#documentation": "Information about the query executions that failed to run.
" } } } }, "com.amazonaws.athena#Boolean": { "type": "boolean" }, "com.amazonaws.athena#BoxedBoolean": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.athena#BytesScannedCutoffValue": { "type": "long", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 10000000 } } }, "com.amazonaws.athena#CatalogNameString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" } }, "com.amazonaws.athena#Column": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.athena#NameString", "traits": { "smithy.api#documentation": "The name of the column.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.athena#TypeString", "traits": { "smithy.api#documentation": "The data type of the column.
" } }, "Comment": { "target": "com.amazonaws.athena#CommentString", "traits": { "smithy.api#documentation": "Optional information about the column.
" } } }, "traits": { "smithy.api#documentation": "Contains metadata for a column in a table.
" } }, "com.amazonaws.athena#ColumnInfo": { "type": "structure", "members": { "CatalogName": { "target": "com.amazonaws.athena#String", "traits": { "smithy.api#documentation": "The catalog to which the query results belong.
" } }, "SchemaName": { "target": "com.amazonaws.athena#String", "traits": { "smithy.api#documentation": "The schema name (database name) to which the query results belong.
" } }, "TableName": { "target": "com.amazonaws.athena#String", "traits": { "smithy.api#documentation": "The table name for the query results.
" } }, "Name": { "target": "com.amazonaws.athena#String", "traits": { "smithy.api#documentation": "The name of the column.
", "smithy.api#required": {} } }, "Label": { "target": "com.amazonaws.athena#String", "traits": { "smithy.api#documentation": "A column label.
" } }, "Type": { "target": "com.amazonaws.athena#String", "traits": { "smithy.api#documentation": "The data type of the column.
", "smithy.api#required": {} } }, "Precision": { "target": "com.amazonaws.athena#Integer", "traits": { "smithy.api#documentation": "For DECIMAL data types, specifies the total number of digits, up to 38.\n For performance reasons, we recommend up to 18 digits.
For DECIMAL data types, specifies the total number of digits in the\n fractional part of the value. Defaults to 0.
Indicates the column's nullable status.
" } }, "CaseSensitive": { "target": "com.amazonaws.athena#Boolean", "traits": { "smithy.api#documentation": "Indicates whether values in the column are case-sensitive.
" } } }, "traits": { "smithy.api#documentation": "Information about the columns in a query execution result.
" } }, "com.amazonaws.athena#ColumnInfoList": { "type": "list", "member": { "target": "com.amazonaws.athena#ColumnInfo" } }, "com.amazonaws.athena#ColumnList": { "type": "list", "member": { "target": "com.amazonaws.athena#Column" } }, "com.amazonaws.athena#ColumnNullable": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NOT_NULL", "name": "NOT_NULL" }, { "value": "NULLABLE", "name": "NULLABLE" }, { "value": "UNKNOWN", "name": "UNKNOWN" } ] } }, "com.amazonaws.athena#CommentString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" } }, "com.amazonaws.athena#CreateDataCatalog": { "type": "operation", "input": { "target": "com.amazonaws.athena#CreateDataCatalogInput" }, "output": { "target": "com.amazonaws.athena#CreateDataCatalogOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Creates (registers) a data catalog with the specified name and properties. Catalogs\n created are visible to all users of the same AWS account.
" } }, "com.amazonaws.athena#CreateDataCatalogInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { "smithy.api#documentation": "The name of the data catalog to create. The catalog name must be unique for the AWS\n account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen\n characters.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { "smithy.api#documentation": "The type of data catalog to create: LAMBDA for a federated catalog or\n HIVE for an external hive metastore.
Do not use the GLUE type. This refers to the\n AwsDataCatalog that already exists in your account, of which you\n can have only one. Specifying the GLUE type will result in an\n INVALID_INPUT error.
A description of the data catalog to be created.
" } }, "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { "smithy.api#documentation": "Specifies the Lambda function or functions to use for creating the data catalog. This\n is a mapping whose values depend on the catalog type.
\nFor the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.
\n metadata-function=lambda_arn,\n sdk-version=version_number\n \n
For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.
If you have one Lambda function that processes metadata and another\n for reading the actual data, use the following syntax. Both parameters\n are required.
\n\n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n
If you have a composite Lambda function that processes both metadata\n and data, use the following syntax to specify your Lambda\n function.
\n\n function=lambda_arn\n \n
A list of comma separated tags to add to the data catalog that is created.
" } } } }, "com.amazonaws.athena#CreateDataCatalogOutput": { "type": "structure", "members": {} }, "com.amazonaws.athena#CreateNamedQuery": { "type": "operation", "input": { "target": "com.amazonaws.athena#CreateNamedQueryInput" }, "output": { "target": "com.amazonaws.athena#CreateNamedQueryOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Creates a named query in the specified workgroup. Requires that you have access to the\n workgroup.
\nFor code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.
", "smithy.api#idempotent": {} } }, "com.amazonaws.athena#CreateNamedQueryInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.athena#NameString", "traits": { "smithy.api#documentation": "The query name.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.athena#DescriptionString", "traits": { "smithy.api#documentation": "The query description.
" } }, "Database": { "target": "com.amazonaws.athena#DatabaseString", "traits": { "smithy.api#documentation": "The database to which the query belongs.
", "smithy.api#required": {} } }, "QueryString": { "target": "com.amazonaws.athena#QueryString", "traits": { "smithy.api#documentation": "The contents of the query with all query statements.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.athena#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another CreateNamedQuery request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.
This token is listed as not required because AWS SDKs (for example the AWS SDK for\n Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS\n CLI, you must provide this token or the action will fail.
\nThe name of the workgroup in which the named query is being created.
" } } } }, "com.amazonaws.athena#CreateNamedQueryOutput": { "type": "structure", "members": { "NamedQueryId": { "target": "com.amazonaws.athena#NamedQueryId", "traits": { "smithy.api#documentation": "The unique ID of the query.
" } } } }, "com.amazonaws.athena#CreatePreparedStatement": { "type": "operation", "input": { "target": "com.amazonaws.athena#CreatePreparedStatementInput" }, "output": { "target": "com.amazonaws.athena#CreatePreparedStatementOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Creates a prepared statement for use with SQL queries in Athena.
" } }, "com.amazonaws.athena#CreatePreparedStatementInput": { "type": "structure", "members": { "StatementName": { "target": "com.amazonaws.athena#StatementName", "traits": { "smithy.api#documentation": "The name of the prepared statement.
", "smithy.api#required": {} } }, "WorkGroup": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "The name of the workgroup to which the prepared statement belongs.
", "smithy.api#required": {} } }, "QueryStatement": { "target": "com.amazonaws.athena#QueryString", "traits": { "smithy.api#documentation": "The query string for the prepared statement.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.athena#DescriptionString", "traits": { "smithy.api#documentation": "The description of the prepared statement.
" } } } }, "com.amazonaws.athena#CreatePreparedStatementOutput": { "type": "structure", "members": {} }, "com.amazonaws.athena#CreateWorkGroup": { "type": "operation", "input": { "target": "com.amazonaws.athena#CreateWorkGroupInput" }, "output": { "target": "com.amazonaws.athena#CreateWorkGroupOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Creates a workgroup with the specified name.
" } }, "com.amazonaws.athena#CreateWorkGroupInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "The workgroup name.
", "smithy.api#required": {} } }, "Configuration": { "target": "com.amazonaws.athena#WorkGroupConfiguration", "traits": { "smithy.api#documentation": "The configuration for the workgroup, which includes the location in Amazon S3 where\n query results are stored, the encryption configuration, if any, used for encrypting\n query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the\n limit for the amount of bytes scanned (cutoff) per query, if it is specified, and\n whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the\n WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
" } }, "Description": { "target": "com.amazonaws.athena#WorkGroupDescriptionString", "traits": { "smithy.api#documentation": "The workgroup description.
" } }, "Tags": { "target": "com.amazonaws.athena#TagList", "traits": { "smithy.api#documentation": "A list of comma separated tags to add to the workgroup that is created.
" } } } }, "com.amazonaws.athena#CreateWorkGroupOutput": { "type": "structure", "members": {} }, "com.amazonaws.athena#DataCatalog": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { "smithy.api#documentation": "The name of the data catalog. The catalog name must be unique for the AWS account and\n can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.athena#DescriptionString", "traits": { "smithy.api#documentation": "An optional description of the data catalog.
" } }, "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { "smithy.api#documentation": "The type of data catalog: LAMBDA for a federated catalog or\n HIVE for an external hive metastore. GLUE refers to the\n AwsDataCatalog that already exists in your account, of which you can\n have only one.
Specifies the Lambda function or functions to use for the data catalog. This is a\n mapping whose values depend on the catalog type.
\nFor the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.
\n metadata-function=lambda_arn,\n sdk-version=version_number\n \n
For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.
If you have one Lambda function that processes metadata and another\n for reading the actual data, use the following syntax. Both parameters\n are required.
\n\n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n
If you have a composite Lambda function that processes both metadata\n and data, use the following syntax to specify your Lambda\n function.
\n\n function=lambda_arn\n \n
Contains information about a data catalog in an AWS account.
" } }, "com.amazonaws.athena#DataCatalogSummary": { "type": "structure", "members": { "CatalogName": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { "smithy.api#documentation": "The name of the data catalog.
" } }, "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { "smithy.api#documentation": "The data catalog type.
" } } }, "traits": { "smithy.api#documentation": "The summary information for the data catalog, which includes its name and type.
" } }, "com.amazonaws.athena#DataCatalogSummaryList": { "type": "list", "member": { "target": "com.amazonaws.athena#DataCatalogSummary" } }, "com.amazonaws.athena#DataCatalogType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "LAMBDA", "name": "LAMBDA" }, { "value": "GLUE", "name": "GLUE" }, { "value": "HIVE", "name": "HIVE" } ] } }, "com.amazonaws.athena#Database": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.athena#NameString", "traits": { "smithy.api#documentation": "The name of the database.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.athena#DescriptionString", "traits": { "smithy.api#documentation": "An optional description of the database.
" } }, "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { "smithy.api#documentation": "A set of custom key/value pairs.
" } } }, "traits": { "smithy.api#documentation": "Contains metadata information for a database in a data catalog.
" } }, "com.amazonaws.athena#DatabaseList": { "type": "list", "member": { "target": "com.amazonaws.athena#Database" } }, "com.amazonaws.athena#DatabaseString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.athena#Date": { "type": "timestamp" }, "com.amazonaws.athena#Datum": { "type": "structure", "members": { "VarCharValue": { "target": "com.amazonaws.athena#datumString", "traits": { "smithy.api#documentation": "The value of the datum.
" } } }, "traits": { "smithy.api#documentation": "A piece of data (a field in the table).
" } }, "com.amazonaws.athena#DeleteDataCatalog": { "type": "operation", "input": { "target": "com.amazonaws.athena#DeleteDataCatalogInput" }, "output": { "target": "com.amazonaws.athena#DeleteDataCatalogOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Deletes a data catalog.
" } }, "com.amazonaws.athena#DeleteDataCatalogInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { "smithy.api#documentation": "The name of the data catalog to delete.
", "smithy.api#required": {} } } } }, "com.amazonaws.athena#DeleteDataCatalogOutput": { "type": "structure", "members": {} }, "com.amazonaws.athena#DeleteNamedQuery": { "type": "operation", "input": { "target": "com.amazonaws.athena#DeleteNamedQueryInput" }, "output": { "target": "com.amazonaws.athena#DeleteNamedQueryOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Deletes the named query if you have access to the workgroup in which the query was\n saved.
\nFor code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.
", "smithy.api#idempotent": {} } }, "com.amazonaws.athena#DeleteNamedQueryInput": { "type": "structure", "members": { "NamedQueryId": { "target": "com.amazonaws.athena#NamedQueryId", "traits": { "smithy.api#documentation": "The unique ID of the query to delete.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } } }, "com.amazonaws.athena#DeleteNamedQueryOutput": { "type": "structure", "members": {} }, "com.amazonaws.athena#DeletePreparedStatement": { "type": "operation", "input": { "target": "com.amazonaws.athena#DeletePreparedStatementInput" }, "output": { "target": "com.amazonaws.athena#DeletePreparedStatementOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" }, { "target": "com.amazonaws.athena#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Deletes the prepared statement with the specified name from the specified\n workgroup.
" } }, "com.amazonaws.athena#DeletePreparedStatementInput": { "type": "structure", "members": { "StatementName": { "target": "com.amazonaws.athena#StatementName", "traits": { "smithy.api#documentation": "The name of the prepared statement to delete.
", "smithy.api#required": {} } }, "WorkGroup": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "The workgroup to which the statement to be deleted belongs.
", "smithy.api#required": {} } } } }, "com.amazonaws.athena#DeletePreparedStatementOutput": { "type": "structure", "members": {} }, "com.amazonaws.athena#DeleteWorkGroup": { "type": "operation", "input": { "target": "com.amazonaws.athena#DeleteWorkGroupInput" }, "output": { "target": "com.amazonaws.athena#DeleteWorkGroupOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Deletes the workgroup with the specified name. The primary workgroup cannot be\n deleted.
", "smithy.api#idempotent": {} } }, "com.amazonaws.athena#DeleteWorkGroupInput": { "type": "structure", "members": { "WorkGroup": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "The unique name of the workgroup to delete.
", "smithy.api#required": {} } }, "RecursiveDeleteOption": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { "smithy.api#documentation": "The option to delete the workgroup and its contents even if the workgroup contains any\n named queries or query executions.
" } } } }, "com.amazonaws.athena#DeleteWorkGroupOutput": { "type": "structure", "members": {} }, "com.amazonaws.athena#DescriptionString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.athena#EncryptionConfiguration": { "type": "structure", "members": { "EncryptionOption": { "target": "com.amazonaws.athena#EncryptionOption", "traits": { "smithy.api#documentation": "Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys\n (SSE-S3), server-side encryption with KMS-managed keys\n (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is\n used.
If a query runs in a workgroup and the workgroup overrides client-side settings, then\n the workgroup's setting for encryption is used. It specifies whether query results must\n be encrypted, for all queries that run in this workgroup.
", "smithy.api#required": {} } }, "KmsKey": { "target": "com.amazonaws.athena#String", "traits": { "smithy.api#documentation": "For SSE-KMS and CSE-KMS, this is the KMS key ARN or\n ID.
If query results are encrypted in Amazon S3, indicates the encryption option used (for\n example, SSE-KMS or CSE-KMS) and key information.
The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including Auto. The default is Auto.
Read only. The engine version on which the query runs. If the user requests\n a valid engine version other than Auto, the effective engine version is the same as the\n 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 \n EffectiveEngineVersion field is ignored.
The Athena engine version for running queries.
" } }, "com.amazonaws.athena#EngineVersionsList": { "type": "list", "member": { "target": "com.amazonaws.athena#EngineVersion" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.athena#ErrorCode": { "type": "string", "traits": { "smithy.api#documentation": "The error code returned when the query execution failed to process, or when the\n processing request for the named query failed.
", "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.athena#ErrorMessage": { "type": "string" }, "com.amazonaws.athena#ExpressionString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.athena#GetDataCatalog": { "type": "operation", "input": { "target": "com.amazonaws.athena#GetDataCatalogInput" }, "output": { "target": "com.amazonaws.athena#GetDataCatalogOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Returns the specified data catalog.
" } }, "com.amazonaws.athena#GetDataCatalogInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { "smithy.api#documentation": "The name of the data catalog to return.
", "smithy.api#required": {} } } } }, "com.amazonaws.athena#GetDataCatalogOutput": { "type": "structure", "members": { "DataCatalog": { "target": "com.amazonaws.athena#DataCatalog", "traits": { "smithy.api#documentation": "The data catalog returned.
" } } } }, "com.amazonaws.athena#GetDatabase": { "type": "operation", "input": { "target": "com.amazonaws.athena#GetDatabaseInput" }, "output": { "target": "com.amazonaws.athena#GetDatabaseOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" }, { "target": "com.amazonaws.athena#MetadataException" } ], "traits": { "smithy.api#documentation": "Returns a database object for the specified database and data catalog.
" } }, "com.amazonaws.athena#GetDatabaseInput": { "type": "structure", "members": { "CatalogName": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { "smithy.api#documentation": "The name of the data catalog that contains the database to return.
", "smithy.api#required": {} } }, "DatabaseName": { "target": "com.amazonaws.athena#NameString", "traits": { "smithy.api#documentation": "The name of the database to return.
", "smithy.api#required": {} } } } }, "com.amazonaws.athena#GetDatabaseOutput": { "type": "structure", "members": { "Database": { "target": "com.amazonaws.athena#Database", "traits": { "smithy.api#documentation": "The database returned.
" } } } }, "com.amazonaws.athena#GetNamedQuery": { "type": "operation", "input": { "target": "com.amazonaws.athena#GetNamedQueryInput" }, "output": { "target": "com.amazonaws.athena#GetNamedQueryOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Returns information about a single query. Requires that you have access to the\n workgroup in which the query was saved.
" } }, "com.amazonaws.athena#GetNamedQueryInput": { "type": "structure", "members": { "NamedQueryId": { "target": "com.amazonaws.athena#NamedQueryId", "traits": { "smithy.api#documentation": "The unique ID of the query. Use ListNamedQueries to get query\n IDs.
", "smithy.api#required": {} } } } }, "com.amazonaws.athena#GetNamedQueryOutput": { "type": "structure", "members": { "NamedQuery": { "target": "com.amazonaws.athena#NamedQuery", "traits": { "smithy.api#documentation": "Information about the query.
" } } } }, "com.amazonaws.athena#GetPreparedStatement": { "type": "operation", "input": { "target": "com.amazonaws.athena#GetPreparedStatementInput" }, "output": { "target": "com.amazonaws.athena#GetPreparedStatementOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" }, { "target": "com.amazonaws.athena#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Retrieves the prepared statement with the specified name from the specified\n workgroup.
" } }, "com.amazonaws.athena#GetPreparedStatementInput": { "type": "structure", "members": { "StatementName": { "target": "com.amazonaws.athena#StatementName", "traits": { "smithy.api#documentation": "The name of the prepared statement to retrieve.
", "smithy.api#required": {} } }, "WorkGroup": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "The workgroup to which the statement to be retrieved belongs.
", "smithy.api#required": {} } } } }, "com.amazonaws.athena#GetPreparedStatementOutput": { "type": "structure", "members": { "PreparedStatement": { "target": "com.amazonaws.athena#PreparedStatement", "traits": { "smithy.api#documentation": "The name of the prepared statement that was retrieved.
" } } } }, "com.amazonaws.athena#GetQueryExecution": { "type": "operation", "input": { "target": "com.amazonaws.athena#GetQueryExecutionInput" }, "output": { "target": "com.amazonaws.athena#GetQueryExecutionOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Returns information about a single execution of a query if you have access to the\n workgroup in which the query ran. Each time a query executes, information about the\n query execution is saved with a unique ID.
" } }, "com.amazonaws.athena#GetQueryExecutionInput": { "type": "structure", "members": { "QueryExecutionId": { "target": "com.amazonaws.athena#QueryExecutionId", "traits": { "smithy.api#documentation": "The unique ID of the query execution.
", "smithy.api#required": {} } } } }, "com.amazonaws.athena#GetQueryExecutionOutput": { "type": "structure", "members": { "QueryExecution": { "target": "com.amazonaws.athena#QueryExecution", "traits": { "smithy.api#documentation": "Information about the query execution.
" } } } }, "com.amazonaws.athena#GetQueryResults": { "type": "operation", "input": { "target": "com.amazonaws.athena#GetQueryResultsInput" }, "output": { "target": "com.amazonaws.athena#GetQueryResultsOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Streams the results of a single query execution specified by\n QueryExecutionId from the Athena query results location in Amazon S3.\n For more information, see Query Results in the Amazon\n Athena User Guide. This request does not execute the query but returns\n results. Use StartQueryExecution to run a query.
To stream query results successfully, the IAM principal with permission to call\n GetQueryResults also must have permissions to the Amazon S3\n GetObject action for the Athena query results location.
IAM principals with permission to the Amazon S3 GetObject action for\n the query results location are able to retrieve query results from Amazon S3 even if\n permission to the GetQueryResults action is denied. To restrict user or\n role access, ensure that Amazon S3 permissions to the Athena query location are\n denied.
The unique ID of the query execution.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
The maximum number of results (rows) to return in this request.
" } } } }, "com.amazonaws.athena#GetQueryResultsOutput": { "type": "structure", "members": { "UpdateCount": { "target": "com.amazonaws.athena#Long", "traits": { "smithy.api#documentation": "The number of rows inserted with a CREATE TABLE AS SELECT statement.
" } }, "ResultSet": { "target": "com.amazonaws.athena#ResultSet", "traits": { "smithy.api#documentation": "The results of the query execution.
" } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
Returns table metadata for the specified catalog, database, and table.
" } }, "com.amazonaws.athena#GetTableMetadataInput": { "type": "structure", "members": { "CatalogName": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { "smithy.api#documentation": "The name of the data catalog that contains the database and table metadata to\n return.
", "smithy.api#required": {} } }, "DatabaseName": { "target": "com.amazonaws.athena#NameString", "traits": { "smithy.api#documentation": "The name of the database that contains the table metadata to return.
", "smithy.api#required": {} } }, "TableName": { "target": "com.amazonaws.athena#NameString", "traits": { "smithy.api#documentation": "The name of the table for which metadata is returned.
", "smithy.api#required": {} } } } }, "com.amazonaws.athena#GetTableMetadataOutput": { "type": "structure", "members": { "TableMetadata": { "target": "com.amazonaws.athena#TableMetadata", "traits": { "smithy.api#documentation": "An object that contains table metadata.
" } } } }, "com.amazonaws.athena#GetWorkGroup": { "type": "operation", "input": { "target": "com.amazonaws.athena#GetWorkGroupInput" }, "output": { "target": "com.amazonaws.athena#GetWorkGroupOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Returns information about the workgroup with the specified name.
" } }, "com.amazonaws.athena#GetWorkGroupInput": { "type": "structure", "members": { "WorkGroup": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "The name of the workgroup.
", "smithy.api#required": {} } } } }, "com.amazonaws.athena#GetWorkGroupOutput": { "type": "structure", "members": { "WorkGroup": { "target": "com.amazonaws.athena#WorkGroup", "traits": { "smithy.api#documentation": "Information about the workgroup.
" } } } }, "com.amazonaws.athena#IdempotencyToken": { "type": "string", "traits": { "smithy.api#length": { "min": 32, "max": 128 } } }, "com.amazonaws.athena#Integer": { "type": "integer" }, "com.amazonaws.athena#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.athena#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Indicates a platform issue, which may be due to a transient condition or\n outage.
", "smithy.api#error": "server" } }, "com.amazonaws.athena#InvalidRequestException": { "type": "structure", "members": { "AthenaErrorCode": { "target": "com.amazonaws.athena#ErrorCode" }, "Message": { "target": "com.amazonaws.athena#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Indicates that something is wrong with the input to the request. For example, a\n required parameter may be missing or out of range.
", "smithy.api#error": "client" } }, "com.amazonaws.athena#KeyString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" } }, "com.amazonaws.athena#ListDataCatalogs": { "type": "operation", "input": { "target": "com.amazonaws.athena#ListDataCatalogsInput" }, "output": { "target": "com.amazonaws.athena#ListDataCatalogsOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Lists the data catalogs in the current AWS account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "DataCatalogsSummary", "pageSize": "MaxResults" } } }, "com.amazonaws.athena#ListDataCatalogsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.
" } }, "MaxResults": { "target": "com.amazonaws.athena#MaxDataCatalogsCount", "traits": { "smithy.api#documentation": "Specifies the maximum number of data catalogs to return.
" } } } }, "com.amazonaws.athena#ListDataCatalogsOutput": { "type": "structure", "members": { "DataCatalogsSummary": { "target": "com.amazonaws.athena#DataCatalogSummaryList", "traits": { "smithy.api#documentation": "A summary list of data catalogs.
" } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.
" } } } }, "com.amazonaws.athena#ListDatabases": { "type": "operation", "input": { "target": "com.amazonaws.athena#ListDatabasesInput" }, "output": { "target": "com.amazonaws.athena#ListDatabasesOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" }, { "target": "com.amazonaws.athena#MetadataException" } ], "traits": { "smithy.api#documentation": "Lists the databases in the specified data catalog.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "DatabaseList", "pageSize": "MaxResults" } } }, "com.amazonaws.athena#ListDatabasesInput": { "type": "structure", "members": { "CatalogName": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { "smithy.api#documentation": "The name of the data catalog that contains the databases to return.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
Specifies the maximum number of results to return.
" } } } }, "com.amazonaws.athena#ListDatabasesOutput": { "type": "structure", "members": { "DatabaseList": { "target": "com.amazonaws.athena#DatabaseList", "traits": { "smithy.api#documentation": "A list of databases from a data catalog.
" } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.
" } } } }, "com.amazonaws.athena#ListEngineVersions": { "type": "operation", "input": { "target": "com.amazonaws.athena#ListEngineVersionsInput" }, "output": { "target": "com.amazonaws.athena#ListEngineVersionsOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Returns a list of engine versions that are available to choose from, including the\n Auto option.
" } }, "com.amazonaws.athena#ListEngineVersionsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
The maximum number of engine versions to return in this request.
" } } } }, "com.amazonaws.athena#ListEngineVersionsOutput": { "type": "structure", "members": { "EngineVersions": { "target": "com.amazonaws.athena#EngineVersionsList", "traits": { "smithy.api#documentation": "A list of engine versions that are available to choose from.
" } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
Provides a list of available query IDs only for queries saved in the specified\n workgroup. Requires that you have access to the specified workgroup. If a workgroup is\n not specified, lists the saved queries for the primary workgroup.
\nFor code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.athena#ListNamedQueriesInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
The maximum number of queries to return in this request.
" } }, "WorkGroup": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "The name of the workgroup from which the named queries are being returned. If a\n workgroup is not specified, the saved queries for the primary workgroup are\n returned.
" } } } }, "com.amazonaws.athena#ListNamedQueriesOutput": { "type": "structure", "members": { "NamedQueryIds": { "target": "com.amazonaws.athena#NamedQueryIdList", "traits": { "smithy.api#documentation": "The list of unique query IDs.
" } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
Lists the prepared statements in the specfied workgroup.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.athena#ListPreparedStatementsInput": { "type": "structure", "members": { "WorkGroup": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "The workgroup to list the prepared statements for.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
The maximum number of results to return in this request.
" } } } }, "com.amazonaws.athena#ListPreparedStatementsOutput": { "type": "structure", "members": { "PreparedStatements": { "target": "com.amazonaws.athena#PreparedStatementsList", "traits": { "smithy.api#documentation": "The list of prepared statements for the workgroup.
" } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
Provides a list of available query execution IDs for the queries in the specified\n workgroup. If a workgroup is not specified, returns a list of query execution IDs for\n the primary workgroup. Requires you to have access to the workgroup in which the queries\n ran.
\nFor code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.athena#ListQueryExecutionsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
The maximum number of query executions to return in this request.
" } }, "WorkGroup": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "The name of the workgroup from which queries are being returned. If a workgroup is not\n specified, a list of available query execution IDs for the queries in the primary\n workgroup is returned.
" } } } }, "com.amazonaws.athena#ListQueryExecutionsOutput": { "type": "structure", "members": { "QueryExecutionIds": { "target": "com.amazonaws.athena#QueryExecutionIdList", "traits": { "smithy.api#documentation": "The unique IDs of each query execution as an array of strings.
" } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token to be used by the next request if this request is truncated.
" } } } }, "com.amazonaws.athena#ListTableMetadata": { "type": "operation", "input": { "target": "com.amazonaws.athena#ListTableMetadataInput" }, "output": { "target": "com.amazonaws.athena#ListTableMetadataOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" }, { "target": "com.amazonaws.athena#MetadataException" } ], "traits": { "smithy.api#documentation": "Lists the metadata for the tables in the specified data catalog database.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "TableMetadataList", "pageSize": "MaxResults" } } }, "com.amazonaws.athena#ListTableMetadataInput": { "type": "structure", "members": { "CatalogName": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { "smithy.api#documentation": "The name of the data catalog for which table metadata should be returned.
", "smithy.api#required": {} } }, "DatabaseName": { "target": "com.amazonaws.athena#NameString", "traits": { "smithy.api#documentation": "The name of the database for which table metadata should be returned.
", "smithy.api#required": {} } }, "Expression": { "target": "com.amazonaws.athena#ExpressionString", "traits": { "smithy.api#documentation": "A regex filter that pattern-matches table names. If no expression is supplied,\n metadata for all tables are listed.
" } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.
" } }, "MaxResults": { "target": "com.amazonaws.athena#MaxTableMetadataCount", "traits": { "smithy.api#documentation": "Specifies the maximum number of results to return.
" } } } }, "com.amazonaws.athena#ListTableMetadataOutput": { "type": "structure", "members": { "TableMetadataList": { "target": "com.amazonaws.athena#TableMetadataList", "traits": { "smithy.api#documentation": "A list of table metadata.
" } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.
" } } } }, "com.amazonaws.athena#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.athena#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.athena#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" }, { "target": "com.amazonaws.athena#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Lists the tags associated with an Athena workgroup or data catalog resource.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Tags", "pageSize": "MaxResults" } } }, "com.amazonaws.athena#ListTagsForResourceInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.athena#AmazonResourceName", "traits": { "smithy.api#documentation": "Lists the tags for the resource with the specified ARN.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "The token for the next set of results, or null if there are no additional results for\n this request, where the request lists the tags for the resource with the specified\n ARN.
" } }, "MaxResults": { "target": "com.amazonaws.athena#MaxTagsCount", "traits": { "smithy.api#documentation": "The maximum number of results to be returned per request that lists the tags for the\n resource.
" } } } }, "com.amazonaws.athena#ListTagsForResourceOutput": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.athena#TagList", "traits": { "smithy.api#documentation": "The list of tags associated with the specified resource.
" } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token to be used by the next request if this request is truncated.
" } } } }, "com.amazonaws.athena#ListWorkGroups": { "type": "operation", "input": { "target": "com.amazonaws.athena#ListWorkGroupsInput" }, "output": { "target": "com.amazonaws.athena#ListWorkGroupsOutput" }, "errors": [ { "target": "com.amazonaws.athena#InternalServerException" }, { "target": "com.amazonaws.athena#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Lists available workgroups for the account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.athena#ListWorkGroupsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
The maximum number of workgroups to return in this request.
" } } } }, "com.amazonaws.athena#ListWorkGroupsOutput": { "type": "structure", "members": { "WorkGroups": { "target": "com.amazonaws.athena#WorkGroupsList", "traits": { "smithy.api#documentation": "A list of WorkGroupSummary objects that include the names,\n descriptions, creation times, and states for each workgroup.
" } }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.
An exception that Athena received when it called a custom metastore. Occurs if the\n error is not caused by user input (InvalidRequestException) or from the\n Athena platform (InternalServerException). For example, if a user-created\n Lambda function is missing permissions, the Lambda 4XX exception is\n returned in a MetadataException.
The query name.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.athena#DescriptionString", "traits": { "smithy.api#documentation": "The query description.
" } }, "Database": { "target": "com.amazonaws.athena#DatabaseString", "traits": { "smithy.api#documentation": "The database to which the query belongs.
", "smithy.api#required": {} } }, "QueryString": { "target": "com.amazonaws.athena#QueryString", "traits": { "smithy.api#documentation": "The SQL query statements that comprise the query.
", "smithy.api#required": {} } }, "NamedQueryId": { "target": "com.amazonaws.athena#NamedQueryId", "traits": { "smithy.api#documentation": "The unique identifier of the query.
" } }, "WorkGroup": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "The name of the workgroup that contains the named query.
" } } }, "traits": { "smithy.api#documentation": "A query, where QueryString is the list of SQL query statements that\n comprise the query.
The name of the prepared statement.
" } }, "QueryStatement": { "target": "com.amazonaws.athena#QueryString", "traits": { "smithy.api#documentation": "The query string for the prepared statement.
" } }, "WorkGroupName": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "The name of the workgroup to which the prepared statement belongs.
" } }, "Description": { "target": "com.amazonaws.athena#DescriptionString", "traits": { "smithy.api#documentation": "The description of the prepared statement.
" } }, "LastModifiedTime": { "target": "com.amazonaws.athena#Date", "traits": { "smithy.api#documentation": "The last modified time of the prepared statement.
" } } }, "traits": { "smithy.api#documentation": "A prepared SQL statement for use with Athena.
" } }, "com.amazonaws.athena#PreparedStatementSummary": { "type": "structure", "members": { "StatementName": { "target": "com.amazonaws.athena#StatementName", "traits": { "smithy.api#documentation": "The name of the prepared statement.
" } }, "LastModifiedTime": { "target": "com.amazonaws.athena#Date", "traits": { "smithy.api#documentation": "The last modified time of the prepared statement.
" } } }, "traits": { "smithy.api#documentation": "The name and last modified time of the prepared statement.
" } }, "com.amazonaws.athena#PreparedStatementsList": { "type": "list", "member": { "target": "com.amazonaws.athena#PreparedStatementSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.athena#QueryExecution": { "type": "structure", "members": { "QueryExecutionId": { "target": "com.amazonaws.athena#QueryExecutionId", "traits": { "smithy.api#documentation": "The unique identifier for each query execution.
" } }, "Query": { "target": "com.amazonaws.athena#QueryString", "traits": { "smithy.api#documentation": "The SQL query statements which the query execution ran.
" } }, "StatementType": { "target": "com.amazonaws.athena#StatementType", "traits": { "smithy.api#documentation": "The type of query statement that was run. The location in Amazon S3 where query results were stored and the encryption option,\n if any, used for query results. These are known as \"client-side settings\". If workgroup\n settings override client-side settings, then the query uses the location for the query\n results and the encryption configuration that are specified for the workgroup. The database in which the query execution occurred. The completion date, current state, submission time, and state change reason (if\n applicable) for the query execution. Query execution statistics, such as the amount of data scanned, the amount of time\n that the query took to process, and the type of statement that was run. The name of the workgroup in which the query ran. The engine version that executed the query. Information about a single instance of a query execution. The name of the database used in the query execution. The name of the data catalog used in the query execution. The database and data catalog context in which the query execution occurs. The number of milliseconds that the query took to execute. The number of bytes in the data that was queried. The location and file name of a data manifest file. The manifest file is saved to the\n Athena query results location in Amazon S3. The manifest file tracks files that the\n query wrote to Amazon S3. If the query fails, the manifest file also tracks files that\n the query intended to write. The manifest is useful for identifying orphaned files\n resulting from a failed query. For more information, see Working with Query Results, Output Files, and\n Query History in the Amazon Athena User Guide. The number of milliseconds that Athena took to run the query. The number of milliseconds that the query was in your query queue waiting for\n resources. Note that if transient errors occur, Athena might automatically add the query\n back to the queue. The number of milliseconds that Athena took to plan the query processing flow. This\n includes the time spent retrieving table partitions from the data source. Note that\n because the query engine performs the query planning, query planning time is a subset of\n engine processing time. The number of milliseconds that Athena took to finalize and publish the query results\n after the query engine finished running the query. The amount of data scanned during the query execution and the amount of time that it\n took to execute, and the type of statement that was run. The state of query execution. Athena automatically retries your queries in cases of certain transient errors. As\n a result, you may see the query state transition from Further detail about the status of the query. The date and time that the query was submitted. The date and time that the query completed. The completion date, current state, submission time, and state change reason (if\n applicable) for the query execution. A resource, such as a workgroup, was not found. The location in Amazon S3 where your query results are stored, such as\n If query results are encrypted in Amazon S3, indicates the encryption option used (for\n example, The location in Amazon S3 where query results are stored and the encryption option, if\n any, used for query results. These are known as \"client-side settings\". If workgroup\n settings override client-side settings, then the query uses the workgroup\n settings. The location in Amazon S3 where your query results are stored, such as\n If set to \"true\", indicates that the previously-specified query results location (also\n known as a client-side setting) for queries in this workgroup should be ignored and set\n to null. If set to \"false\" or not set, and a value is present in the OutputLocation in\n ResultConfigurationUpdates (the client-side setting), the OutputLocation in the\n workgroup's ResultConfiguration will be updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings. The encryption configuration for the query results. If set to \"true\", indicates that the previously-specified encryption configuration\n (also known as the client-side setting) for queries in this workgroup should be ignored\n and set to null. If set to \"false\" or not set, and a value is present in the\n EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the\n EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the\n new value. For more information, see Workgroup Settings Override\n Client-Side Settings. The information about the updates in the query results, such as output location and\n encryption configuration for the query results. The rows in the table. The metadata that describes the column structure and data types of a table of query\n results. The metadata and rows that comprise a query result set. The metadata describes the\n column structure and data types. To return a Information about the columns returned in a query result metadata. The metadata that describes the column structure and data types of a table of query\n results. To return a The data that populates a row in a query result table. The rows that comprise a query result table. Runs the SQL query statements contained in the The SQL query statements to be executed. A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another This token is listed as not required because AWS SDKs (for example the AWS SDK for\n Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS\n CLI, you must provide this token or the action will fail. The database within which the query executes. Specifies information about where and how to save the results of the query execution.\n If the query runs in a workgroup, then workgroup's settings may override query settings.\n This affects the query results location. The workgroup settings override is specified in\n EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. The name of the workgroup in which the query is being started. The unique ID of the query that ran as a result of this request. Stops a query execution. Requires you to have access to the workgroup in which the\n query ran. For code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide. The unique ID of the query execution to stop. The name of the table. The time that the table was created. The last time the table was accessed. The type of table. In Athena, only A list of the columns in the table. A list of the partition keys in the table. A set of custom key/value pairs for table properties. Contains metadata for a table. A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can\n use letters and numbers representable in UTF-8, and the following characters: + - = . _\n : / @. Tag keys are case-sensitive and must be unique per resource. A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You\n can use letters and numbers representable in UTF-8, and the following characters: + - =\n . _ : / @. Tag values are case-sensitive. A label that you assign to a resource. In Athena, a resource can be a workgroup or\n data catalog. Each tag consists of a key and an optional value, both of which you\n define. For example, you can use tags to categorize Athena workgroups or data catalogs\n by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to\n search and filter workgroups or data catalogs in your account. For best practices, see\n Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode\n characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use\n letters and numbers representable in UTF-8, and the following characters: + - = . _ : /\n @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you\n specify more than one tag, separate them by commas. Adds one or more tags to an Athena resource. A tag is a label that you assign to a\n resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of\n a key and an optional value, both of which you define. For example, you can use tags to\n categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a\n consistent set of tag keys to make it easier to search and filter workgroups or data\n catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode\n characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use\n letters and numbers representable in UTF-8, and the following characters: + - = . _ : /\n @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you\n specify more than one tag, separate them by commas. Specifies the ARN of the Athena resource (workgroup or data catalog) to which tags are\n to be added. A collection of one or more tags, separated by commas, to be added to an Athena\n workgroup or data catalog resource. The reason for the query throttling, for example, when it exceeds the concurrent query\n limit. Indicates that the request was throttled. The unique identifier of the named query. The error code returned when the processing request for the named query failed, if\n applicable. The error message returned when the processing request for the named query failed, if\n applicable. Information about a named query ID that could not be processed. The unique identifier of the query execution. The error code returned when the query execution failed to process, if\n applicable. The error message returned when the query execution failed to process, if\n applicable. Describes a query execution that failed to process. Removes one or more tags from a data catalog or workgroup resource. Specifies the ARN of the resource from which tags are to be removed. A comma-separated list of one or more tag keys whose tags are to be removed from the\n specified resource. Updates the data catalog that has the specified name. The name of the data catalog to update. The catalog name must be unique for the AWS\n account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen\n characters. Specifies the type of data catalog to update. Specify Do not use the New or modified text that describes the data catalog. Specifies the Lambda function or functions to use for updating the data catalog. This\n is a mapping whose values depend on the catalog type. For the \n For the If you have one Lambda function that processes metadata and another\n for reading the actual data, use the following syntax. Both parameters\n are required. \n If you have a composite Lambda function that processes both metadata\n and data, use the following syntax to specify your Lambda\n function. \n Updates a prepared statement. The name of the prepared statement. The workgroup for the prepared statement. The query string for the prepared statement. The description of the prepared statement. Updates the workgroup with the specified name. The workgroup's name cannot be\n changed. The specified workgroup that will be updated. The workgroup description. The workgroup configuration that will be updated for the given workgroup. The workgroup state that will be updated for the given workgroup. The workgroup name. The state of the workgroup: ENABLED or DISABLED. The configuration of the workgroup, which includes the location in Amazon S3 where\n query results are stored, the encryption configuration, if any, used for query results;\n whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup\n settings override client-side settings; and the data usage limits for the amount of data\n scanned per query or per workgroup. The workgroup settings override is specified in\n EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. The workgroup description. The date and time the workgroup was created. A workgroup, which contains a name, description, creation time, state, and other\n configuration, listed under WorkGroup$Configuration. Each workgroup\n enables you to isolate queries for you or your group of users from other queries in the\n same account, to configure the query results location and the encryption configuration\n (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and\n to establish per-query data usage control limits for all queries in a workgroup. The\n workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false)\n in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. The configuration for the workgroup, which includes the location in Amazon S3 where\n query results are stored and the encryption option, if any, used for query results. To\n run the query, you must specify the query results location using one of the ways: either\n in the workgroup using this setting, or for individual queries (client-side), using\n ResultConfiguration$OutputLocation. If none of them is set, Athena\n issues an error that no output location is provided. For more information, see Query\n Results. If set to \"true\", the settings for the workgroup override client-side settings. If set\n to \"false\", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings. Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. The upper data usage limit (cutoff) for the amount of bytes a single query in a\n workgroup is allowed to scan. If set to The engine version that all queries running on\n the workgroup use. Queries on the The configuration of the workgroup, which includes the location in Amazon S3 where\n query results are stored, the encryption option, if any, used for query results, whether\n the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup\n settings override query settings, and the data usage limits for the amount of data\n scanned per query or per workgroup. The workgroup settings override is specified in\n EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. If set to \"true\", the settings for the workgroup override client-side settings. If set\n to \"false\" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings. The result configuration information about the queries in this workgroup that will be\n updated. Includes the updated results location and an updated option for encrypting\n query results. Indicates whether this workgroup enables publishing metrics to Amazon\n CloudWatch. The upper limit (cutoff) for the amount of bytes a single query in a workgroup is\n allowed to scan. Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery\n If set to 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 The configuration information that will be updated for this workgroup, which includes\n the location in Amazon S3 where query results are stored, the encryption option, if any,\n used for query results, whether the Amazon CloudWatch Metrics are enabled for the\n workgroup, whether the workgroup settings override the client-side settings, and the\n data usage limit for the amount of bytes scanned per query, if it is specified. The name of the workgroup. The state of the workgroup. The workgroup description. The workgroup creation date and time. The engine version setting for all queries on the workgroup. Queries on the The summary information for the workgroup, which includes its name, state,\n description, and the date and time it was created.DDL indicates DDL query\n statements. DML indicates DML (Data Manipulation Language) query\n statements, such as CREATE TABLE AS SELECT. UTILITY indicates\n query statements other than DDL and DML, such as SHOW CREATE TABLE, or\n DESCRIBE ."
}
},
"ResultConfiguration": {
"target": "com.amazonaws.athena#ResultConfiguration",
"traits": {
"smithy.api#documentation": "
QUEUED indicates that the query has been\n submitted to the service, and Athena will execute the query as soon as resources are\n available. RUNNING indicates that the query is in execution phase.\n SUCCEEDED indicates that the query completed without errors.\n FAILED indicates that the query experienced an error and did not\n complete processing. CANCELLED indicates that a user input interrupted\n query execution.RUNNING or\n FAILED to QUEUED. s3://path/to/query/bucket/. To run the query, you must specify the\n query results location using one of the ways: either for individual queries using either\n this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error\n that no output location is provided. For more information, see Query Results. If\n workgroup settings override client-side settings, then the query uses the settings\n specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.SSE-KMS or CSE-KMS) and key information. This is a\n client-side setting. If workgroup settings override client-side settings, then the query\n uses the encryption configuration that is specified for the workgroup, and also uses the\n location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.s3://path/to/query/bucket/. For more information, see Query Results If\n workgroup settings override client-side settings, then the query uses the location for\n the query results and the encryption configuration that are specified for the workgroup.\n The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration\n (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.ResultSet object, use GetQueryResults.ResultSetMetadata object, use GetQueryResults.Query. Requires you to\n have access to the workgroup in which the query ran. Running queries against an external\n catalog requires GetDataCatalog permission to the catalog. For code\n samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.StartQueryExecution request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.EXTERNAL_TABLE is supported.LAMBDA for a\n federated catalog or HIVE for an external hive metastore.GLUE type. This refers to the\n AwsDataCatalog that already exists in your account, of which you\n can have only one. Specifying the GLUE type will result in an\n INVALID_INPUT error.\n
"
}
}
}
},
"com.amazonaws.athena#UpdateDataCatalogOutput": {
"type": "structure",
"members": {}
},
"com.amazonaws.athena#UpdatePreparedStatement": {
"type": "operation",
"input": {
"target": "com.amazonaws.athena#UpdatePreparedStatementInput"
},
"output": {
"target": "com.amazonaws.athena#UpdatePreparedStatementOutput"
},
"errors": [
{
"target": "com.amazonaws.athena#InternalServerException"
},
{
"target": "com.amazonaws.athena#InvalidRequestException"
},
{
"target": "com.amazonaws.athena#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.metadata-function=lambda_arn,\n sdk-version=version_number\n \n LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.\n
\n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n function=lambda_arn\n \n true, allows members assigned to a workgroup to reference\n Amazon S3 Requester Pays buckets in queries. If set to false, workgroup\n members cannot query data from Requester Pays buckets, and queries that retrieve data\n from Requester Pays buckets cause an error. The default is false. For more\n information about Requester Pays buckets, see Requester Pays Buckets\n in the Amazon Simple Storage Service Developer Guide.AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.true, allows members assigned to a workgroup to specify Amazon\n S3 Requester Pays buckets in queries. If set to false, workgroup members\n cannot query data from Requester Pays buckets, and queries that retrieve data from\n Requester Pays buckets cause an error. The default is false. For more\n information about Requester Pays buckets, see Requester Pays Buckets\n in the Amazon Simple Storage Service Developer Guide.AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.