Skip to content

HoneycodeClient#

Index > Honeycode > HoneycodeClient

Auto-generated documentation for Honeycode type annotations stubs module mypy-boto3-honeycode.

HoneycodeClient#

Type annotations and code completion for boto3.client("honeycode"). boto3 documentation

# HoneycodeClient usage example

from boto3.session import Session
from mypy_boto3_honeycode.client import HoneycodeClient

def get_honeycode_client() -> HoneycodeClient:
    return Session().client("honeycode")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("honeycode").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("honeycode")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.AutomationExecutionException,
    client.exceptions.AutomationExecutionTimeoutException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.RequestTimeoutException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_honeycode.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

batch_create_table_rows#

The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook.

Type annotations and code completion for boto3.client("honeycode").batch_create_table_rows method. boto3 documentation

# batch_create_table_rows method definition

def batch_create_table_rows(
    self,
    *,
    workbookId: str,
    tableId: str,
    rowsToCreate: Sequence[CreateRowDataTypeDef],  # (1)
    clientRequestToken: str = ...,
) -> BatchCreateTableRowsResultTypeDef:  # (2)
    ...
  1. See CreateRowDataTypeDef
  2. See BatchCreateTableRowsResultTypeDef 
# batch_create_table_rows method usage example with argument unpacking

kwargs: BatchCreateTableRowsRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
    "tableId": ...,
    "rowsToCreate": ...,
}

parent.batch_create_table_rows(**kwargs)
  1. See BatchCreateTableRowsRequestRequestTypeDef

batch_delete_table_rows#

The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook.

Type annotations and code completion for boto3.client("honeycode").batch_delete_table_rows method. boto3 documentation

# batch_delete_table_rows method definition

def batch_delete_table_rows(
    self,
    *,
    workbookId: str,
    tableId: str,
    rowIds: Sequence[str],
    clientRequestToken: str = ...,
) -> BatchDeleteTableRowsResultTypeDef:  # (1)
    ...
  1. See BatchDeleteTableRowsResultTypeDef 
# batch_delete_table_rows method usage example with argument unpacking

kwargs: BatchDeleteTableRowsRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
    "tableId": ...,
    "rowIds": ...,
}

parent.batch_delete_table_rows(**kwargs)
  1. See BatchDeleteTableRowsRequestRequestTypeDef

batch_update_table_rows#

The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.

Type annotations and code completion for boto3.client("honeycode").batch_update_table_rows method. boto3 documentation

# batch_update_table_rows method definition

def batch_update_table_rows(
    self,
    *,
    workbookId: str,
    tableId: str,
    rowsToUpdate: Sequence[UpdateRowDataTypeDef],  # (1)
    clientRequestToken: str = ...,
) -> BatchUpdateTableRowsResultTypeDef:  # (2)
    ...
  1. See UpdateRowDataTypeDef
  2. See BatchUpdateTableRowsResultTypeDef 
# batch_update_table_rows method usage example with argument unpacking

kwargs: BatchUpdateTableRowsRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
    "tableId": ...,
    "rowsToUpdate": ...,
}

parent.batch_update_table_rows(**kwargs)
  1. See BatchUpdateTableRowsRequestRequestTypeDef

batch_upsert_table_rows#

The BatchUpsertTableRows API allows you to upsert one or more rows in a table.

Type annotations and code completion for boto3.client("honeycode").batch_upsert_table_rows method. boto3 documentation

# batch_upsert_table_rows method definition

def batch_upsert_table_rows(
    self,
    *,
    workbookId: str,
    tableId: str,
    rowsToUpsert: Sequence[UpsertRowDataTypeDef],  # (1)
    clientRequestToken: str = ...,
) -> BatchUpsertTableRowsResultTypeDef:  # (2)
    ...
  1. See UpsertRowDataTypeDef
  2. See BatchUpsertTableRowsResultTypeDef 
# batch_upsert_table_rows method usage example with argument unpacking

kwargs: BatchUpsertTableRowsRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
    "tableId": ...,
    "rowsToUpsert": ...,
}

parent.batch_upsert_table_rows(**kwargs)
  1. See BatchUpsertTableRowsRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("honeycode").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("honeycode").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

describe_table_data_import_job#

The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.

Type annotations and code completion for boto3.client("honeycode").describe_table_data_import_job method. boto3 documentation

# describe_table_data_import_job method definition

def describe_table_data_import_job(
    self,
    *,
    workbookId: str,
    tableId: str,
    jobId: str,
) -> DescribeTableDataImportJobResultTypeDef:  # (1)
    ...
  1. See DescribeTableDataImportJobResultTypeDef 
# describe_table_data_import_job method usage example with argument unpacking

kwargs: DescribeTableDataImportJobRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
    "tableId": ...,
    "jobId": ...,
}

parent.describe_table_data_import_job(**kwargs)
  1. See DescribeTableDataImportJobRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("honeycode").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_screen_data#

The GetScreenData API allows retrieval of data from a screen in a Honeycode app.

Type annotations and code completion for boto3.client("honeycode").get_screen_data method. boto3 documentation

# get_screen_data method definition

