python-botocore/botocore/data/athena/2017-05-18/service-2.json
2019-02-27 16:30:11 +09:00

1429 lines
59 KiB
JSON

{
"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":"<p>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 <a>ListNamedQueriesInput</a> 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 <a>UnprocessedNamedQueryId</a>. Named queries differ from executed queries. Use <a>BatchGetQueryExecutionInput</a> to get details about each unique query execution, and <a>ListQueryExecutionsInput</a> to get a list of query execution IDs.</p>"
},
"BatchGetQueryExecution":{
"name":"BatchGetQueryExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchGetQueryExecutionInput"},
"output":{"shape":"BatchGetQueryExecutionOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>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 <a>ListQueryExecutionsInput$WorkGroup</a>. Query executions differ from named (saved) queries. Use <a>BatchGetNamedQueryInput</a> to get details about named queries.</p>"
},
"CreateNamedQuery":{
"name":"CreateNamedQuery",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateNamedQueryInput"},
"output":{"shape":"CreateNamedQueryOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Creates a named query in the specified workgroup. Requires that you have access to the workgroup.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"idempotent":true
},
"CreateWorkGroup":{
"name":"CreateWorkGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateWorkGroupInput"},
"output":{"shape":"CreateWorkGroupOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Creates a workgroup with the specified name.</p>"
},
"DeleteNamedQuery":{
"name":"DeleteNamedQuery",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteNamedQueryInput"},
"output":{"shape":"DeleteNamedQueryOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes the named query if you have access to the workgroup in which the query was saved.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"idempotent":true
},
"DeleteWorkGroup":{
"name":"DeleteWorkGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteWorkGroupInput"},
"output":{"shape":"DeleteWorkGroupOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.</p>",
"idempotent":true
},
"GetNamedQuery":{
"name":"GetNamedQuery",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetNamedQueryInput"},
"output":{"shape":"GetNamedQueryOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.</p>"
},
"GetQueryExecution":{
"name":"GetQueryExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetQueryExecutionInput"},
"output":{"shape":"GetQueryExecutionOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>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.</p>"
},
"GetQueryResults":{
"name":"GetQueryResults",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetQueryResultsInput"},
"output":{"shape":"GetQueryResultsOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns the results of a single query execution specified by <code>QueryExecutionId</code> if you have access to the workgroup in which the query ran. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p>"
},
"GetWorkGroup":{
"name":"GetWorkGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetWorkGroupInput"},
"output":{"shape":"GetWorkGroupOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns information about the workgroup with the specified name.</p>"
},
"ListNamedQueries":{
"name":"ListNamedQueries",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListNamedQueriesInput"},
"output":{"shape":"ListNamedQueriesOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
},
"ListQueryExecutions":{
"name":"ListQueryExecutions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListQueryExecutionsInput"},
"output":{"shape":"ListQueryExecutionsOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceInput"},
"output":{"shape":"ListTagsForResourceOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the tags associated with this workgroup.</p>"
},
"ListWorkGroups":{
"name":"ListWorkGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListWorkGroupsInput"},
"output":{"shape":"ListWorkGroupsOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Lists available workgroups for the account.</p>"
},
"StartQueryExecution":{
"name":"StartQueryExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartQueryExecutionInput"},
"output":{"shape":"StartQueryExecutionOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Runs the SQL query statements contained in the <code>Query</code>. Requires you to have access to the workgroup in which the query ran.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"idempotent":true
},
"StopQueryExecution":{
"name":"StopQueryExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopQueryExecutionInput"},
"output":{"shape":"StopQueryExecutionOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Stops a query execution. Requires you to have access to the workgroup in which the query ran.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"idempotent":true
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceInput"},
"output":{"shape":"TagResourceOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see <a href=\"https://aws.amazon.com/answers/account-management/aws-tagging-strategies/\">AWS Tagging Strategies</a>. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You 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, separate them by commas.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceInput"},
"output":{"shape":"UntagResourceOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time.</p>"
},
"UpdateWorkGroup":{
"name":"UpdateWorkGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateWorkGroupInput"},
"output":{"shape":"UpdateWorkGroupOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Updates the workgroup with the specified name. The workgroup's name cannot be changed.</p>"
}
},
"shapes":{
"AmazonResourceName":{
"type":"string",
"max":1011,
"min":1
},
"BatchGetNamedQueryInput":{
"type":"structure",
"required":["NamedQueryIds"],
"members":{
"NamedQueryIds":{
"shape":"NamedQueryIdList",
"documentation":"<p>An array of query IDs.</p>"
}
}
},
"BatchGetNamedQueryOutput":{
"type":"structure",
"members":{
"NamedQueries":{
"shape":"NamedQueryList",
"documentation":"<p>Information about the named query IDs submitted.</p>"
},
"UnprocessedNamedQueryIds":{
"shape":"UnprocessedNamedQueryIdList",
"documentation":"<p>Information about provided query IDs.</p>"
}
}
},
"BatchGetQueryExecutionInput":{
"type":"structure",
"required":["QueryExecutionIds"],
"members":{
"QueryExecutionIds":{
"shape":"QueryExecutionIdList",
"documentation":"<p>An array of query execution IDs.</p>"
}
}
},
"BatchGetQueryExecutionOutput":{
"type":"structure",
"members":{
"QueryExecutions":{
"shape":"QueryExecutionList",
"documentation":"<p>Information about a query execution.</p>"
},
"UnprocessedQueryExecutionIds":{
"shape":"UnprocessedQueryExecutionIdList",
"documentation":"<p>Information about the query executions that failed to run.</p>"
}
}
},
"Boolean":{"type":"boolean"},
"BoxedBoolean":{"type":"boolean"},
"BytesScannedCutoffValue":{
"type":"long",
"min":10000000
},
"ColumnInfo":{
"type":"structure",
"required":[
"Name",
"Type"
],
"members":{
"CatalogName":{
"shape":"String",
"documentation":"<p>The catalog to which the query results belong.</p>"
},
"SchemaName":{
"shape":"String",
"documentation":"<p>The schema name (database name) to which the query results belong.</p>"
},
"TableName":{
"shape":"String",
"documentation":"<p>The table name for the query results.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of the column.</p>"
},
"Label":{
"shape":"String",
"documentation":"<p>A column label.</p>"
},
"Type":{
"shape":"String",
"documentation":"<p>The data type of the column.</p>"
},
"Precision":{
"shape":"Integer",
"documentation":"<p>For <code>DECIMAL</code> data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.</p>"
},
"Scale":{
"shape":"Integer",
"documentation":"<p>For <code>DECIMAL</code> data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.</p>"
},
"Nullable":{
"shape":"ColumnNullable",
"documentation":"<p>Indicates the column's nullable status.</p>"
},
"CaseSensitive":{
"shape":"Boolean",
"documentation":"<p>Indicates whether values in the column are case-sensitive.</p>"
}
},
"documentation":"<p>Information about the columns in a query execution result.</p>"
},
"ColumnInfoList":{
"type":"list",
"member":{"shape":"ColumnInfo"}
},
"ColumnNullable":{
"type":"string",
"enum":[
"NOT_NULL",
"NULLABLE",
"UNKNOWN"
]
},
"CreateNamedQueryInput":{
"type":"structure",
"required":[
"Name",
"Database",
"QueryString"
],
"members":{
"Name":{
"shape":"NameString",
"documentation":"<p>The query name.</p>"
},
"Description":{
"shape":"DescriptionString",
"documentation":"<p>The query description.</p>"
},
"Database":{
"shape":"DatabaseString",
"documentation":"<p>The database to which the query belongs.</p>"
},
"QueryString":{
"shape":"QueryString",
"documentation":"<p>The contents of the query with all query statements.</p>"
},
"ClientRequestToken":{
"shape":"IdempotencyToken",
"documentation":"<p>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <code>CreateNamedQuery</code> request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the <code>QueryString</code>, an error is returned.</p> <important> <p>This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.</p> </important>",
"idempotencyToken":true
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup in which the named query is being created.</p>"
}
}
},
"CreateNamedQueryOutput":{
"type":"structure",
"members":{
"NamedQueryId":{
"shape":"NamedQueryId",
"documentation":"<p>The unique ID of the query.</p>"
}
}
},
"CreateWorkGroupInput":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"WorkGroupName",
"documentation":"<p>The workgroup name.</p>"
},
"Configuration":{
"shape":"WorkGroupConfiguration",
"documentation":"<p>The configuration for the workgroup, which includes the location in Amazon S3 where query 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 <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"Description":{
"shape":"WorkGroupDescriptionString",
"documentation":"<p>The workgroup description.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>One or more tags, separated by commas, that you want to attach to the workgroup as you create it.</p>"
}
}
},
"CreateWorkGroupOutput":{
"type":"structure",
"members":{
}
},
"DatabaseString":{
"type":"string",
"max":255,
"min":1
},
"Date":{"type":"timestamp"},
"Datum":{
"type":"structure",
"members":{
"VarCharValue":{
"shape":"datumString",
"documentation":"<p>The value of the datum.</p>"
}
},
"documentation":"<p>A piece of data (a field in the table).</p>"
},
"DeleteNamedQueryInput":{
"type":"structure",
"required":["NamedQueryId"],
"members":{
"NamedQueryId":{
"shape":"NamedQueryId",
"documentation":"<p>The unique ID of the query to delete.</p>",
"idempotencyToken":true
}
}
},
"DeleteNamedQueryOutput":{
"type":"structure",
"members":{
}
},
"DeleteWorkGroupInput":{
"type":"structure",
"required":["WorkGroup"],
"members":{
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The unique name of the workgroup to delete.</p>"
},
"RecursiveDeleteOption":{
"shape":"BoxedBoolean",
"documentation":"<p>The option to delete the workgroup and its contents even if the workgroup contains any named queries.</p>"
}
}
},
"DeleteWorkGroupOutput":{
"type":"structure",
"members":{
}
},
"DescriptionString":{
"type":"string",
"max":1024,
"min":1
},
"EncryptionConfiguration":{
"type":"structure",
"required":["EncryptionOption"],
"members":{
"EncryptionOption":{
"shape":"EncryptionOption",
"documentation":"<p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys (CSE-KMS) is used.</p> <p>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. </p>"
},
"KmsKey":{
"shape":"String",
"documentation":"<p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or ID.</p>"
}
},
"documentation":"<p>If query results are encrypted in Amazon S3, indicates the encryption option used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key information.</p>"
},
"EncryptionOption":{
"type":"string",
"enum":[
"SSE_S3",
"SSE_KMS",
"CSE_KMS"
]
},
"ErrorCode":{
"type":"string",
"documentation":"<p>The error code returned when the query execution failed to process, or when the processing request for the named query failed.</p>",
"max":256,
"min":1
},
"ErrorMessage":{"type":"string"},
"GetNamedQueryInput":{
"type":"structure",
"required":["NamedQueryId"],
"members":{
"NamedQueryId":{
"shape":"NamedQueryId",
"documentation":"<p>The unique ID of the query. Use <a>ListNamedQueries</a> to get query IDs.</p>"
}
}
},
"GetNamedQueryOutput":{
"type":"structure",
"members":{
"NamedQuery":{
"shape":"NamedQuery",
"documentation":"<p>Information about the query.</p>"
}
}
},
"GetQueryExecutionInput":{
"type":"structure",
"required":["QueryExecutionId"],
"members":{
"QueryExecutionId":{
"shape":"QueryExecutionId",
"documentation":"<p>The unique ID of the query execution.</p>"
}
}
},
"GetQueryExecutionOutput":{
"type":"structure",
"members":{
"QueryExecution":{
"shape":"QueryExecution",
"documentation":"<p>Information about the query execution.</p>"
}
}
},
"GetQueryResultsInput":{
"type":"structure",
"required":["QueryExecutionId"],
"members":{
"QueryExecutionId":{
"shape":"QueryExecutionId",
"documentation":"<p>The unique ID of the query execution.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>The token that specifies where to start pagination if a previous request was truncated.</p>"
},
"MaxResults":{
"shape":"MaxQueryResults",
"documentation":"<p>The maximum number of results (rows) to return in this request.</p>"
}
}
},
"GetQueryResultsOutput":{
"type":"structure",
"members":{
"UpdateCount":{
"shape":"Long",
"documentation":"<p>The number of rows inserted with a CREATE TABLE AS SELECT statement. </p>"
},
"ResultSet":{
"shape":"ResultSet",
"documentation":"<p>The results of the query execution.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
}
}
},
"GetWorkGroupInput":{
"type":"structure",
"required":["WorkGroup"],
"members":{
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup.</p>"
}
}
},
"GetWorkGroupOutput":{
"type":"structure",
"members":{
"WorkGroup":{
"shape":"WorkGroup",
"documentation":"<p>Information about the workgroup.</p>"
}
}
},
"IdempotencyToken":{
"type":"string",
"max":128,
"min":32
},
"Integer":{"type":"integer"},
"InternalServerException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Indicates a platform issue, which may be due to a transient condition or outage.</p>",
"exception":true,
"fault":true
},
"InvalidRequestException":{
"type":"structure",
"members":{
"AthenaErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>",
"exception":true
},
"ListNamedQueriesInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"Token",
"documentation":"<p>The token that specifies where to start pagination if a previous request was truncated.</p>"
},
"MaxResults":{
"shape":"MaxNamedQueriesCount",
"documentation":"<p>The maximum number of queries to return in this request.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup from which the named queries are being returned.</p>"
}
}
},
"ListNamedQueriesOutput":{
"type":"structure",
"members":{
"NamedQueryIds":{
"shape":"NamedQueryIdList",
"documentation":"<p>The list of unique query IDs.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
}
}
},
"ListQueryExecutionsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"Token",
"documentation":"<p>The token that specifies where to start pagination if a previous request was truncated.</p>"
},
"MaxResults":{
"shape":"MaxQueryExecutionsCount",
"documentation":"<p>The maximum number of query executions to return in this request.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup from which queries are being returned.</p>"
}
}
},
"ListQueryExecutionsOutput":{
"type":"structure",
"members":{
"QueryExecutionIds":{
"shape":"QueryExecutionIdList",
"documentation":"<p>The unique IDs of each query execution as an array of strings.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
}
}
},
"ListTagsForResourceInput":{
"type":"structure",
"required":["ResourceARN"],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>Lists the tags for the workgroup resource with the specified ARN.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>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 workgroup resource with the specified ARN.</p>"
},
"MaxResults":{
"shape":"MaxTagsCount",
"documentation":"<p>The maximum number of results to be returned per request that lists the tags for the workgroup resource.</p>"
}
}
},
"ListTagsForResourceOutput":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>The list of tags associated with this workgroup.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
}
}
},
"ListWorkGroupsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"Token",
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
},
"MaxResults":{
"shape":"MaxWorkGroupsCount",
"documentation":"<p>The maximum number of workgroups to return in this request.</p>"
}
}
},
"ListWorkGroupsOutput":{
"type":"structure",
"members":{
"WorkGroups":{
"shape":"WorkGroupsList",
"documentation":"<p>The list of workgroups, including their names, descriptions, creation times, and states.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
}
}
},
"Long":{"type":"long"},
"MaxNamedQueriesCount":{
"type":"integer",
"box":true,
"max":50,
"min":0
},
"MaxQueryExecutionsCount":{
"type":"integer",
"box":true,
"max":50,
"min":0
},
"MaxQueryResults":{
"type":"integer",
"box":true,
"max":1000,
"min":0
},
"MaxTagsCount":{
"type":"integer",
"box":true,
"min":75
},
"MaxWorkGroupsCount":{
"type":"integer",
"box":true,
"max":50,
"min":1
},
"NameString":{
"type":"string",
"max":128,
"min":1
},
"NamedQuery":{
"type":"structure",
"required":[
"Name",
"Database",
"QueryString"
],
"members":{
"Name":{
"shape":"NameString",
"documentation":"<p>The query name.</p>"
},
"Description":{
"shape":"DescriptionString",
"documentation":"<p>The query description.</p>"
},
"Database":{
"shape":"DatabaseString",
"documentation":"<p>The database to which the query belongs.</p>"
},
"QueryString":{
"shape":"QueryString",
"documentation":"<p>The SQL query statements that comprise the query.</p>"
},
"NamedQueryId":{
"shape":"NamedQueryId",
"documentation":"<p>The unique identifier of the query.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup that contains the named query.</p>"
}
},
"documentation":"<p>A query, where <code>QueryString</code> is the list of SQL query statements that comprise the query.</p>"
},
"NamedQueryId":{"type":"string"},
"NamedQueryIdList":{
"type":"list",
"member":{"shape":"NamedQueryId"},
"max":50,
"min":1
},
"NamedQueryList":{
"type":"list",
"member":{"shape":"NamedQuery"}
},
"QueryExecution":{
"type":"structure",
"members":{
"QueryExecutionId":{
"shape":"QueryExecutionId",
"documentation":"<p>The unique identifier for each query execution.</p>"
},
"Query":{
"shape":"QueryString",
"documentation":"<p>The SQL query statements which the query execution ran.</p>"
},
"StatementType":{
"shape":"StatementType",
"documentation":"<p>The type of query statement that was run. <code>DDL</code> indicates DDL query statements. <code>DML</code> indicates DML (Data Manipulation Language) query statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>, or <code>DESCRIBE &lt;table&gt;</code>.</p>"
},
"ResultConfiguration":{
"shape":"ResultConfiguration",
"documentation":"<p>The location in Amazon S3 where query results were 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.</p>"
},
"QueryExecutionContext":{
"shape":"QueryExecutionContext",
"documentation":"<p>The database in which the query execution occurred.</p>"
},
"Status":{
"shape":"QueryExecutionStatus",
"documentation":"<p>The completion date, current state, submission time, and state change reason (if applicable) for the query execution.</p>"
},
"Statistics":{
"shape":"QueryExecutionStatistics",
"documentation":"<p>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.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup in which the query ran.</p>"
}
},
"documentation":"<p>Information about a single instance of a query execution.</p>"
},
"QueryExecutionContext":{
"type":"structure",
"members":{
"Database":{
"shape":"DatabaseString",
"documentation":"<p>The name of the database.</p>"
}
},
"documentation":"<p>The database in which the query execution occurs.</p>"
},
"QueryExecutionId":{"type":"string"},
"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":"<p>The number of milliseconds that the query took to execute.</p>"
},
"DataScannedInBytes":{
"shape":"Long",
"documentation":"<p>The number of bytes in the data that was queried.</p>"
}
},
"documentation":"<p>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.</p>"
},
"QueryExecutionStatus":{
"type":"structure",
"members":{
"State":{
"shape":"QueryExecutionState",
"documentation":"<p>The state of query execution. <code>QUEUED</code> state is listed but is not used by Athena and is reserved for future use. <code>RUNNING</code> indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. <code>SUCCEEDED</code> indicates that the query completed without errors. <code>FAILED</code> indicates that the query experienced an error and did not complete processing. <code>CANCELLED</code> indicates that a user input interrupted query execution. </p>"
},
"StateChangeReason":{
"shape":"String",
"documentation":"<p>Further detail about the status of the query.</p>"
},
"SubmissionDateTime":{
"shape":"Date",
"documentation":"<p>The date and time that the query was submitted.</p>"
},
"CompletionDateTime":{
"shape":"Date",
"documentation":"<p>The date and time that the query completed.</p>"
}
},
"documentation":"<p>The completion date, current state, submission time, and state change reason (if applicable) for the query execution.</p>"
},
"QueryString":{
"type":"string",
"max":262144,
"min":1
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"ResourceName":{"shape":"AmazonResourceName"}
},
"documentation":"<p>A resource, such as a workgroup, was not found.</p>",
"exception":true
},
"ResultConfiguration":{
"type":"structure",
"members":{
"OutputLocation":{
"shape":"String",
"documentation":"<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Queries and Query Result Files.</a> 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 <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"EncryptionConfiguration":{
"shape":"EncryptionConfiguration",
"documentation":"<p>If query results are encrypted in Amazon S3, indicates the encryption option used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key information. 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 <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
}
},
"documentation":"<p>The location in Amazon S3 where query 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.</p>"
},
"ResultConfigurationUpdates":{
"type":"structure",
"members":{
"OutputLocation":{
"shape":"String",
"documentation":"<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Queries and Query Result Files.</a> 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 <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"RemoveOutputLocation":{
"shape":"BoxedBoolean",
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
},
"EncryptionConfiguration":{
"shape":"EncryptionConfiguration",
"documentation":"<p>The encryption configuration for the query results.</p>"
},
"RemoveEncryptionConfiguration":{
"shape":"BoxedBoolean",
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
}
},
"documentation":"<p>The information about the updates in the query results, such as output location and encryption configuration for the query results.</p>"
},
"ResultSet":{
"type":"structure",
"members":{
"Rows":{
"shape":"RowList",
"documentation":"<p>The rows in the table.</p>"
},
"ResultSetMetadata":{
"shape":"ResultSetMetadata",
"documentation":"<p>The metadata that describes the column structure and data types of a table of query results.</p>"
}
},
"documentation":"<p>The metadata and rows that comprise a query result set. The metadata describes the column structure and data types.</p>"
},
"ResultSetMetadata":{
"type":"structure",
"members":{
"ColumnInfo":{
"shape":"ColumnInfoList",
"documentation":"<p>Information about the columns returned in a query result metadata.</p>"
}
},
"documentation":"<p>The metadata that describes the column structure and data types of a table of query results. </p>"
},
"Row":{
"type":"structure",
"members":{
"Data":{
"shape":"datumList",
"documentation":"<p>The data that populates a row in a query result table.</p>"
}
},
"documentation":"<p>The rows that comprise a query result table.</p>"
},
"RowList":{
"type":"list",
"member":{"shape":"Row"}
},
"StartQueryExecutionInput":{
"type":"structure",
"required":["QueryString"],
"members":{
"QueryString":{
"shape":"QueryString",
"documentation":"<p>The SQL query statements to be executed.</p>"
},
"ClientRequestToken":{
"shape":"IdempotencyToken",
"documentation":"<p>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <code>StartQueryExecution</code> request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the <code>QueryString</code>, an error is returned.</p> <important> <p>This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.</p> </important>",
"idempotencyToken":true
},
"QueryExecutionContext":{
"shape":"QueryExecutionContext",
"documentation":"<p>The database within which the query executes.</p>"
},
"ResultConfiguration":{
"shape":"ResultConfiguration",
"documentation":"<p>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 <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup in which the query is being started.</p>"
}
}
},
"StartQueryExecutionOutput":{
"type":"structure",
"members":{
"QueryExecutionId":{
"shape":"QueryExecutionId",
"documentation":"<p>The unique ID of the query that ran as a result of this request.</p>"
}
}
},
"StatementType":{
"type":"string",
"enum":[
"DDL",
"DML",
"UTILITY"
]
},
"StopQueryExecutionInput":{
"type":"structure",
"required":["QueryExecutionId"],
"members":{
"QueryExecutionId":{
"shape":"QueryExecutionId",
"documentation":"<p>The unique ID of the query execution to stop.</p>",
"idempotencyToken":true
}
}
},
"StopQueryExecutionOutput":{
"type":"structure",
"members":{
}
},
"String":{"type":"string"},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>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. </p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>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. </p>"
}
},
"documentation":"<p>A tag that you can add to a resource. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize workgroups in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. The maximum tag key length is 128 Unicode characters in UTF-8. The maximum tag value length is 256 Unicode characters in UTF-8. You 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. </p>"
},
"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":"<p>Requests that one or more tags are added to the resource (such as a workgroup) for the specified ARN.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>One or more tags, separated by commas, to be added to the resource, such as a workgroup.</p>"
}
}
},
"TagResourceOutput":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"ThrottleReason":{
"type":"string",
"documentation":"<p>The reason for the query throttling, for example, when it exceeds the concurrent query limit.</p>",
"enum":["CONCURRENT_QUERY_LIMIT_EXCEEDED"]
},
"Token":{
"type":"string",
"max":1024,
"min":1
},
"TooManyRequestsException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"Reason":{"shape":"ThrottleReason"}
},
"documentation":"<p>Indicates that the request was throttled.</p>",
"exception":true
},
"UnprocessedNamedQueryId":{
"type":"structure",
"members":{
"NamedQueryId":{
"shape":"NamedQueryId",
"documentation":"<p>The unique identifier of the named query.</p>"
},
"ErrorCode":{
"shape":"ErrorCode",
"documentation":"<p>The error code returned when the processing request for the named query failed, if applicable.</p>"
},
"ErrorMessage":{
"shape":"ErrorMessage",
"documentation":"<p>The error message returned when the processing request for the named query failed, if applicable.</p>"
}
},
"documentation":"<p>Information about a named query ID that could not be processed.</p>"
},
"UnprocessedNamedQueryIdList":{
"type":"list",
"member":{"shape":"UnprocessedNamedQueryId"}
},
"UnprocessedQueryExecutionId":{
"type":"structure",
"members":{
"QueryExecutionId":{
"shape":"QueryExecutionId",
"documentation":"<p>The unique identifier of the query execution.</p>"
},
"ErrorCode":{
"shape":"ErrorCode",
"documentation":"<p>The error code returned when the query execution failed to process, if applicable.</p>"
},
"ErrorMessage":{
"shape":"ErrorMessage",
"documentation":"<p>The error message returned when the query execution failed to process, if applicable.</p>"
}
},
"documentation":"<p>Describes a query execution that failed to process.</p>"
},
"UnprocessedQueryExecutionIdList":{
"type":"list",
"member":{"shape":"UnprocessedQueryExecutionId"}
},
"UntagResourceInput":{
"type":"structure",
"required":[
"ResourceARN",
"TagKeys"
],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>Removes one or more tags from the workgroup resource for the specified ARN.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>Removes the tags associated with one or more tag keys from the workgroup resource.</p>"
}
}
},
"UntagResourceOutput":{
"type":"structure",
"members":{
}
},
"UpdateWorkGroupInput":{
"type":"structure",
"required":["WorkGroup"],
"members":{
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The specified workgroup that will be updated.</p>"
},
"Description":{
"shape":"WorkGroupDescriptionString",
"documentation":"<p>The workgroup description.</p>"
},
"ConfigurationUpdates":{
"shape":"WorkGroupConfigurationUpdates",
"documentation":"<p>The workgroup configuration that will be updated for the given workgroup.</p>"
},
"State":{
"shape":"WorkGroupState",
"documentation":"<p>The workgroup state that will be updated for the given workgroup.</p>"
}
}
},
"UpdateWorkGroupOutput":{
"type":"structure",
"members":{
}
},
"WorkGroup":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"WorkGroupName",
"documentation":"<p>The workgroup name.</p>"
},
"State":{
"shape":"WorkGroupState",
"documentation":"<p>The state of the workgroup: ENABLED or DISABLED.</p>"
},
"Configuration":{
"shape":"WorkGroupConfiguration",
"documentation":"<p>The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limit for the amount of data scanned per query, if it is specified. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"Description":{
"shape":"WorkGroupDescriptionString",
"documentation":"<p>The workgroup description.</p>"
},
"CreationTime":{
"shape":"Date",
"documentation":"<p>The date and time the workgroup was created.</p>"
}
},
"documentation":"<p>A workgroup, which contains a name, description, creation time, state, and other configuration, listed under <a>WorkGroup$Configuration</a>. 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 <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"WorkGroupConfiguration":{
"type":"structure",
"members":{
"ResultConfiguration":{
"shape":"ResultConfiguration",
"documentation":"<p>The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.</p>"
},
"EnforceWorkGroupConfiguration":{
"shape":"BoxedBoolean",
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
},
"PublishCloudWatchMetricsEnabled":{
"shape":"BoxedBoolean",
"documentation":"<p>Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.</p>"
},
"BytesScannedCutoffPerQuery":{
"shape":"BytesScannedCutoffValue",
"documentation":"<p>The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</p>"
}
},
"documentation":"<p>The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limit for the amount of data scanned per query, if it is specified. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"WorkGroupConfigurationUpdates":{
"type":"structure",
"members":{
"EnforceWorkGroupConfiguration":{
"shape":"BoxedBoolean",
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
},
"ResultConfigurationUpdates":{
"shape":"ResultConfigurationUpdates",
"documentation":"<p>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.</p>"
},
"PublishCloudWatchMetricsEnabled":{
"shape":"BoxedBoolean",
"documentation":"<p>Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.</p>"
},
"BytesScannedCutoffPerQuery":{
"shape":"BytesScannedCutoffValue",
"documentation":"<p>The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</p>"
},
"RemoveBytesScannedCutoffPerQuery":{
"shape":"BoxedBoolean",
"documentation":"<p>Indicates that the data usage control limit per query is removed. <a>WorkGroupConfiguration$BytesScannedCutoffPerQuery</a> </p>"
}
},
"documentation":"<p>The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query 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.</p>"
},
"WorkGroupDescriptionString":{
"type":"string",
"max":1024,
"min":0
},
"WorkGroupName":{
"type":"string",
"pattern":"[a-zA-z0-9._-]{1,128}"
},
"WorkGroupState":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"WorkGroupSummary":{
"type":"structure",
"members":{
"Name":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup.</p>"
},
"State":{
"shape":"WorkGroupState",
"documentation":"<p>The state of the workgroup.</p>"
},
"Description":{
"shape":"WorkGroupDescriptionString",
"documentation":"<p>The workgroup description.</p>"
},
"CreationTime":{
"shape":"Date",
"documentation":"<p>The workgroup creation date and time.</p>"
}
},
"documentation":"<p>The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.</p>"
},
"WorkGroupsList":{
"type":"list",
"member":{"shape":"WorkGroupSummary"},
"max":50,
"min":0
},
"datumList":{
"type":"list",
"member":{"shape":"Datum"}
},
"datumString":{"type":"string"}
},
"documentation":"<p>Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/what-is.html\">What is Amazon Athena</a> in the <i>Amazon Athena User Guide</i>.</p> <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html\">Accessing Amazon Athena with JDBC</a>.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
}