Skip to content

Typed dictionaries

Index > RedshiftDataAPIService > Typed dictionaries

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

BatchExecuteStatementInputRequestTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import BatchExecuteStatementInputRequestTypeDef

def get_value() -> BatchExecuteStatementInputRequestTypeDef:
    return {
        "Database": ...,
        "Sqls": ...,
    }
Definition
class BatchExecuteStatementInputRequestTypeDef(TypedDict):
    Database: str,
    Sqls: Sequence[str],
    ClusterIdentifier: NotRequired[str],
    DbUser: NotRequired[str],
    SecretArn: NotRequired[str],
    StatementName: NotRequired[str],
    WithEvent: NotRequired[bool],
    WorkgroupName: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CancelStatementRequestRequestTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import CancelStatementRequestRequestTypeDef

def get_value() -> CancelStatementRequestRequestTypeDef:
    return {
        "Id": ...,
    }
Definition
class CancelStatementRequestRequestTypeDef(TypedDict):
    Id: str,

ColumnMetadataTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ColumnMetadataTypeDef

def get_value() -> ColumnMetadataTypeDef:
    return {
        "columnDefault": ...,
    }
Definition
class ColumnMetadataTypeDef(TypedDict):
    columnDefault: NotRequired[str],
    isCaseSensitive: NotRequired[bool],
    isCurrency: NotRequired[bool],
    isSigned: NotRequired[bool],
    label: NotRequired[str],
    length: NotRequired[int],
    name: NotRequired[str],
    nullable: NotRequired[int],
    precision: NotRequired[int],
    scale: NotRequired[int],
    schemaName: NotRequired[str],
    tableName: NotRequired[str],
    typeName: NotRequired[str],

DescribeStatementRequestRequestTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import DescribeStatementRequestRequestTypeDef

def get_value() -> DescribeStatementRequestRequestTypeDef:
    return {
        "Id": ...,
    }
Definition
class DescribeStatementRequestRequestTypeDef(TypedDict):
    Id: str,

SqlParameterTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import SqlParameterTypeDef

def get_value() -> SqlParameterTypeDef:
    return {
        "name": ...,
        "value": ...,
    }
Definition
class SqlParameterTypeDef(TypedDict):
    name: str,
    value: str,

SubStatementDataTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import SubStatementDataTypeDef

def get_value() -> SubStatementDataTypeDef:
    return {
        "Id": ...,
    }
Definition
class SubStatementDataTypeDef(TypedDict):
    Id: str,
    CreatedAt: NotRequired[datetime],
    Duration: NotRequired[int],
    Error: NotRequired[str],
    HasResultSet: NotRequired[bool],
    QueryString: NotRequired[str],
    RedshiftQueryId: NotRequired[int],
    ResultRows: NotRequired[int],
    ResultSize: NotRequired[int],
    Status: NotRequired[StatementStatusStringType],  # (1)
    UpdatedAt: NotRequired[datetime],
  1. See StatementStatusStringType

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeTableRequestRequestTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import DescribeTableRequestRequestTypeDef

def get_value() -> DescribeTableRequestRequestTypeDef:
    return {
        "Database": ...,
    }
Definition
class DescribeTableRequestRequestTypeDef(TypedDict):
    Database: str,
    ClusterIdentifier: NotRequired[str],
    ConnectedDatabase: NotRequired[str],
    DbUser: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Schema: NotRequired[str],
    SecretArn: NotRequired[str],
    Table: NotRequired[str],
    WorkgroupName: NotRequired[str],

FieldTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import FieldTypeDef

def get_value() -> FieldTypeDef:
    return {
        "blobValue": ...,
    }
Definition
class FieldTypeDef(TypedDict):
    blobValue: NotRequired[bytes],
    booleanValue: NotRequired[bool],
    doubleValue: NotRequired[float],
    isNull: NotRequired[bool],
    longValue: NotRequired[int],
    stringValue: NotRequired[str],

GetStatementResultRequestRequestTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import GetStatementResultRequestRequestTypeDef

def get_value() -> GetStatementResultRequestRequestTypeDef:
    return {
        "Id": ...,
    }
