types-boto3-redshift-data 1.36.0__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.
@@ -0,0 +1,59 @@
1
+ """
2
+ Main interface for redshift-data service.
3
+
4
+ Usage::
5
+
6
+ ```python
7
+ from boto3.session import Session
8
+ from types_boto3_redshift_data import (
9
+ Client,
10
+ DescribeTablePaginator,
11
+ GetStatementResultPaginator,
12
+ GetStatementResultV2Paginator,
13
+ ListDatabasesPaginator,
14
+ ListSchemasPaginator,
15
+ ListStatementsPaginator,
16
+ ListTablesPaginator,
17
+ RedshiftDataAPIServiceClient,
18
+ )
19
+
20
+ session = Session()
21
+ client: RedshiftDataAPIServiceClient = session.client("redshift-data")
22
+
23
+ describe_table_paginator: DescribeTablePaginator = client.get_paginator("describe_table")
24
+ get_statement_result_paginator: GetStatementResultPaginator = client.get_paginator("get_statement_result")
25
+ get_statement_result_v2_paginator: GetStatementResultV2Paginator = client.get_paginator("get_statement_result_v2")
26
+ list_databases_paginator: ListDatabasesPaginator = client.get_paginator("list_databases")
27
+ list_schemas_paginator: ListSchemasPaginator = client.get_paginator("list_schemas")
28
+ list_statements_paginator: ListStatementsPaginator = client.get_paginator("list_statements")
29
+ list_tables_paginator: ListTablesPaginator = client.get_paginator("list_tables")
30
+ ```
31
+
32
+ Copyright 2025 Vlad Emelianov
33
+ """
34
+
35
+ from .client import RedshiftDataAPIServiceClient
36
+ from .paginator import (
37
+ DescribeTablePaginator,
38
+ GetStatementResultPaginator,
39
+ GetStatementResultV2Paginator,
40
+ ListDatabasesPaginator,
41
+ ListSchemasPaginator,
42
+ ListStatementsPaginator,
43
+ ListTablesPaginator,
44
+ )
45
+
46
+ Client = RedshiftDataAPIServiceClient
47
+
48
+
49
+ __all__ = (
50
+ "Client",
51
+ "DescribeTablePaginator",
52
+ "GetStatementResultPaginator",
53
+ "GetStatementResultV2Paginator",
54
+ "ListDatabasesPaginator",
55
+ "ListSchemasPaginator",
56
+ "ListStatementsPaginator",
57
+ "ListTablesPaginator",
58
+ "RedshiftDataAPIServiceClient",
59
+ )
@@ -0,0 +1,58 @@
1
+ """
2
+ Main interface for redshift-data service.
3
+
4
+ Usage::
5
+
6
+ ```python
7
+ from boto3.session import Session
8
+ from types_boto3_redshift_data import (
9
+ Client,
10
+ DescribeTablePaginator,
11
+ GetStatementResultPaginator,
12
+ GetStatementResultV2Paginator,
13
+ ListDatabasesPaginator,
14
+ ListSchemasPaginator,
15
+ ListStatementsPaginator,
16
+ ListTablesPaginator,
17
+ RedshiftDataAPIServiceClient,
18
+ )
19
+
20
+ session = Session()
21
+ client: RedshiftDataAPIServiceClient = session.client("redshift-data")
22
+
23
+ describe_table_paginator: DescribeTablePaginator = client.get_paginator("describe_table")
24
+ get_statement_result_paginator: GetStatementResultPaginator = client.get_paginator("get_statement_result")
25
+ get_statement_result_v2_paginator: GetStatementResultV2Paginator = client.get_paginator("get_statement_result_v2")
26
+ list_databases_paginator: ListDatabasesPaginator = client.get_paginator("list_databases")
27
+ list_schemas_paginator: ListSchemasPaginator = client.get_paginator("list_schemas")
28
+ list_statements_paginator: ListStatementsPaginator = client.get_paginator("list_statements")
29
+ list_tables_paginator: ListTablesPaginator = client.get_paginator("list_tables")
30
+ ```
31
+
32
+ Copyright 2025 Vlad Emelianov
33
+ """
34
+
35
+ from .client import RedshiftDataAPIServiceClient
36
+ from .paginator import (
37
+ DescribeTablePaginator,
38
+ GetStatementResultPaginator,
39
+ GetStatementResultV2Paginator,
40
+ ListDatabasesPaginator,
41
+ ListSchemasPaginator,
42
+ ListStatementsPaginator,
43
+ ListTablesPaginator,
44
+ )
45
+
46
+ Client = RedshiftDataAPIServiceClient
47
+
48
+ __all__ = (
49
+ "Client",
50
+ "DescribeTablePaginator",
51
+ "GetStatementResultPaginator",
52
+ "GetStatementResultV2Paginator",
53
+ "ListDatabasesPaginator",
54
+ "ListSchemasPaginator",
55
+ "ListStatementsPaginator",
56
+ "ListTablesPaginator",
57
+ "RedshiftDataAPIServiceClient",
58
+ )
@@ -0,0 +1,43 @@
1
+ """
2
+ Main CLI entrypoint.
3
+
4
+ Copyright 2025 Vlad Emelianov
5
+ """
6
+
7
+ import sys
8
+
9
+
10
+ def print_info() -> None:
11
+ """
12
+ Print package info to stdout.
13
+ """
14
+ sys.stdout.write(
15
+ "Type annotations for boto3 RedshiftDataAPIService 1.36.0\n"
16
+ "Version: 1.36.0\n"
17
+ "Builder version: 8.8.0\n"
18
+ "Docs: https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data//\n"
19
+ "Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data.html#redshiftdataapiservice\n"
20
+ "Other services: https://pypi.org/project/boto3-stubs/\n"
21
+ "Changelog: https://github.com/youtype/mypy_boto3_builder/releases\n"
22
+ )
23
+
24
+
25
+ def print_version() -> None:
26
+ """
27
+ Print package version to stdout.
28
+ """
29
+ sys.stdout.write("1.36.0\n")
30
+
31
+
32
+ def main() -> None:
33
+ """
34
+ Main CLI entrypoint.
35
+ """
36
+ if "--version" in sys.argv:
37
+ print_version()
38
+ return
39
+ print_info()
40
+
41
+
42
+ if __name__ == "__main__":
43
+ main()
@@ -0,0 +1,312 @@
1
+ """
2
+ Type annotations for redshift-data service Client.
3
+
4
+ [Documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/)
5
+
6
+ Usage::
7
+
8
+ ```python
9
+ from boto3.session import Session
10
+ from types_boto3_redshift_data.client import RedshiftDataAPIServiceClient
11
+
12
+ session = Session()
13
+ client: RedshiftDataAPIServiceClient = session.client("redshift-data")
14
+ ```
15
+
16
+ Copyright 2025 Vlad Emelianov
17
+ """
18
+
19
+ from __future__ import annotations
20
+
21
+ import sys
22
+ from typing import Any, overload
23
+
24
+ from botocore.client import BaseClient, ClientMeta
25
+ from botocore.errorfactory import BaseClientExceptions
26
+ from botocore.exceptions import ClientError as BotocoreClientError
27
+
28
+ from .paginator import (
29
+ DescribeTablePaginator,
30
+ GetStatementResultPaginator,
31
+ GetStatementResultV2Paginator,
32
+ ListDatabasesPaginator,
33
+ ListSchemasPaginator,
34
+ ListStatementsPaginator,
35
+ ListTablesPaginator,
36
+ )
37
+ from .type_defs import (
38
+ BatchExecuteStatementInputRequestTypeDef,
39
+ BatchExecuteStatementOutputTypeDef,
40
+ CancelStatementRequestRequestTypeDef,
41
+ CancelStatementResponseTypeDef,
42
+ DescribeStatementRequestRequestTypeDef,
43
+ DescribeStatementResponseTypeDef,
44
+ DescribeTableRequestRequestTypeDef,
45
+ DescribeTableResponseTypeDef,
46
+ ExecuteStatementInputRequestTypeDef,
47
+ ExecuteStatementOutputTypeDef,
48
+ GetStatementResultRequestRequestTypeDef,
49
+ GetStatementResultResponseTypeDef,
50
+ GetStatementResultV2RequestRequestTypeDef,
51
+ GetStatementResultV2ResponseTypeDef,
52
+ ListDatabasesRequestRequestTypeDef,
53
+ ListDatabasesResponseTypeDef,
54
+ ListSchemasRequestRequestTypeDef,
55
+ ListSchemasResponseTypeDef,
56
+ ListStatementsRequestRequestTypeDef,
57
+ ListStatementsResponseTypeDef,
58
+ ListTablesRequestRequestTypeDef,
59
+ ListTablesResponseTypeDef,
60
+ )
61
+
62
+ if sys.version_info >= (3, 9):
63
+ from builtins import type as Type
64
+ from collections.abc import Mapping
65
+ else:
66
+ from typing import Mapping, Type
67
+ if sys.version_info >= (3, 12):
68
+ from typing import Literal, Unpack
69
+ else:
70
+ from typing_extensions import Literal, Unpack
71
+
72
+
73
+ __all__ = ("RedshiftDataAPIServiceClient",)
74
+
75
+
76
+ class Exceptions(BaseClientExceptions):
77
+ ActiveSessionsExceededException: Type[BotocoreClientError]
78
+ ActiveStatementsExceededException: Type[BotocoreClientError]
79
+ BatchExecuteStatementException: Type[BotocoreClientError]
80
+ ClientError: Type[BotocoreClientError]
81
+ DatabaseConnectionException: Type[BotocoreClientError]
82
+ ExecuteStatementException: Type[BotocoreClientError]
83
+ InternalServerException: Type[BotocoreClientError]
84
+ QueryTimeoutException: Type[BotocoreClientError]
85
+ ResourceNotFoundException: Type[BotocoreClientError]
86
+ ValidationException: Type[BotocoreClientError]
87
+
88
+
89
+ class RedshiftDataAPIServiceClient(BaseClient):
90
+ """
91
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data.html#RedshiftDataAPIService.Client)
92
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/)
93
+ """
94
+
95
+ meta: ClientMeta
96
+
97
+ @property
98
+ def exceptions(self) -> Exceptions:
99
+ """
100
+ RedshiftDataAPIServiceClient exceptions.
101
+
102
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data.html#RedshiftDataAPIService.Client)
103
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#exceptions)
104
+ """
105
+
106
+ def can_paginate(self, operation_name: str) -> bool:
107
+ """
108
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/can_paginate.html)
109
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#can_paginate)
110
+ """
111
+
112
+ def generate_presigned_url(
113
+ self,
114
+ ClientMethod: str,
115
+ Params: Mapping[str, Any] = ...,
116
+ ExpiresIn: int = 3600,
117
+ HttpMethod: str = ...,
118
+ ) -> str:
119
+ """
120
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/generate_presigned_url.html)
121
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#generate_presigned_url)
122
+ """
123
+
124
+ def batch_execute_statement(
125
+ self, **kwargs: Unpack[BatchExecuteStatementInputRequestTypeDef]
126
+ ) -> BatchExecuteStatementOutputTypeDef:
127
+ """
128
+ Runs one or more SQL statements, which can be data manipulation language (DML)
129
+ or data definition language (DDL).
130
+
131
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/batch_execute_statement.html)
132
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#batch_execute_statement)
133
+ """
134
+
135
+ def cancel_statement(
136
+ self, **kwargs: Unpack[CancelStatementRequestRequestTypeDef]
137
+ ) -> CancelStatementResponseTypeDef:
138
+ """
139
+ Cancels a running query.
140
+
141
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/cancel_statement.html)
142
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#cancel_statement)
143
+ """
144
+
145
+ def describe_statement(
146
+ self, **kwargs: Unpack[DescribeStatementRequestRequestTypeDef]
147
+ ) -> DescribeStatementResponseTypeDef:
148
+ """
149
+ Describes the details about a specific instance when a query was run by the
150
+ Amazon Redshift Data API.
151
+
152
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/describe_statement.html)
153
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#describe_statement)
154
+ """
155
+
156
+ def describe_table(
157
+ self, **kwargs: Unpack[DescribeTableRequestRequestTypeDef]
158
+ ) -> DescribeTableResponseTypeDef:
159
+ """
160
+ Describes the detailed information about a table from metadata in the cluster.
161
+
162
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/describe_table.html)
163
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#describe_table)
164
+ """
165
+
166
+ def execute_statement(
167
+ self, **kwargs: Unpack[ExecuteStatementInputRequestTypeDef]
168
+ ) -> ExecuteStatementOutputTypeDef:
169
+ """
170
+ Runs an SQL statement, which can be data manipulation language (DML) or data
171
+ definition language (DDL).
172
+
173
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/execute_statement.html)
174
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#execute_statement)
175
+ """
176
+
177
+ def get_statement_result(
178
+ self, **kwargs: Unpack[GetStatementResultRequestRequestTypeDef]
179
+ ) -> GetStatementResultResponseTypeDef:
180
+ """
181
+ Fetches the temporarily cached result of an SQL statement in JSON format.
182
+
183
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/get_statement_result.html)
184
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#get_statement_result)
185
+ """
186
+
187
+ def get_statement_result_v2(
188
+ self, **kwargs: Unpack[GetStatementResultV2RequestRequestTypeDef]
189
+ ) -> GetStatementResultV2ResponseTypeDef:
190
+ """
191
+ Fetches the temporarily cached result of an SQL statement in CSV format.
192
+
193
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/get_statement_result_v2.html)
194
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#get_statement_result_v2)
195
+ """
196
+
197
+ def list_databases(
198
+ self, **kwargs: Unpack[ListDatabasesRequestRequestTypeDef]
199
+ ) -> ListDatabasesResponseTypeDef:
200
+ """
201
+ List the databases in a cluster.
202
+
203
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/list_databases.html)
204
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#list_databases)
205
+ """
206
+
207
+ def list_schemas(
208
+ self, **kwargs: Unpack[ListSchemasRequestRequestTypeDef]
209
+ ) -> ListSchemasResponseTypeDef:
210
+ """
211
+ Lists the schemas in a database.
212
+
213
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/list_schemas.html)
214
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#list_schemas)
215
+ """
216
+
217
+ def list_statements(
218
+ self, **kwargs: Unpack[ListStatementsRequestRequestTypeDef]
219
+ ) -> ListStatementsResponseTypeDef:
220
+ """
221
+ List of SQL statements.
222
+
223
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/list_statements.html)
224
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#list_statements)
225
+ """
226
+
227
+ def list_tables(
228
+ self, **kwargs: Unpack[ListTablesRequestRequestTypeDef]
229
+ ) -> ListTablesResponseTypeDef:
230
+ """
231
+ List the tables in a database.
232
+
233
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/list_tables.html)
234
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#list_tables)
235
+ """
236
+
237
+ @overload # type: ignore[override]
238
+ def get_paginator( # type: ignore[override]
239
+ self, operation_name: Literal["describe_table"]
240
+ ) -> DescribeTablePaginator:
241
+ """
242
+ Create a paginator for an operation.
243
+
244
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/get_paginator.html)
245
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#get_paginator)
246
+ """
247
+
248
+ @overload # type: ignore[override]
249
+ def get_paginator( # type: ignore[override]
250
+ self, operation_name: Literal["get_statement_result"]
251
+ ) -> GetStatementResultPaginator:
252
+ """
253
+ Create a paginator for an operation.
254
+
255
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/get_paginator.html)
256
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#get_paginator)
257
+ """
258
+
259
+ @overload # type: ignore[override]
260
+ def get_paginator( # type: ignore[override]
261
+ self, operation_name: Literal["get_statement_result_v2"]
262
+ ) -> GetStatementResultV2Paginator:
263
+ """
264
+ Create a paginator for an operation.
265
+
266
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/get_paginator.html)
267
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#get_paginator)
268
+ """
269
+
270
+ @overload # type: ignore[override]
271
+ def get_paginator( # type: ignore[override]
272
+ self, operation_name: Literal["list_databases"]
273
+ ) -> ListDatabasesPaginator:
274
+ """
275
+ Create a paginator for an operation.
276
+
277
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/get_paginator.html)
278
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#get_paginator)
279
+ """
280
+
281
+ @overload # type: ignore[override]
282
+ def get_paginator( # type: ignore[override]
283
+ self, operation_name: Literal["list_schemas"]
284
+ ) -> ListSchemasPaginator:
285
+ """
286
+ Create a paginator for an operation.
287
+
288
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/get_paginator.html)
289
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#get_paginator)
290
+ """
291
+
292
+ @overload # type: ignore[override]
293
+ def get_paginator( # type: ignore[override]
294
+ self, operation_name: Literal["list_statements"]
295
+ ) -> ListStatementsPaginator:
296
+ """
297
+ Create a paginator for an operation.
298
+
299
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/get_paginator.html)
300
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#get_paginator)
301
+ """
302
+
303
+ @overload # type: ignore[override]
304
+ def get_paginator( # type: ignore[override]
305
+ self, operation_name: Literal["list_tables"]
306
+ ) -> ListTablesPaginator:
307
+ """
308
+ Create a paginator for an operation.
309
+
310
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data/client/get_paginator.html)
311
+ [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_redshift_data/client/#get_paginator)
312
+ """