Skip to content

RedshiftDataAPIService module#

Index > RedshiftDataAPIService

Auto-generated documentation for RedshiftDataAPIService type annotations stubs module mypy-boto3-redshift-data.

How to install#

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 boto3-stubs for RedshiftDataAPIService service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[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 'boto3-stubs-lite[redshift-data]'

# standalone installation
python -m pip install mypy-boto3-redshift-data

How to uninstall#

python -m pip uninstall -y mypy-boto3-redshift-data


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("redshift-data") as RedshiftDataAPIServiceClient boto3 documentation

# RedshiftDataAPIServiceClient usage example

from boto3.session import Session

from mypy_boto3_redshift_data.client import RedshiftDataAPIServiceClient

def get_client() -> RedshiftDataAPIServiceClient:
    return Session().client("redshift-data")


Type annotations and code completion for paginators from boto3.client("redshift-data").get_paginator("...").

# DescribeTablePaginator usage example

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import DescribeTablePaginator

def get_describe_table_paginator() -> DescribeTablePaginator:
    return Session().client("redshift-data").get_paginator("describe_table"))


Type annotations for literals used in methods and schemas.

# DescribeTablePaginatorName usage example

from mypy_boto3_redshift_data.literals import DescribeTablePaginatorName

def get_value() -> DescribeTablePaginatorName:
    return "describe_table"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# BatchExecuteStatementInputRequestTypeDef usage example

from mypy_boto3_redshift_data.type_defs import BatchExecuteStatementInputRequestTypeDef

def get_value() -> BatchExecuteStatementInputRequestTypeDef:
    return {
        "Database": ...,
        "Sqls": ...,