Definition
class GetStatementResultRequestRequestTypeDef(TypedDict):
    Id: str,
    NextToken: NotRequired[str],

ListDatabasesRequestRequestTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListDatabasesRequestRequestTypeDef

def get_value() -> ListDatabasesRequestRequestTypeDef:
    return {
        "Database": ...,
    }
Definition
class ListDatabasesRequestRequestTypeDef(TypedDict):
    Database: str,
    ClusterIdentifier: NotRequired[str],
    DbUser: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    SecretArn: NotRequired[str],
    WorkgroupName: NotRequired[str],

ListSchemasRequestRequestTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListSchemasRequestRequestTypeDef

def get_value() -> ListSchemasRequestRequestTypeDef:
    return {
        "Database": ...,
    }
Definition
class ListSchemasRequestRequestTypeDef(TypedDict):
    Database: str,
    ClusterIdentifier: NotRequired[str],
    ConnectedDatabase: NotRequired[str],
    DbUser: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    SchemaPattern: NotRequired[str],
    SecretArn: NotRequired[str],
    WorkgroupName: NotRequired[str],

ListStatementsRequestRequestTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListStatementsRequestRequestTypeDef

def get_value() -> ListStatementsRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }
Definition
class ListStatementsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    RoleLevel: NotRequired[bool],
    StatementName: NotRequired[str],
    Status: NotRequired[StatusStringType],  # (1)
  1. See StatusStringType

ListTablesRequestRequestTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListTablesRequestRequestTypeDef

def get_value() -> ListTablesRequestRequestTypeDef:
    return {
        "Database": ...,
    }
Definition
class ListTablesRequestRequestTypeDef(TypedDict):
    Database: str,
    ClusterIdentifier: NotRequired[str],
    ConnectedDatabase: NotRequired[str],
    DbUser: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    SchemaPattern: NotRequired[str],
    SecretArn: NotRequired[str],
    TablePattern: NotRequired[str],
    WorkgroupName: NotRequired[str],

TableMemberTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import TableMemberTypeDef

def get_value() -> TableMemberTypeDef:
    return {
        "name": ...,
    }
Definition
class TableMemberTypeDef(TypedDict):
    name: NotRequired[str],
    schema: NotRequired[str],
    type: NotRequired[str],

BatchExecuteStatementOutputTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import BatchExecuteStatementOutputTypeDef

def get_value() -> BatchExecuteStatementOutputTypeDef:
    return {
        "ClusterIdentifier": ...,
        "CreatedAt": ...,
        "Database": ...,
        "DbUser": ...,
        "Id": ...,
        "SecretArn": ...,
        "WorkgroupName": ...,
        "ResponseMetadata": ...,
    }
Definition
class BatchExecuteStatementOutputTypeDef(TypedDict):
    ClusterIdentifier: str,
    CreatedAt: datetime,
    Database: str,
    DbUser: str,
    Id: str,
    SecretArn: str,
    WorkgroupName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CancelStatementResponseTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import CancelStatementResponseTypeDef

