mypy-boto3-athena 1.28.0__py3-none-any.whl → 1.34.130__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -29,6 +29,7 @@ Usage::
29
29
  list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
30
30
  ```
31
31
  """
32
+
32
33
  from .client import AthenaClient
33
34
  from .paginator import (
34
35
  GetQueryResultsPaginator,
@@ -42,7 +43,6 @@ from .paginator import (
42
43
 
43
44
  Client = AthenaClient
44
45
 
45
-
46
46
  __all__ = (
47
47
  "AthenaClient",
48
48
  "Client",
@@ -29,6 +29,7 @@ Usage::
29
29
  list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
30
30
  ```
31
31
  """
32
+
32
33
  from .client import AthenaClient
33
34
  from .paginator import (
34
35
  GetQueryResultsPaginator,
@@ -1,6 +1,7 @@
1
1
  """
2
2
  Main CLI entrypoint.
3
3
  """
4
+
4
5
  import sys
5
6
 
6
7
 
@@ -9,12 +10,13 @@ def print_info() -> None:
9
10
  Print package info to stdout.
10
11
  """
11
12
  print(
12
- "Type annotations for boto3.Athena 1.28.0\nVersion: 1.28.0\nBuilder version:"
13
- " 7.14.5\nDocs: "
14
- " https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena//\nBoto3 docs: "
15
- " https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena\nOther"
16
- " services: https://pypi.org/project/boto3-stubs/\nChangelog: "
17
- " https://github.com/youtype/mypy_boto3_builder/releases"
13
+ "Type annotations for boto3.Athena 1.34.130\n"
14
+ "Version: 1.34.130\n"
15
+ "Builder version: 7.24.0\n"
16
+ "Docs: https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena//\n"
17
+ "Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena\n"
18
+ "Other services: https://pypi.org/project/boto3-stubs/\n"
19
+ "Changelog: https://github.com/youtype/mypy_boto3_builder/releases"
18
20
  )
19
21
 
20
22
 
@@ -22,7 +24,7 @@ def print_version() -> None:
22
24
  """
23
25
  Print package version to stdout.
24
26
  """
25
- print("1.28.0")
27
+ print("1.34.130")
26
28
 
27
29
 
28
30
  def main() -> None:
@@ -13,6 +13,7 @@ Usage::
13
13
  client: AthenaClient = session.client("athena")
