Typed dictionaries#
Index > RedshiftDataAPIService > Typed dictionaries
Auto-generated documentation for RedshiftDataAPIService type annotations stubs module mypy-boto3-redshift-data.
BatchExecuteStatementInputRequestTypeDef#
# BatchExecuteStatementInputRequestTypeDef usage example
from mypy_boto3_redshift_data.type_defs import BatchExecuteStatementInputRequestTypeDef
def get_value() -> BatchExecuteStatementInputRequestTypeDef:
return {
"Database": ...,
"Sqls": ...,
}
# 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],
BatchExecuteStatementOutputTypeDef#
# 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": ...,
}
# BatchExecuteStatementOutputTypeDef definition
class BatchExecuteStatementOutputTypeDef(TypedDict):
ClusterIdentifier: str,
CreatedAt: datetime,
Database: str,
DbUser: str,
Id: str,
SecretArn: str,
WorkgroupName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CancelStatementRequestRequestTypeDef#
# CancelStatementRequestRequestTypeDef usage example
from mypy_boto3_redshift_data.type_defs import CancelStatementRequestRequestTypeDef
def get_value() -> CancelStatementRequestRequestTypeDef:
return {
"Id": ...,
}
# CancelStatementRequestRequestTypeDef definition
class CancelStatementRequestRequestTypeDef(TypedDict):
Id: str,
CancelStatementResponseTypeDef#
# CancelStatementResponseTypeDef usage example
from mypy_boto3_redshift_data.type_defs import CancelStatementResponseTypeDef
def get_value() -> CancelStatementResponseTypeDef:
return {
"Status": ...,
"ResponseMetadata": ...,
}
# CancelStatementResponseTypeDef definition
class CancelStatementResponseTypeDef(TypedDict):
Status: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ColumnMetadataTypeDef#
# ColumnMetadataTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ColumnMetadataTypeDef
def get_value() -> ColumnMetadataTypeDef:
return {
"columnDefault": ...,
}
# 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 usage example
from mypy_boto3_redshift_data.type_defs import DescribeStatementRequestRequestTypeDef
def get_value() -> DescribeStatementRequestRequestTypeDef:
return {
"Id": ...,
}
# DescribeStatementRequestRequestTypeDef definition
class DescribeStatementRequestRequestTypeDef(TypedDict):
Id: str,
SqlParameterTypeDef#
# SqlParameterTypeDef usage example
from mypy_boto3_redshift_data.type_defs import SqlParameterTypeDef
def get_value() -> SqlParameterTypeDef:
return {
"name": ...,
"value": ...,
}
# SqlParameterTypeDef definition
class SqlParameterTypeDef(TypedDict):
name: str,
value: str,
SubStatementDataTypeDef#
# SubStatementDataTypeDef usage example
from mypy_boto3_redshift_data.type_defs import SubStatementDataTypeDef
def get_value() -> SubStatementDataTypeDef:
return {
"Id": ...,
}
# 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],
DescribeTableRequestDescribeTablePaginateTypeDef#
# DescribeTableRequestDescribeTablePaginateTypeDef usage example
from mypy_boto3_redshift_data.type_defs import DescribeTableRequestDescribeTablePaginateTypeDef
def get_value() -> DescribeTableRequestDescribeTablePaginateTypeDef:
return {
"Database": ...,
}
# 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)
DescribeTableRequestRequestTypeDef#
# DescribeTableRequestRequestTypeDef usage example
from mypy_boto3_redshift_data.type_defs import DescribeTableRequestRequestTypeDef
def get_value() -> DescribeTableRequestRequestTypeDef:
return {
"Database": ...,
}
# 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],
ExecuteStatementOutputTypeDef#
# 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": ...,
}
# ExecuteStatementOutputTypeDef definition
class ExecuteStatementOutputTypeDef(TypedDict):
ClusterIdentifier: str,
CreatedAt: datetime,
Database: str,
DbUser: str,
Id: str,
SecretArn: str,
WorkgroupName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
FieldTypeDef#
# FieldTypeDef usage example
from mypy_boto3_redshift_data.type_defs import FieldTypeDef
def get_value() -> FieldTypeDef:
return {
"blobValue": ...,
}
# FieldTypeDef definition
class FieldTypeDef(TypedDict):
blobValue: NotRequired[bytes],
booleanValue: NotRequired[bool],
doubleValue: NotRequired[float],
isNull: NotRequired[bool],
longValue: NotRequired[int],
stringValue: NotRequired[str],
GetStatementResultRequestGetStatementResultPaginateTypeDef#
# GetStatementResultRequestGetStatementResultPaginateTypeDef usage example
from mypy_boto3_redshift_data.type_defs import GetStatementResultRequestGetStatementResultPaginateTypeDef
def get_value() -> GetStatementResultRequestGetStatementResultPaginateTypeDef:
return {
"Id": ...,
}
# GetStatementResultRequestGetStatementResultPaginateTypeDef definition
class GetStatementResultRequestGetStatementResultPaginateTypeDef(TypedDict):
Id: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetStatementResultRequestRequestTypeDef#
# GetStatementResultRequestRequestTypeDef usage example
from mypy_boto3_redshift_data.type_defs import GetStatementResultRequestRequestTypeDef
def get_value() -> GetStatementResultRequestRequestTypeDef:
return {
"Id": ...,
}
# GetStatementResultRequestRequestTypeDef definition
class GetStatementResultRequestRequestTypeDef(TypedDict):
Id: str,
NextToken: NotRequired[str],
ListDatabasesRequestListDatabasesPaginateTypeDef#
# ListDatabasesRequestListDatabasesPaginateTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListDatabasesRequestListDatabasesPaginateTypeDef
def get_value() -> ListDatabasesRequestListDatabasesPaginateTypeDef:
return {
"Database": ...,
}
# ListDatabasesRequestListDatabasesPaginateTypeDef definition
class ListDatabasesRequestListDatabasesPaginateTypeDef(TypedDict):
Database: str,
ClusterIdentifier: NotRequired[str],
DbUser: NotRequired[str],
SecretArn: NotRequired[str],
WorkgroupName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDatabasesRequestRequestTypeDef#
# ListDatabasesRequestRequestTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListDatabasesRequestRequestTypeDef
def get_value() -> ListDatabasesRequestRequestTypeDef:
return {
"Database": ...,
}
# 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],
ListDatabasesResponseTypeDef#
# ListDatabasesResponseTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListDatabasesResponseTypeDef
def get_value() -> ListDatabasesResponseTypeDef:
return {
"Databases": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListDatabasesResponseTypeDef definition
class ListDatabasesResponseTypeDef(TypedDict):
Databases: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListSchemasRequestListSchemasPaginateTypeDef#
# ListSchemasRequestListSchemasPaginateTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListSchemasRequestListSchemasPaginateTypeDef
def get_value() -> ListSchemasRequestListSchemasPaginateTypeDef:
return {
"Database": ...,
}
# 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)
ListSchemasRequestRequestTypeDef#
# ListSchemasRequestRequestTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListSchemasRequestRequestTypeDef
def get_value() -> ListSchemasRequestRequestTypeDef:
return {
"Database": ...,
}
# 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],
ListSchemasResponseTypeDef#
# ListSchemasResponseTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListSchemasResponseTypeDef
def get_value() -> ListSchemasResponseTypeDef:
return {
"NextToken": ...,
"Schemas": ...,
"ResponseMetadata": ...,
}
# ListSchemasResponseTypeDef definition
class ListSchemasResponseTypeDef(TypedDict):
NextToken: str,
Schemas: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListStatementsRequestListStatementsPaginateTypeDef#
# ListStatementsRequestListStatementsPaginateTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListStatementsRequestListStatementsPaginateTypeDef
def get_value() -> ListStatementsRequestListStatementsPaginateTypeDef:
return {
"RoleLevel": ...,
}
# ListStatementsRequestListStatementsPaginateTypeDef definition
class ListStatementsRequestListStatementsPaginateTypeDef(TypedDict):
RoleLevel: NotRequired[bool],
StatementName: NotRequired[str],
Status: NotRequired[StatusStringType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListStatementsRequestRequestTypeDef#
# ListStatementsRequestRequestTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListStatementsRequestRequestTypeDef
def get_value() -> ListStatementsRequestRequestTypeDef:
return {
"MaxResults": ...,
}
# ListStatementsRequestRequestTypeDef definition
class ListStatementsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
RoleLevel: NotRequired[bool],
StatementName: NotRequired[str],
Status: NotRequired[StatusStringType], # (1)
- See StatusStringType
ListTablesRequestListTablesPaginateTypeDef#
# ListTablesRequestListTablesPaginateTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListTablesRequestListTablesPaginateTypeDef
def get_value() -> ListTablesRequestListTablesPaginateTypeDef:
return {
"Database": ...,
}
# 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)
ListTablesRequestRequestTypeDef#
# ListTablesRequestRequestTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListTablesRequestRequestTypeDef
def get_value() -> ListTablesRequestRequestTypeDef:
return {
"Database": ...,
}
# 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 usage example
from mypy_boto3_redshift_data.type_defs import TableMemberTypeDef
def get_value() -> TableMemberTypeDef:
return {
"name": ...,
}
# TableMemberTypeDef definition
class TableMemberTypeDef(TypedDict):
name: NotRequired[str],
schema: NotRequired[str],
type: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_redshift_data.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
DescribeTableResponseTypeDef#
# DescribeTableResponseTypeDef usage example
from mypy_boto3_redshift_data.type_defs import DescribeTableResponseTypeDef
def get_value() -> DescribeTableResponseTypeDef:
return {
"ColumnList": ...,
"NextToken": ...,
"TableName": ...,
"ResponseMetadata": ...,
}
# DescribeTableResponseTypeDef definition
class DescribeTableResponseTypeDef(TypedDict):
ColumnList: List[ColumnMetadataTypeDef], # (1)
NextToken: str,
TableName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ExecuteStatementInputRequestTypeDef#
# ExecuteStatementInputRequestTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ExecuteStatementInputRequestTypeDef
def get_value() -> ExecuteStatementInputRequestTypeDef:
return {
"Database": ...,
"Sql": ...,
}
# 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],
StatementDataTypeDef#
# StatementDataTypeDef usage example
from mypy_boto3_redshift_data.type_defs import StatementDataTypeDef
def get_value() -> StatementDataTypeDef:
return {
"Id": ...,
}
# 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],
- See SqlParameterTypeDef
- See StatusStringType
DescribeStatementResponseTypeDef#
# 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": ...,
}
# 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)
- See SqlParameterTypeDef
- See StatusStringType
- See SubStatementDataTypeDef
- See ResponseMetadataTypeDef
GetStatementResultResponseTypeDef#
# GetStatementResultResponseTypeDef usage example
from mypy_boto3_redshift_data.type_defs import GetStatementResultResponseTypeDef
def get_value() -> GetStatementResultResponseTypeDef:
return {
"ColumnMetadata": ...,
"NextToken": ...,
"Records": ...,
"TotalNumRows": ...,
"ResponseMetadata": ...,
}
# GetStatementResultResponseTypeDef definition
class GetStatementResultResponseTypeDef(TypedDict):
ColumnMetadata: List[ColumnMetadataTypeDef], # (1)
NextToken: str,
Records: List[List[FieldTypeDef]], # (2)
TotalNumRows: int,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ColumnMetadataTypeDef
- See FieldTypeDef
- See ResponseMetadataTypeDef
ListTablesResponseTypeDef#
# ListTablesResponseTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListTablesResponseTypeDef
def get_value() -> ListTablesResponseTypeDef:
return {
"NextToken": ...,
"Tables": ...,
"ResponseMetadata": ...,
}
# ListTablesResponseTypeDef definition
class ListTablesResponseTypeDef(TypedDict):
NextToken: str,
Tables: List[TableMemberTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStatementsResponseTypeDef#
# ListStatementsResponseTypeDef usage example
from mypy_boto3_redshift_data.type_defs import ListStatementsResponseTypeDef
def get_value() -> ListStatementsResponseTypeDef:
return {
"NextToken": ...,
"Statements": ...,
"ResponseMetadata": ...,
}
# ListStatementsResponseTypeDef definition
class ListStatementsResponseTypeDef(TypedDict):
NextToken: str,
Statements: List[StatementDataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)