RedshiftDataAPIService module#
Index > RedshiftDataAPIService
Auto-generated documentation for RedshiftDataAPIService type annotations stubs module types-boto3-redshift-data.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3
AWS SDK. - Add
RedshiftDataAPIService
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and RedshiftDataAPIService
.
From PyPI with pip#
Install types-boto3
for RedshiftDataAPIService
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[redshift-data]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[redshift-data]'
# standalone installation
python -m pip install types-boto3-redshift-data
How to uninstall#
python -m pip uninstall -y types-boto3-redshift-data
Usage#
Code samples can be found in Examples.
RedshiftDataAPIServiceClient#
Type annotations and code completion for boto3.client("redshift-data")
as RedshiftDataAPIServiceClient
boto3 documentation
# RedshiftDataAPIServiceClient usage example
from boto3.session import Session
from types_boto3_redshift_data.client import RedshiftDataAPIServiceClient
def get_client() -> RedshiftDataAPIServiceClient:
return Session().client("redshift-data")
Paginators#
Type annotations and code completion for paginators
from boto3.client("redshift-data").get_paginator("...")
.
# DescribeTablePaginator usage example
from boto3.session import Session
from types_boto3_redshift_data.paginator import DescribeTablePaginator
def get_describe_table_paginator() -> DescribeTablePaginator:
return Session().client("redshift-data").get_paginator("describe_table"))
- DescribeTablePaginator
- GetStatementResultPaginator
- GetStatementResultV2Paginator
- ListDatabasesPaginator
- ListSchemasPaginator
- ListStatementsPaginator
- ListTablesPaginator
Literals#
Type annotations for literals used in methods and schema.
# DescribeTablePaginatorName usage example
from types_boto3_redshift_data.literals import DescribeTablePaginatorName
def get_value() -> DescribeTablePaginatorName:
return "describe_table"
- DescribeTablePaginatorName
- GetStatementResultPaginatorName
- GetStatementResultV2PaginatorName
- ListDatabasesPaginatorName
- ListSchemasPaginatorName
- ListStatementsPaginatorName
- ListTablesPaginatorName
- ResultFormatStringType
- StatementStatusStringType
- StatusStringType
- RedshiftDataAPIServiceServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- BatchExecuteStatementInputRequestTypeDef
- ResponseMetadataTypeDef
- CancelStatementRequestRequestTypeDef
- ColumnMetadataTypeDef
- DescribeStatementRequestRequestTypeDef
- SqlParameterTypeDef
- SubStatementDataTypeDef
- PaginatorConfigTypeDef
- DescribeTableRequestRequestTypeDef
- FieldTypeDef
- GetStatementResultRequestRequestTypeDef
- GetStatementResultV2RequestRequestTypeDef
- QueryRecordsTypeDef
- ListDatabasesRequestRequestTypeDef
- ListSchemasRequestRequestTypeDef
- ListStatementsRequestRequestTypeDef
- ListTablesRequestRequestTypeDef
- TableMemberTypeDef
- BatchExecuteStatementOutputTypeDef
- CancelStatementResponseTypeDef
- ExecuteStatementOutputTypeDef
- ListDatabasesResponseTypeDef
- ListSchemasResponseTypeDef
- DescribeTableResponseTypeDef
- ExecuteStatementInputRequestTypeDef
- StatementDataTypeDef
- DescribeStatementResponseTypeDef
- DescribeTableRequestPaginateTypeDef
- GetStatementResultRequestPaginateTypeDef
- GetStatementResultV2RequestPaginateTypeDef
- ListDatabasesRequestPaginateTypeDef
- ListSchemasRequestPaginateTypeDef
- ListStatementsRequestPaginateTypeDef
- ListTablesRequestPaginateTypeDef
- GetStatementResultResponseTypeDef
- GetStatementResultV2ResponseTypeDef
- ListTablesResponseTypeDef
- ListStatementsResponseTypeDef