14
14
  ```
15
15
  """
16
+
16
17
  import sys
17
18
  from typing import Any, Dict, Mapping, Sequence, Type, overload
18
19
 
@@ -39,11 +40,11 @@ from .type_defs import (
39
40
  BatchGetPreparedStatementOutputTypeDef,
40
41
  BatchGetQueryExecutionOutputTypeDef,
41
42
  CalculationConfigurationTypeDef,
42
- CapacityAssignmentTypeDef,
43
+ CapacityAssignmentUnionTypeDef,
43
44
  CreateNamedQueryOutputTypeDef,
44
45
  CreateNotebookOutputTypeDef,
45
46
  CreatePresignedNotebookUrlResponseTypeDef,
46
- EngineConfigurationTypeDef,
47
+ EngineConfigurationUnionTypeDef,
47
48
  ExportNotebookOutputTypeDef,
48
49
  FilterDefinitionTypeDef,
49
50
  GetCalculationExecutionCodeResponseTypeDef,
@@ -93,16 +94,15 @@ from .type_defs import (
93
94
  WorkGroupConfigurationUpdatesTypeDef,
94
95
  )
95
96
 
96
- if sys.version_info >= (3, 9):
97
+ if sys.version_info >= (3, 12):
97
98
  from typing import Literal
98
99
  else:
99
100
  from typing_extensions import Literal
100
101
 
101
-
102
102
  __all__ = ("AthenaClient",)
103
103
 
104
104
 
105
- class BotocoreClientError(BaseException):
105
+ class BotocoreClientError(Exception):
106
106
  MSG_TEMPLATE: str
107
107
 
108
108
  def __init__(self, error_response: Mapping[str, Any], operation_name: str) -> None:
@@ -141,8 +141,9 @@ class AthenaClient(BaseClient):
141
141
  self, *, NamedQueryIds: Sequence[str]
142
142
  ) -> BatchGetNamedQueryOutputTypeDef:
143
143
  """
144
- Returns the details of a single named query or a list of up to 50 queries, which
145
- you provide as an array of query ID strings.
144
+ Returns the details of a single named query or a list of up to 50 queries,
145
+ which you provide as an array of query ID
146
+ strings.
146
147
 
147
148
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.batch_get_named_query)
148
149
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#batch_get_named_query)
@@ -153,7 +154,8 @@ class AthenaClient(BaseClient):
153
154
  ) -> BatchGetPreparedStatementOutputTypeDef:
154
155
  """
155
156
  Returns the details of a single prepared statement or a list of up to 256
156
- prepared statements for the array of prepared statement names that you provide.
157
+ prepared statements for the array of prepared statement names that you
158
+ provide.
157
159
 
158
160
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.batch_get_prepared_statement)
159
161
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#batch_get_prepared_statement)
@@ -164,7 +166,8 @@ class AthenaClient(BaseClient):
164
166
  ) -> BatchGetQueryExecutionOutputTypeDef:
165
167
  """
166
168
  Returns the details of a single query execution or a list of up to 50 query
167
- executions, which you provide as an array of query execution ID strings.
169
+ executions, which you provide as an array of query execution ID
170
+ strings.
168
171
 
169
172
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.batch_get_query_execution)
170
173
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#batch_get_query_execution)
@@ -199,7 +202,8 @@ class AthenaClient(BaseClient):
199
202
  ) -> Dict[str, Any]:
200
203
  """
201
204
  Creates a capacity reservation with the specified name and number of requested
202
- data processing units.
205
+ data processing
206
+ units.
203
207
 
204
208
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.create_capacity_reservation)
205
209
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#create_capacity_reservation)
@@ -212,7 +216,7 @@ class AthenaClient(BaseClient):
212
216
  Type: DataCatalogTypeType,
213
217
  Description: str = ...,
214
218
  Parameters: Mapping[str, str] = ...,
215
- Tags: Sequence[TagTypeDef] = ...
219
+ Tags: Sequence[TagTypeDef] = ...,
216
220
  ) -> Dict[str, Any]:
217
221
  """
218
222
  Creates (registers) a data catalog with the specified name and properties.
@@ -229,7 +233,7 @@ class AthenaClient(BaseClient):
229
233
  QueryString: str,
230
234
  Description: str = ...,
231
235
  ClientRequestToken: str = ...,
232
- WorkGroup: str = ...
236
+ WorkGroup: str = ...,
233
237
  ) -> CreateNamedQueryOutputTypeDef:
234
238
  """
235
239
  Creates a named query in the specified workgroup.
@@ -274,7 +278,7 @@ class AthenaClient(BaseClient):
274
278
  Name: str,
275
279
  Configuration: WorkGroupConfigurationTypeDef = ...,
276
280
  Description: str = ...,
277
- Tags: Sequence[TagTypeDef] = ...
281
+ Tags: Sequence[TagTypeDef] = ...,
278
282
  ) -> Dict[str, Any]:
279
283
  """
280
284
  Creates a workgroup with the specified name.
@@ -302,7 +306,8 @@ class AthenaClient(BaseClient):
302
306
  def delete_named_query(self, *, NamedQueryId: str) -> Dict[str, Any]:
303
307
  """
304
308
  Deletes the named query if you have access to the workgroup in which the query
305
- was saved.
309
+ was
310
+ saved.
306
311
 
307
312
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.delete_named_query)
308
313
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#delete_named_query)
@@ -406,7 +411,7 @@ class AthenaClient(BaseClient):
406
411
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#get_capacity_reservation)
407
412
  """
408
413
 
409
- def get_data_catalog(self, *, Name: str) -> GetDataCatalogOutputTypeDef:
414
+ def get_data_catalog(self, *, Name: str, WorkGroup: str = ...) -> GetDataCatalogOutputTypeDef:
410
415
  """
411
416
  Returns the specified data catalog.
412
417
 
@@ -414,7 +419,9 @@ class AthenaClient(BaseClient):
414
419
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#get_data_catalog)
415
420
  """
416
421
 
417
- def get_database(self, *, CatalogName: str, DatabaseName: str) -> GetDatabaseOutputTypeDef:
422
+ def get_database(
423
+ self, *, CatalogName: str, DatabaseName: str, WorkGroup: str = ...
424
+ ) -> GetDatabaseOutputTypeDef:
418
425
  """
419
426
  Returns a database object for the specified database and data catalog.
420
427
 
@@ -452,7 +459,8 @@ class AthenaClient(BaseClient):
452
459
  def get_query_execution(self, *, QueryExecutionId: str) -> GetQueryExecutionOutputTypeDef:
453
460
  """
454
461
  Returns information about a single execution of a query if you have access to
455
- the workgroup in which the query ran.
462
+ the workgroup in which the query
463
+ ran.
456
464
 
457
465
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.get_query_execution)
458
466
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#get_query_execution)
@@ -463,7 +471,8 @@ class AthenaClient(BaseClient):
463
471
  ) -> GetQueryResultsOutputTypeDef:
464
472
  """
465
473
  Streams the results of a single query execution specified by `QueryExecutionId`
466
- from the Athena query results location in Amazon S3.
474
+ from the Athena query results location in Amazon
475
+ S3.
467
476
 
468
477
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.get_query_results)
469
478
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#get_query_results)
@@ -474,7 +483,8 @@ class AthenaClient(BaseClient):
474
483
  ) -> GetQueryRuntimeStatisticsOutputTypeDef:
475
484
  """
476
485
  Returns query execution runtime statistics related to a single execution of a
477
- query if you have access to the workgroup in which the query ran.
486
+ query if you have access to the workgroup in which the query
487
+ ran.
478
488
 
479
489
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.get_query_runtime_statistics)
480
490
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#get_query_runtime_statistics)
@@ -483,7 +493,8 @@ class AthenaClient(BaseClient):
483
493
  def get_session(self, *, SessionId: str) -> GetSessionResponseTypeDef:
484
494
  """
485
495
  Gets the full details of a previously created session, including the session
486
- status and configuration.
496
+ status and
497
+ configuration.
487
498
 
488
499
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.get_session)
489
500
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#get_session)
@@ -498,7 +509,7 @@ class AthenaClient(BaseClient):
498
509
  """
499
510
 
500
511
  def get_table_metadata(
501
- self, *, CatalogName: str, DatabaseName: str, TableName: str
512
+ self, *, CatalogName: str, DatabaseName: str, TableName: str, WorkGroup: str = ...
502
513
  ) -> GetTableMetadataOutputTypeDef:
503
514
  """
504
515
  Returns table metadata for the specified catalog, database, and table.
@@ -520,9 +531,10 @@ class AthenaClient(BaseClient):
520
531
  *,
521
532
  WorkGroup: str,
522
533
  Name: str,
523
- Payload: str,
524
534
  Type: Literal["IPYNB"],
525
- ClientRequestToken: str = ...
535
+ Payload: str = ...,
536
+ NotebookS3LocationUri: str = ...,
537
+ ClientRequestToken: str = ...,
526
538
  ) -> ImportNotebookOutputTypeDef:
527
539
  """
528
540
  Imports a single `ipynb` file to a Spark enabled workgroup.
@@ -536,7 +548,8 @@ class AthenaClient(BaseClient):
536
548
  ) -> ListApplicationDPUSizesOutputTypeDef:
537
549
  """
538
550
  Returns the supported DPU sizes for the supported application runtimes (for
539
- example, `Athena notebook version 1`).
551
+ example, `Athena notebook version
552
+ 1`).
540
553
 
541
554
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.list_application_dpu_sizes)
542
555
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#list_application_dpu_sizes)
@@ -548,7 +561,7 @@ class AthenaClient(BaseClient):
548
561
  SessionId: str,
549
562
  StateFilter: CalculationExecutionStateType = ...,
550
563
  MaxResults: int = ...,
551
- NextToken: str = ...
564
+ NextToken: str = ...,
552
565
  ) -> ListCalculationExecutionsResponseTypeDef:
553
566
  """
554
567
  Lists the calculations that have been submitted to a session in descending
@@ -569,7 +582,7 @@ class AthenaClient(BaseClient):
569
582
  """
570
583
 
571
584
  def list_data_catalogs(
572
- self, *, NextToken: str = ..., MaxResults: int = ...
585
+ self, *, NextToken: str = ..., MaxResults: int = ..., WorkGroup: str = ...
573
586
  ) -> ListDataCatalogsOutputTypeDef:
574
587
  """
575
588
  Lists the data catalogs in the current Amazon Web Services account.
@@ -579,7 +592,7 @@ class AthenaClient(BaseClient):
579
592
  """
580
593
 
581
594
  def list_databases(
582
- self, *, CatalogName: str, NextToken: str = ..., MaxResults: int = ...
595
+ self, *, CatalogName: str, NextToken: str = ..., MaxResults: int = ..., WorkGroup: str = ...
583
596
  ) -> ListDatabasesOutputTypeDef:
584
597
  """
585
598
  Lists the databases in the specified data catalog.
@@ -593,7 +606,8 @@ class AthenaClient(BaseClient):
593
606
  ) -> ListEngineVersionsOutputTypeDef:
594
607
  """
595
608
  Returns a list of engine versions that are available to choose from, including
596
- the Auto option.
609
+ the Auto
610
+ option.
597
611
 
598
612
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.list_engine_versions)
599
613
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#list_engine_versions)
@@ -605,7 +619,7 @@ class AthenaClient(BaseClient):
605
619
  SessionId: str,
606
620
  ExecutorStateFilter: ExecutorStateType = ...,
607
621
  MaxResults: int = ...,
608
- NextToken: str = ...
622
+ NextToken: str = ...,
609
623
  ) -> ListExecutorsResponseTypeDef:
610
624
  """
611
625
  Lists, in descending order, the executors that joined a session.
@@ -631,7 +645,7 @@ class AthenaClient(BaseClient):
631
645
  WorkGroup: str,
632
646
  Filters: FilterDefinitionTypeDef = ...,
633
647
  NextToken: str = ...,
634
- MaxResults: int = ...
648
+ MaxResults: int = ...,
635
649
  ) -> ListNotebookMetadataOutputTypeDef:
636
650
  """
637
651
  Displays the notebook files for the specified workgroup in paginated format.
@@ -645,7 +659,8 @@ class AthenaClient(BaseClient):
645
659
  ) -> ListNotebookSessionsResponseTypeDef:
646
660
  """
647
661
  Lists, in descending order, the sessions that have been created in a notebook
648
- that are in an active state like `CREATING`, `CREATED`, `IDLE` or `BUSY`.
662
+ that are in an active state like `CREATING`, `CREATED`, `IDLE` or
663
+ `BUSY`.
649
664
 
650
665
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.list_notebook_sessions)
651
666
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#list_notebook_sessions)
@@ -666,7 +681,8 @@ class AthenaClient(BaseClient):
666
681
  ) -> ListQueryExecutionsOutputTypeDef:
667
682
  """
668
683
  Provides a list of available query execution IDs for the queries in the
669
- specified workgroup.
684
+ specified
685
+ workgroup.
670
686
 
671
687
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.list_query_executions)
672
688
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#list_query_executions)
@@ -678,11 +694,12 @@ class AthenaClient(BaseClient):
678
694
  WorkGroup: str,
679
695
  StateFilter: SessionStateType = ...,
680
696
  MaxResults: int = ...,
681
- NextToken: str = ...
697
+ NextToken: str = ...,
682
698
  ) -> ListSessionsResponseTypeDef:
683
699
  """
684
700
  Lists the sessions in a workgroup that are in an active state like `CREATING`,
685
- `CREATED`, `IDLE`, or `BUSY`.
701
+ `CREATED`, `IDLE`, or
702
+ `BUSY`.
686
703
 
687
704
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.list_sessions)
688
705
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#list_sessions)
@@ -695,7 +712,8 @@ class AthenaClient(BaseClient):
695
712
  DatabaseName: str,
696
713
  Expression: str = ...,
697
714
  NextToken: str = ...,
698
- MaxResults: int = ...
715
+ MaxResults: int = ...,
716
+ WorkGroup: str = ...,
699
717
  ) -> ListTableMetadataOutputTypeDef:
700
718
  """
701
719
  Lists the metadata for the tables in the specified data catalog database.
@@ -728,7 +746,7 @@ class AthenaClient(BaseClient):
728
746
  self,
729
747
  *,
730
748
  CapacityReservationName: str,
731
- CapacityAssignments: Sequence[CapacityAssignmentTypeDef]
749
+ CapacityAssignments: Sequence[CapacityAssignmentUnionTypeDef],
732
750
  ) -> Dict[str, Any]:
733
751
  """
734
752
  Puts a new capacity assignment configuration for a specified capacity
@@ -745,7 +763,7 @@ class AthenaClient(BaseClient):
745
763
  Description: str = ...,
746
764
  CalculationConfiguration: CalculationConfigurationTypeDef = ...,
747
765
  CodeBlock: str = ...,
748
- ClientRequestToken: str = ...
766
+ ClientRequestToken: str = ...,
749
767
  ) -> StartCalculationExecutionResponseTypeDef:
750
768
  """
751
769
  Submits calculations for execution within a session.
@@ -763,7 +781,7 @@ class AthenaClient(BaseClient):
763
781
  ResultConfiguration: ResultConfigurationTypeDef = ...,
764
782
  WorkGroup: str = ...,
765
783
  ExecutionParameters: Sequence[str] = ...,
766
- ResultReuseConfiguration: ResultReuseConfigurationTypeDef = ...
784
+ ResultReuseConfiguration: ResultReuseConfigurationTypeDef = ...,
767
785
  ) -> StartQueryExecutionOutputTypeDef:
768
786
  """
769
787
  Runs the SQL query statements contained in the `Query`.
@@ -776,11 +794,11 @@ class AthenaClient(BaseClient):
776
794
  self,
777
795
  *,
778
796
  WorkGroup: str,
779
- EngineConfiguration: EngineConfigurationTypeDef,
797
+ EngineConfiguration: EngineConfigurationUnionTypeDef,
780
798
  Description: str = ...,
781
799
  NotebookVersion: str = ...,
782
800
  SessionIdleTimeoutInMinutes: int = ...,
783
- ClientRequestToken: str = ...
801
+ ClientRequestToken: str = ...,
784
802
  ) -> StartSessionResponseTypeDef:
785
803
  """
786
804
  Creates a session for running calculations within a workgroup.
@@ -834,7 +852,8 @@ class AthenaClient(BaseClient):
834
852
  def update_capacity_reservation(self, *, TargetDpus: int, Name: str) -> Dict[str, Any]:
835
853
  """
836
854
  Updates the number of requested data processing units for the capacity
837
- reservation with the specified name.
855
+ reservation with the specified
856
+ name.
838
857
 
839
858
  [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena.Client.update_capacity_reservation)
840
859
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/client/#update_capacity_reservation)
@@ -846,7 +865,7 @@ class AthenaClient(BaseClient):
846
865
  Name: str,
847
866
  Type: DataCatalogTypeType,
848
867
  Description: str = ...,
849
- Parameters: Mapping[str, str] = ...
868
+ Parameters: Mapping[str, str] = ...,
850
869
  ) -> Dict[str, Any]:
851
870
  """
852
871
  Updates the data catalog that has the specified name.
@@ -872,7 +891,7 @@ class AthenaClient(BaseClient):
872
891
  Payload: str,
873
892
  Type: Literal["IPYNB"],
874
893
  SessionId: str = ...,
875
- ClientRequestToken: str = ...
894
+ ClientRequestToken: str = ...,
876
895
  ) -> Dict[str, Any]:
877
896
  """
878
897
  Updates the contents of a Spark notebook.
@@ -907,7 +926,7 @@ class AthenaClient(BaseClient):
907
926
  WorkGroup: str,
908
927
  Description: str = ...,
909
928
  ConfigurationUpdates: WorkGroupConfigurationUpdatesTypeDef = ...,
910
- State: WorkGroupStateType = ...
929
+ State: WorkGroupStateType = ...,
911
930
  ) -> Dict[str, Any]:
912
931
  """
913
932
  Updates the workgroup with the specified name.