Skip to content

Type definitions#

Index > RedshiftDataAPIService > Type definitions

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

BatchExecuteStatementInputRequestTypeDef#

# BatchExecuteStatementInputRequestTypeDef definition

class BatchExecuteStatementInputRequestTypeDef(TypedDict):
    Database: str,
    Sqls: Sequence[str],
    ClientToken: NotRequired[str],
    ClusterIdentifier: NotRequired[str],
    DbUser: NotRequired[str],
    SecretArn: NotRequired[str],
    StatementName: NotRequired[str],
    WithEvent: NotRequired[bool],
    WorkgroupName: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CancelStatementRequestRequestTypeDef#

# CancelStatementRequestRequestTypeDef definition

class CancelStatementRequestRequestTypeDef(TypedDict):
    Id: str,

ColumnMetadataTypeDef#

# ColumnMetadataTypeDef 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#

# DescribeStatementRequestRequestTypeDef definition

class DescribeStatementRequestRequestTypeDef(TypedDict):
    Id: str,

SqlParameterTypeDef#

# SqlParameterTypeDef definition

class SqlParameterTypeDef(TypedDict):
    name: str,
    value: str,

SubStatementDataTypeDef#

# SubStatementDataTypeDef 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#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeTableRequestRequestTypeDef#

# DescribeTableRequestRequestTypeDef 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#

# FieldTypeDef definition

class FieldTypeDef(TypedDict):
    blobValue: NotRequired[bytes],
    booleanValue: NotRequired[bool],
    doubleValue: NotRequired[float],
    isNull: NotRequired[bool],
    longValue: NotRequired[int],
    stringValue: NotRequired[str],

GetStatementResultRequestRequestTypeDef#

# GetStatementResultRequestRequestTypeDef definition

class GetStatementResultRequestRequestTypeDef(TypedDict):
    Id: str,
    NextToken: NotRequired[str],

ListDatabasesRequestRequestTypeDef#

# ListDatabasesRequestRequestTypeDef 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#

# ListSchemasRequestRequestTypeDef 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#

# ListStatementsRequestRequestTypeDef definition

class ListStatementsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    RoleLevel: NotRequired[bool],
    StatementName: NotRequired[str],
    Status: NotRequired[StatusStringType],  # (1)
  1. See StatusStringType

ListTablesRequestRequestTypeDef#

# ListTablesRequestRequestTypeDef 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#

# TableMemberTypeDef definition

class TableMemberTypeDef(TypedDict):
    name: NotRequired[str],
    schema: NotRequired[str],
    type: NotRequired[str],

BatchExecuteStatementOutputTypeDef#

# BatchExecuteStatementOutputTypeDef 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#

# CancelStatementResponseTypeDef definition

class CancelStatementResponseTypeDef(TypedDict):
    Status: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExecuteStatementOutputTypeDef#

# ExecuteStatementOutputTypeDef 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#

# ListDatabasesResponseTypeDef definition

class ListDatabasesResponseTypeDef(TypedDict):
    Databases: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListSchemasResponseTypeDef#

# ListSchemasResponseTypeDef definition

class ListSchemasResponseTypeDef(TypedDict):
    NextToken: str,
    Schemas: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeTableResponseTypeDef#

# DescribeTableResponseTypeDef definition

class DescribeTableResponseTypeDef(TypedDict):
    ColumnList: List[ColumnMetadataTypeDef],  # (1)
    NextToken: str,
    TableName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ColumnMetadataTypeDef
  2. See ResponseMetadataTypeDef

ExecuteStatementInputRequestTypeDef#

# ExecuteStatementInputRequestTypeDef definition

class ExecuteStatementInputRequestTypeDef(TypedDict):
    Database: str,
    Sql: str,
    ClientToken: NotRequired[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#

# StatementDataTypeDef 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#

# DescribeStatementResponseTypeDef 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#

# DescribeTableRequestDescribeTablePaginateTypeDef 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#

# GetStatementResultRequestGetStatementResultPaginateTypeDef definition

class GetStatementResultRequestGetStatementResultPaginateTypeDef(TypedDict):
    Id: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDatabasesRequestListDatabasesPaginateTypeDef#

# ListDatabasesRequestListDatabasesPaginateTypeDef 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#

# ListSchemasRequestListSchemasPaginateTypeDef 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#

# ListStatementsRequestListStatementsPaginateTypeDef 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#

# ListTablesRequestListTablesPaginateTypeDef 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#

# GetStatementResultResponseTypeDef 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#

# ListTablesResponseTypeDef definition

class ListTablesResponseTypeDef(TypedDict):
    NextToken: str,
    Tables: List[TableMemberTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TableMemberTypeDef
  2. See ResponseMetadataTypeDef

ListStatementsResponseTypeDef#

# ListStatementsResponseTypeDef definition

class ListStatementsResponseTypeDef(TypedDict):
    NextToken: str,
    Statements: List[StatementDataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StatementDataTypeDef
  2. See ResponseMetadataTypeDef