def get_screen_data(
    self,
    *,
    workbookId: str,
    appId: str,
    screenId: str,
    variables: Mapping[str, VariableValueTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetScreenDataResultTypeDef:  # (2)
    ...
  1. See VariableValueTypeDef
  2. See GetScreenDataResultTypeDef 
# get_screen_data method usage example with argument unpacking

kwargs: GetScreenDataRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
    "appId": ...,
    "screenId": ...,
}

parent.get_screen_data(**kwargs)
  1. See GetScreenDataRequestRequestTypeDef

invoke_screen_automation#

The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.

Type annotations and code completion for boto3.client("honeycode").invoke_screen_automation method. boto3 documentation

# invoke_screen_automation method definition

def invoke_screen_automation(
    self,
    *,
    workbookId: str,
    appId: str,
    screenId: str,
    screenAutomationId: str,
    variables: Mapping[str, VariableValueTypeDef] = ...,  # (1)
    rowId: str = ...,
    clientRequestToken: str = ...,
) -> InvokeScreenAutomationResultTypeDef:  # (2)
    ...
  1. See VariableValueTypeDef
  2. See InvokeScreenAutomationResultTypeDef 
# invoke_screen_automation method usage example with argument unpacking

kwargs: InvokeScreenAutomationRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
    "appId": ...,
    "screenId": ...,
    "screenAutomationId": ...,
}

parent.invoke_screen_automation(**kwargs)
  1. See InvokeScreenAutomationRequestRequestTypeDef

list_table_columns#

The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.

Type annotations and code completion for boto3.client("honeycode").list_table_columns method. boto3 documentation

# list_table_columns method definition

def list_table_columns(
    self,
    *,
    workbookId: str,
    tableId: str,
    nextToken: str = ...,
) -> ListTableColumnsResultTypeDef:  # (1)
    ...
  1. See ListTableColumnsResultTypeDef 
# list_table_columns method usage example with argument unpacking

kwargs: ListTableColumnsRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
    "tableId": ...,
}

parent.list_table_columns(**kwargs)
  1. See ListTableColumnsRequestRequestTypeDef

list_table_rows#

The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.

Type annotations and code completion for boto3.client("honeycode").list_table_rows method. boto3 documentation

# list_table_rows method definition

def list_table_rows(
    self,
    *,
    workbookId: str,
    tableId: str,
    rowIds: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTableRowsResultTypeDef:  # (1)
    ...
  1. See ListTableRowsResultTypeDef 
# list_table_rows method usage example with argument unpacking

kwargs: ListTableRowsRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
    "tableId": ...,
}

parent.list_table_rows(**kwargs)
  1. See ListTableRowsRequestRequestTypeDef

list_tables#

The ListTables API allows you to retrieve a list of all the tables in a workbook.

Type annotations and code completion for boto3.client("honeycode").list_tables method. boto3 documentation

# list_tables method definition

def list_tables(
    self,
    *,
    workbookId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTablesResultTypeDef:  # (1)
    ...
  1. See ListTablesResultTypeDef 
# list_tables method usage example with argument unpacking

kwargs: ListTablesRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
}

parent.list_tables(**kwargs)
  1. See ListTablesRequestRequestTypeDef

list_tags_for_resource#

The ListTagsForResource API allows you to return a resource's tags.

Type annotations and code completion for boto3.client("honeycode").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResultTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResultTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

query_table_rows#

The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.

Type annotations and code completion for boto3.client("honeycode").query_table_rows method. boto3 documentation

# query_table_rows method definition

def query_table_rows(
    self,
    *,
    workbookId: str,
    tableId: str,
    filterFormula: FilterTypeDef,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> QueryTableRowsResultTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See QueryTableRowsResultTypeDef 
# query_table_rows method usage example with argument unpacking

kwargs: QueryTableRowsRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
    "tableId": ...,
    "filterFormula": ...,
}

parent.query_table_rows(**kwargs)
  1. See QueryTableRowsRequestRequestTypeDef

start_table_data_import_job#

The StartTableDataImportJob API allows you to start an import job on a table.

Type annotations and code completion for boto3.client("honeycode").start_table_data_import_job method. boto3 documentation

# start_table_data_import_job method definition

def start_table_data_import_job(
    self,
    *,
    workbookId: str,
    dataSource: ImportDataSourceTypeDef,  # (1)
    dataFormat: ImportSourceDataFormatType,  # (2)
    destinationTableId: str,
    importOptions: ImportOptionsTypeDef,  # (3)
    clientRequestToken: str,
) -> StartTableDataImportJobResultTypeDef:  # (4)
    ...
  1. See ImportDataSourceTypeDef
  2. See ImportSourceDataFormatType
  3. See ImportOptionsTypeDef
  4. See StartTableDataImportJobResultTypeDef 
# start_table_data_import_job method usage example with argument unpacking

kwargs: StartTableDataImportJobRequestRequestTypeDef = {  # (1)
    "workbookId": ...,
    "dataSource": ...,
    "dataFormat": ...,
    "destinationTableId": ...,
    "importOptions": ...,
    "clientRequestToken": ...,
}

parent.start_table_data_import_job(**kwargs)
  1. See StartTableDataImportJobRequestRequestTypeDef

tag_resource#

The TagResource API allows you to add tags to an ARN-able resource.

Type annotations and code completion for boto3.client("honeycode").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

The UntagResource API allows you to removes tags from an ARN-able resource.

Type annotations and code completion for boto3.client("honeycode").untag_resource method.