def get_value() -> CancelStatementResponseTypeDef:
    return {
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class CancelStatementResponseTypeDef(TypedDict):
    Status: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExecuteStatementOutputTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ExecuteStatementOutputTypeDef

def get_value() -> ExecuteStatementOutputTypeDef:
    return {
        "ClusterIdentifier": ...,
        "CreatedAt": ...,
        "Database": ...,
        "DbUser": ...,
        "Id": ...,
        "SecretArn": ...,
        "WorkgroupName": ...,
        "ResponseMetadata": ...,
    }
Definition
class ExecuteStatementOutputTypeDef(TypedDict):
    ClusterIdentifier: str,
    CreatedAt: datetime,
    Database: str,
    DbUser: str,
    Id: str,
    SecretArn: str,
    WorkgroupName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDatabasesResponseTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListDatabasesResponseTypeDef

def get_value() -> ListDatabasesResponseTypeDef:
    return {
        "Databases": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListDatabasesResponseTypeDef(TypedDict):
    Databases: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListSchemasResponseTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListSchemasResponseTypeDef

def get_value() -> ListSchemasResponseTypeDef:
    return {
        "NextToken": ...,
        "Schemas": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListSchemasResponseTypeDef(TypedDict):
    NextToken: str,
    Schemas: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeTableResponseTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import DescribeTableResponseTypeDef

def get_value() -> DescribeTableResponseTypeDef:
    return {
        "ColumnList": ...,
        "NextToken": ...,
        "TableName": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeTableResponseTypeDef(TypedDict):
    ColumnList: List[ColumnMetadataTypeDef],  # (1)
    NextToken: str,
    TableName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ColumnMetadataTypeDef
  2. See ResponseMetadataTypeDef

ExecuteStatementInputRequestTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ExecuteStatementInputRequestTypeDef

def get_value() -> ExecuteStatementInputRequestTypeDef:
    return {
        "Database": ...,
        "Sql": ...,
    }
Definition
class ExecuteStatementInputRequestTypeDef(TypedDict):
    Database: str,
    Sql: str,
    ClusterIdentifier: NotRequired[str],
    DbUser: NotRequired[str],
    Parameters: NotRequired[Sequence[SqlParameterTypeDef]],  # (1)
    SecretArn: NotRequired[str],
    StatementName: NotRequired[str],
    WithEvent: NotRequired[bool],
    WorkgroupName: NotRequired[str],
  1. See SqlParameterTypeDef

StatementDataTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import StatementDataTypeDef

def get_value() -> StatementDataTypeDef:
    return {
        "Id": ...,
    }
Definition
class StatementDataTypeDef(TypedDict):
    Id: str,
    CreatedAt: NotRequired[datetime],
    IsBatchStatement: NotRequired[bool],
    QueryParameters: NotRequired[List[SqlParameterTypeDef]],  # (1)
    QueryString: NotRequired[str],
    QueryStrings: NotRequired[List[str]],
    SecretArn: NotRequired[str],
    StatementName: NotRequired[str],
    Status: NotRequired[StatusStringType],  # (2)
    UpdatedAt: NotRequired[datetime],
  1. See SqlParameterTypeDef
  2. See StatusStringType

DescribeStatementResponseTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import DescribeStatementResponseTypeDef

def get_value() -> DescribeStatementResponseTypeDef:
    return {
        "ClusterIdentifier": ...,
        "CreatedAt": ...,
        "Database": ...,
        "DbUser": ...,
        "Duration": ...,
        "Error": ...,
        "HasResultSet": ...,
        "Id": ...,
        "QueryParameters": ...,
        "QueryString": ...,
        "RedshiftPid": ...,
        "RedshiftQueryId": ...,
        "ResultRows": ...,
        "ResultSize": ...,
        "SecretArn": ...,
        "Status": ...,
        "SubStatements": ...,
        "UpdatedAt": ...,
        "WorkgroupName": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeStatementResponseTypeDef(TypedDict):
    ClusterIdentifier: str,
    CreatedAt: datetime,
    Database: str,
    DbUser: str,
    Duration: int,
    Error: str,
    HasResultSet: bool,
    Id: str,
    QueryParameters: List[SqlParameterTypeDef],  # (1)
    QueryString: str,
    RedshiftPid: int,
    RedshiftQueryId: int,
    ResultRows: int,
    ResultSize: int,
    SecretArn: str,
    Status: StatusStringType,  # (2)
    SubStatements: List[SubStatementDataTypeDef],  # (3)
    UpdatedAt: datetime,
    WorkgroupName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See SqlParameterTypeDef
  2. See StatusStringType
  3. See SubStatementDataTypeDef
  4. See ResponseMetadataTypeDef

DescribeTableRequestDescribeTablePaginateTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import DescribeTableRequestDescribeTablePaginateTypeDef

def get_value() -> DescribeTableRequestDescribeTablePaginateTypeDef:
    return {
        "Database": ...,
    }
Definition
class DescribeTableRequestDescribeTablePaginateTypeDef(TypedDict):
    Database: str,
    ClusterIdentifier: NotRequired[str],
    ConnectedDatabase: NotRequired[str],
    DbUser: NotRequired[str],
    Schema: NotRequired[str],
    SecretArn: NotRequired[str],
    Table: NotRequired[str],
    WorkgroupName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetStatementResultRequestGetStatementResultPaginateTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import GetStatementResultRequestGetStatementResultPaginateTypeDef

def get_value() -> GetStatementResultRequestGetStatementResultPaginateTypeDef:
    return {
        "Id": ...,
    }
Definition
class GetStatementResultRequestGetStatementResultPaginateTypeDef(TypedDict):
    Id: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDatabasesRequestListDatabasesPaginateTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListDatabasesRequestListDatabasesPaginateTypeDef

def get_value() -> ListDatabasesRequestListDatabasesPaginateTypeDef:
    return {
        "Database": ...,
    }
Definition
class ListDatabasesRequestListDatabasesPaginateTypeDef(TypedDict):
    Database: str,
    ClusterIdentifier: NotRequired[str],
    DbUser: NotRequired[str],
    SecretArn: NotRequired[str],
    WorkgroupName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSchemasRequestListSchemasPaginateTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListSchemasRequestListSchemasPaginateTypeDef

def get_value() -> ListSchemasRequestListSchemasPaginateTypeDef:
    return {
        "Database": ...,
    }
Definition
class ListSchemasRequestListSchemasPaginateTypeDef(TypedDict):
    Database: str,
    ClusterIdentifier: NotRequired[str],
    ConnectedDatabase: NotRequired[str],
    DbUser: NotRequired[str],
    SchemaPattern: NotRequired[str],
    SecretArn: NotRequired[str],
    WorkgroupName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStatementsRequestListStatementsPaginateTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListStatementsRequestListStatementsPaginateTypeDef

def get_value() -> ListStatementsRequestListStatementsPaginateTypeDef:
    return {
        "RoleLevel": ...,
    }
Definition
class ListStatementsRequestListStatementsPaginateTypeDef(TypedDict):
    RoleLevel: NotRequired[bool],
    StatementName: NotRequired[str],
    Status: NotRequired[StatusStringType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See StatusStringType
  2. See PaginatorConfigTypeDef

ListTablesRequestListTablesPaginateTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListTablesRequestListTablesPaginateTypeDef

def get_value() -> ListTablesRequestListTablesPaginateTypeDef:
    return {
        "Database": ...,
    }
Definition
class ListTablesRequestListTablesPaginateTypeDef(TypedDict):
    Database: str,
    ClusterIdentifier: NotRequired[str],
    ConnectedDatabase: NotRequired[str],
    DbUser: NotRequired[str],
    SchemaPattern: NotRequired[str],
    SecretArn: NotRequired[str],
    TablePattern: NotRequired[str],
    WorkgroupName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetStatementResultResponseTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import GetStatementResultResponseTypeDef

def get_value() -> GetStatementResultResponseTypeDef:
    return {
        "ColumnMetadata": ...,
        "NextToken": ...,
        "Records": ...,
        "TotalNumRows": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetStatementResultResponseTypeDef(TypedDict):
    ColumnMetadata: List[ColumnMetadataTypeDef],  # (1)
    NextToken: str,
    Records: List[List[FieldTypeDef]],  # (2)
    TotalNumRows: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ColumnMetadataTypeDef
  2. See FieldTypeDef
  3. See ResponseMetadataTypeDef

ListTablesResponseTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListTablesResponseTypeDef

def get_value() -> ListTablesResponseTypeDef:
    return {
        "NextToken": ...,
        "Tables": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTablesResponseTypeDef(TypedDict):
    NextToken: str,
    Tables: List[TableMemberTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TableMemberTypeDef
  2. See ResponseMetadataTypeDef

ListStatementsResponseTypeDef

Usage Example
from mypy_boto3_redshift_data.type_defs import ListStatementsResponseTypeDef

def get_value() -> ListStatementsResponseTypeDef:
    return {
        "NextToken": ...,
        "Statements": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListStatementsResponseTypeDef(TypedDict):
    NextToken: str,
    Statements: List[StatementDataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StatementDataTypeDef
  2. See ResponseMetadataTypeDef