Type definitions#
Auto-generated documentation for Honeycode type annotations stubs module mypy-boto3-honeycode.
FailedBatchItemTypeDef#
# FailedBatchItemTypeDef definition
class FailedBatchItemTypeDef(TypedDict):
id: str,
errorMessage: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
BatchDeleteTableRowsRequestRequestTypeDef#
# BatchDeleteTableRowsRequestRequestTypeDef definition
class BatchDeleteTableRowsRequestRequestTypeDef(TypedDict):
workbookId: str,
tableId: str,
rowIds: Sequence[str],
clientRequestToken: NotRequired[str],
UpsertRowsResultTypeDef#
# UpsertRowsResultTypeDef definition
class UpsertRowsResultTypeDef(TypedDict):
rowIds: List[str],
upsertAction: UpsertActionType, # (1)
- See UpsertActionType
CellInputTypeDef#
# CellInputTypeDef definition
class CellInputTypeDef(TypedDict):
fact: NotRequired[str],
facts: NotRequired[Sequence[str]],
CellTypeDef#
# CellTypeDef definition
class CellTypeDef(TypedDict):
formula: NotRequired[str],
format: NotRequired[FormatType], # (1)
rawValue: NotRequired[str],
formattedValue: NotRequired[str],
formattedValues: NotRequired[List[str]],
- See FormatType
ColumnMetadataTypeDef#
# ColumnMetadataTypeDef definition
class ColumnMetadataTypeDef(TypedDict):
name: str,
format: FormatType, # (1)
- See FormatType
DataItemTypeDef#
# DataItemTypeDef definition
class DataItemTypeDef(TypedDict):
overrideFormat: NotRequired[FormatType], # (1)
rawValue: NotRequired[str],
formattedValue: NotRequired[str],
- See FormatType
DelimitedTextImportOptionsTypeDef#
# DelimitedTextImportOptionsTypeDef definition
class DelimitedTextImportOptionsTypeDef(TypedDict):
delimiter: str,
hasHeaderRow: NotRequired[bool],
ignoreEmptyRows: NotRequired[bool],
dataCharacterEncoding: NotRequired[ImportDataCharacterEncodingType], # (1)
DescribeTableDataImportJobRequestRequestTypeDef#
# DescribeTableDataImportJobRequestRequestTypeDef definition
class DescribeTableDataImportJobRequestRequestTypeDef(TypedDict):
workbookId: str,
tableId: str,
jobId: str,
SourceDataColumnPropertiesTypeDef#
# SourceDataColumnPropertiesTypeDef definition
class SourceDataColumnPropertiesTypeDef(TypedDict):
columnIndex: NotRequired[int],
FilterTypeDef#
# FilterTypeDef definition
class FilterTypeDef(TypedDict):
formula: str,
contextRowId: NotRequired[str],
VariableValueTypeDef#
# VariableValueTypeDef definition
class VariableValueTypeDef(TypedDict):
rawValue: str,
ImportDataSourceConfigTypeDef#
# ImportDataSourceConfigTypeDef definition
class ImportDataSourceConfigTypeDef(TypedDict):
dataSourceUrl: NotRequired[str],
ImportJobSubmitterTypeDef#
# ImportJobSubmitterTypeDef definition
class ImportJobSubmitterTypeDef(TypedDict):
email: NotRequired[str],
userArn: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListTableColumnsRequestRequestTypeDef#
# ListTableColumnsRequestRequestTypeDef definition
class ListTableColumnsRequestRequestTypeDef(TypedDict):
workbookId: str,
tableId: str,
nextToken: NotRequired[str],
TableColumnTypeDef#
# TableColumnTypeDef definition
class TableColumnTypeDef(TypedDict):
tableColumnId: NotRequired[str],
tableColumnName: NotRequired[str],
format: NotRequired[FormatType], # (1)
- See FormatType
ListTableRowsRequestRequestTypeDef#
# ListTableRowsRequestRequestTypeDef definition
class ListTableRowsRequestRequestTypeDef(TypedDict):
workbookId: str,
tableId: str,
rowIds: NotRequired[Sequence[str]],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTablesRequestRequestTypeDef#
# ListTablesRequestRequestTypeDef definition
class ListTablesRequestRequestTypeDef(TypedDict):
workbookId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
TableTypeDef#
# TableTypeDef definition
class TableTypeDef(TypedDict):
tableId: NotRequired[str],
tableName: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
BatchCreateTableRowsResultTypeDef#
# BatchCreateTableRowsResultTypeDef definition
class BatchCreateTableRowsResultTypeDef(TypedDict):
workbookCursor: int,
createdRows: Dict[str, str],
failedBatchItems: List[FailedBatchItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchDeleteTableRowsResultTypeDef#
# BatchDeleteTableRowsResultTypeDef definition
class BatchDeleteTableRowsResultTypeDef(TypedDict):
workbookCursor: int,
failedBatchItems: List[FailedBatchItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchUpdateTableRowsResultTypeDef#
# BatchUpdateTableRowsResultTypeDef definition
class BatchUpdateTableRowsResultTypeDef(TypedDict):
workbookCursor: int,
failedBatchItems: List[FailedBatchItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
InvokeScreenAutomationResultTypeDef#
# InvokeScreenAutomationResultTypeDef definition
class InvokeScreenAutomationResultTypeDef(TypedDict):
workbookCursor: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResultTypeDef#
# ListTagsForResourceResultTypeDef definition
class ListTagsForResourceResultTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartTableDataImportJobResultTypeDef#
# StartTableDataImportJobResultTypeDef definition
class StartTableDataImportJobResultTypeDef(TypedDict):
jobId: str,
jobStatus: TableDataImportJobStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchUpsertTableRowsResultTypeDef#
# BatchUpsertTableRowsResultTypeDef definition
class BatchUpsertTableRowsResultTypeDef(TypedDict):
rows: Dict[str, UpsertRowsResultTypeDef], # (1)
workbookCursor: int,
failedBatchItems: List[FailedBatchItemTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
CreateRowDataTypeDef#
# CreateRowDataTypeDef definition
class CreateRowDataTypeDef(TypedDict):
batchItemId: str,
cellsToCreate: Mapping[str, CellInputTypeDef], # (1)
- See CellInputTypeDef
UpdateRowDataTypeDef#
# UpdateRowDataTypeDef definition
class UpdateRowDataTypeDef(TypedDict):
rowId: str,
cellsToUpdate: Mapping[str, CellInputTypeDef], # (1)
- See CellInputTypeDef
TableRowTypeDef#
# TableRowTypeDef definition
class TableRowTypeDef(TypedDict):
rowId: str,
cells: List[CellTypeDef], # (1)
- See CellTypeDef
ResultRowTypeDef#
# ResultRowTypeDef definition
class ResultRowTypeDef(TypedDict):
dataItems: List[DataItemTypeDef], # (1)
rowId: NotRequired[str],
- See DataItemTypeDef
DestinationOptionsTypeDef#
# DestinationOptionsTypeDef definition
class DestinationOptionsTypeDef(TypedDict):
columnMap: NotRequired[Dict[str, SourceDataColumnPropertiesTypeDef]], # (1)
QueryTableRowsRequestRequestTypeDef#
# QueryTableRowsRequestRequestTypeDef definition
class QueryTableRowsRequestRequestTypeDef(TypedDict):
workbookId: str,
tableId: str,
filterFormula: FilterTypeDef, # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
- See FilterTypeDef
UpsertRowDataTypeDef#
# UpsertRowDataTypeDef definition
class UpsertRowDataTypeDef(TypedDict):
batchItemId: str,
filter: FilterTypeDef, # (1)
cellsToUpdate: Mapping[str, CellInputTypeDef], # (2)
- See FilterTypeDef
- See CellInputTypeDef
GetScreenDataRequestRequestTypeDef#
# GetScreenDataRequestRequestTypeDef definition
class GetScreenDataRequestRequestTypeDef(TypedDict):
workbookId: str,
appId: str,
screenId: str,
variables: NotRequired[Mapping[str, VariableValueTypeDef]], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
InvokeScreenAutomationRequestRequestTypeDef#
# InvokeScreenAutomationRequestRequestTypeDef definition
class InvokeScreenAutomationRequestRequestTypeDef(TypedDict):
workbookId: str,
appId: str,
screenId: str,
screenAutomationId: str,
variables: NotRequired[Mapping[str, VariableValueTypeDef]], # (1)
rowId: NotRequired[str],
clientRequestToken: NotRequired[str],
ImportDataSourceTypeDef#
# ImportDataSourceTypeDef definition
class ImportDataSourceTypeDef(TypedDict):
dataSourceConfig: ImportDataSourceConfigTypeDef, # (1)
ListTableColumnsRequestListTableColumnsPaginateTypeDef#
# ListTableColumnsRequestListTableColumnsPaginateTypeDef definition
class ListTableColumnsRequestListTableColumnsPaginateTypeDef(TypedDict):
workbookId: str,
tableId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTableRowsRequestListTableRowsPaginateTypeDef#
# ListTableRowsRequestListTableRowsPaginateTypeDef definition
class ListTableRowsRequestListTableRowsPaginateTypeDef(TypedDict):
workbookId: str,
tableId: str,
rowIds: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTablesRequestListTablesPaginateTypeDef#
# ListTablesRequestListTablesPaginateTypeDef definition
class ListTablesRequestListTablesPaginateTypeDef(TypedDict):
workbookId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
QueryTableRowsRequestQueryTableRowsPaginateTypeDef#
# QueryTableRowsRequestQueryTableRowsPaginateTypeDef definition
class QueryTableRowsRequestQueryTableRowsPaginateTypeDef(TypedDict):
workbookId: str,
tableId: str,
filterFormula: FilterTypeDef, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
ListTableColumnsResultTypeDef#
# ListTableColumnsResultTypeDef definition
class ListTableColumnsResultTypeDef(TypedDict):
tableColumns: List[TableColumnTypeDef], # (1)
nextToken: str,
workbookCursor: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTablesResultTypeDef#
# ListTablesResultTypeDef definition
class ListTablesResultTypeDef(TypedDict):
tables: List[TableTypeDef], # (1)
nextToken: str,
workbookCursor: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TableTypeDef
- See ResponseMetadataTypeDef
BatchCreateTableRowsRequestRequestTypeDef#
# BatchCreateTableRowsRequestRequestTypeDef definition
class BatchCreateTableRowsRequestRequestTypeDef(TypedDict):
workbookId: str,
tableId: str,
rowsToCreate: Sequence[CreateRowDataTypeDef], # (1)
clientRequestToken: NotRequired[str],
BatchUpdateTableRowsRequestRequestTypeDef#
# BatchUpdateTableRowsRequestRequestTypeDef definition
class BatchUpdateTableRowsRequestRequestTypeDef(TypedDict):
workbookId: str,
tableId: str,
rowsToUpdate: Sequence[UpdateRowDataTypeDef], # (1)
clientRequestToken: NotRequired[str],
ListTableRowsResultTypeDef#
# ListTableRowsResultTypeDef definition
class ListTableRowsResultTypeDef(TypedDict):
columnIds: List[str],
rows: List[TableRowTypeDef], # (1)
rowIdsNotFound: List[str],
nextToken: str,
workbookCursor: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
QueryTableRowsResultTypeDef#
# QueryTableRowsResultTypeDef definition
class QueryTableRowsResultTypeDef(TypedDict):
columnIds: List[str],
rows: List[TableRowTypeDef], # (1)
nextToken: str,
workbookCursor: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ResultSetTypeDef#
# ResultSetTypeDef definition
class ResultSetTypeDef(TypedDict):
headers: List[ColumnMetadataTypeDef], # (1)
rows: List[ResultRowTypeDef], # (2)
ImportOptionsTypeDef#
# ImportOptionsTypeDef definition
class ImportOptionsTypeDef(TypedDict):
destinationOptions: NotRequired[DestinationOptionsTypeDef], # (1)
delimitedTextOptions: NotRequired[DelimitedTextImportOptionsTypeDef], # (2)
BatchUpsertTableRowsRequestRequestTypeDef#
# BatchUpsertTableRowsRequestRequestTypeDef definition
class BatchUpsertTableRowsRequestRequestTypeDef(TypedDict):
workbookId: str,
tableId: str,
rowsToUpsert: Sequence[UpsertRowDataTypeDef], # (1)
clientRequestToken: NotRequired[str],
GetScreenDataResultTypeDef#
# GetScreenDataResultTypeDef definition
class GetScreenDataResultTypeDef(TypedDict):
results: Dict[str, ResultSetTypeDef], # (1)
workbookCursor: int,
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartTableDataImportJobRequestRequestTypeDef#
# StartTableDataImportJobRequestRequestTypeDef definition
class StartTableDataImportJobRequestRequestTypeDef(TypedDict):
workbookId: str,
dataSource: ImportDataSourceTypeDef, # (1)
dataFormat: ImportSourceDataFormatType, # (2)
destinationTableId: str,
importOptions: ImportOptionsTypeDef, # (3)
clientRequestToken: str,
TableDataImportJobMetadataTypeDef#
# TableDataImportJobMetadataTypeDef definition
class TableDataImportJobMetadataTypeDef(TypedDict):
submitter: ImportJobSubmitterTypeDef, # (1)
submitTime: datetime,
importOptions: ImportOptionsTypeDef, # (2)
dataSource: ImportDataSourceTypeDef, # (3)
DescribeTableDataImportJobResultTypeDef#
# DescribeTableDataImportJobResultTypeDef definition
class DescribeTableDataImportJobResultTypeDef(TypedDict):
jobStatus: TableDataImportJobStatusType, # (1)
message: str,
jobMetadata: TableDataImportJobMetadataTypeDef, # (2)
errorCode: ErrorCodeType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)