Skip to content

Examples

Index > Redshift > Examples

Auto-generated documentation for Redshift type annotations stubs module types-aiobotocore-redshift.

Client

Implicit type annotations

Can be used with types-aioboto3[redshift] package installed.

Write your Redshift code as usual, type checking and code completion should work out of the box.

Client usage example
from aioboto3.session import Session


session = Session()

async with session.client("redshift") as client:  # (1)
    result = await client.accept_reserved_node_exchange()  # (2)
  1. client: RedshiftClient
  2. result: AcceptReservedNodeExchangeOutputMessageTypeDef
Paginator usage example
from aioboto3.session import Session


session = Session()

async with session.client("redshift") as client:  # (1)
    paginator = client.get_paginator("describe_cluster_db_revisions")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: RedshiftClient
  2. paginator: DescribeClusterDbRevisionsPaginator
  3. item: ClusterDbRevisionsMessageTypeDef
Waiter usage example
from aioboto3.session import Session


session = Session()

async with session.client("redshift") as client:  # (1)
    waiter = client.get_waiter("cluster_available")  # (2)
    await waiter.wait()
  1. client: RedshiftClient
  2. waiter: ClusterAvailableWaiter

Explicit type annotations

With types-aioboto3-lite[redshift] or a standalone types_aiobotocore_redshift package, you have to explicitly specify client: RedshiftClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client usage example
from aioboto3.session import Session

from types_aiobotocore_redshift.client import RedshiftClient
from types_aiobotocore_redshift.type_defs import AcceptReservedNodeExchangeOutputMessageTypeDef
from types_aiobotocore_redshift.type_defs import AcceptReservedNodeExchangeInputMessageRequestTypeDef


session = Session()

client: RedshiftClient
async with session.client("redshift") as client:  # (1)
    kwargs: AcceptReservedNodeExchangeInputMessageRequestTypeDef = {...}  # (2)
    result: AcceptReservedNodeExchangeOutputMessageTypeDef = await client.accept_reserved_node_exchange(**kwargs)  # (3)
  1. client: RedshiftClient
  2. kwargs: AcceptReservedNodeExchangeInputMessageRequestTypeDef
  3. result: AcceptReservedNodeExchangeOutputMessageTypeDef
Paginator usage example
from aioboto3.session import Session

from types_aiobotocore_redshift.client import RedshiftClient
from types_aiobotocore_redshift.paginator import DescribeClusterDbRevisionsPaginator
from types_aiobotocore_redshift.type_defs import ClusterDbRevisionsMessageTypeDef


session = Session()

client: RedshiftClient
async with session.client("redshift") as client:  # (1)
    paginator: DescribeClusterDbRevisionsPaginator = client.get_paginator("describe_cluster_db_revisions")  # (2)
    async for item in paginator.paginate(...):
        item: ClusterDbRevisionsMessageTypeDef
        print(item)  # (3)
  1. client: RedshiftClient
  2. paginator: DescribeClusterDbRevisionsPaginator
  3. item: ClusterDbRevisionsMessageTypeDef
Waiter usage example
from aioboto3.session import Session

from types_aiobotocore_redshift.client import RedshiftClient
from types_aiobotocore_redshift.waiter import ClusterAvailableWaiter


session = Session()

async with session.client("redshift") as client:  # (1)
    waiter = client.get_waiter("cluster_available")  # (2)
    await waiter.wait()
  1. client: RedshiftClient
  2. waiter: ClusterAvailableWaiter