Struct aws_sdk_honeycode::client::Client

source · [−]

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Expand description

Client for Amazon Honeycode

Client for invoking operations on Amazon Honeycode. Each operation on Amazon Honeycode is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_honeycode::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_honeycode::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_honeycode::Client::from_conf(config);

Implementations

source

impl<C, M, R> Client<C, M, R>

source

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl<C, M, R> Client<C, M, R> where
 C: SmithyConnector,
 M: SmithyMiddleware<C>,
 R: NewRequestPolicy,

source

pub fn batch_create_table_rows(&self) -> BatchCreateTableRows<C, M, R>

Constructs a fluent builder for the BatchCreateTableRows operation.

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook where the new rows are being added.
 
 If a workbook with the specified ID could not be found, this API throws ResourceNotFoundException.
- table_id(impl Into<String>) / set_table_id(Option<String>):
 The ID of the table where the new rows are being added.
 
 If a table with the specified ID could not be found, this API throws ResourceNotFoundException.
- rows_to_create(Vec<CreateRowData>) / set_rows_to_create(Option<Vec<CreateRowData>>):
 The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.
 
 Note that if one of the column ids in any of the rows in the request does not exist in the table, then the request fails and no updates are made to the table.
- client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
 The request token for performing the batch create operation. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the operation again.
 
 Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
On success, responds with BatchCreateTableRowsOutput with field(s):
- workbook_cursor(i64):
 The updated workbook cursor after adding the new rows at the end of the table.
- created_rows(Option<HashMap<String, String>>):
 The map of batch item id to the row id that was created for that item.
- failed_batch_items(Option<Vec<FailedBatchItem>>):
 The list of batch items in the request that could not be added to the table. Each element in this list contains one item from the request that could not be added to the table along with the reason why that item could not be added.
On failure, responds with SdkError<BatchCreateTableRowsError>

source

pub fn batch_delete_table_rows(&self) -> BatchDeleteTableRows<C, M, R>

Constructs a fluent builder for the BatchDeleteTableRows operation.

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook where the rows are being deleted.
 
 If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
- table_id(impl Into<String>) / set_table_id(Option<String>):
 The ID of the table where the rows are being deleted.
 
 If a table with the specified id could not be found, this API throws ResourceNotFoundException.
- row_ids(Vec<String>) / set_row_ids(Option<Vec<String>>):
 The list of row ids to delete from the table. You need to specify at least one row id in this list.
 
 Note that if one of the row ids provided in the request does not exist in the table, then the request fails and no rows are deleted from the table.
- client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
 The request token for performing the delete action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.
 
 Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
On success, responds with BatchDeleteTableRowsOutput with field(s):
- workbook_cursor(i64):
 The updated workbook cursor after deleting the rows from the table.
- failed_batch_items(Option<Vec<FailedBatchItem>>):
 The list of row ids in the request that could not be deleted from the table. Each element in this list contains one row id from the request that could not be deleted along with the reason why that item could not be deleted.
On failure, responds with SdkError<BatchDeleteTableRowsError>

source

pub fn batch_update_table_rows(&self) -> BatchUpdateTableRows<C, M, R>

Constructs a fluent builder for the BatchUpdateTableRows operation.

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook where the rows are being updated.
 
 If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
- table_id(impl Into<String>) / set_table_id(Option<String>):
 The ID of the table where the rows are being updated.
 
 If a table with the specified id could not be found, this API throws ResourceNotFoundException.
- rows_to_update(Vec<UpdateRowData>) / set_rows_to_update(Option<Vec<UpdateRowData>>):
 The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.
 
 Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.
- client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
 The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.
 
 Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
On success, responds with BatchUpdateTableRowsOutput with field(s):
- workbook_cursor(i64):
 The updated workbook cursor after adding the new rows at the end of the table.
- failed_batch_items(Option<Vec<FailedBatchItem>>):
 The list of batch items in the request that could not be updated in the table. Each element in this list contains one item from the request that could not be updated in the table along with the reason why that item could not be updated.
On failure, responds with SdkError<BatchUpdateTableRowsError>

source

pub fn batch_upsert_table_rows(&self) -> BatchUpsertTableRows<C, M, R>

Constructs a fluent builder for the BatchUpsertTableRows operation.

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook where the rows are being upserted.
 
 If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
- table_id(impl Into<String>) / set_table_id(Option<String>):
 The ID of the table where the rows are being upserted.
 
 If a table with the specified id could not be found, this API throws ResourceNotFoundException.
- rows_to_upsert(Vec<UpsertRowData>) / set_rows_to_upsert(Option<Vec<UpsertRowData>>):
 The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.
 
 Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows does not exist in the table, then the request fails and no updates are made to the table.
- client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
 The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.
 
 Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
On success, responds with BatchUpsertTableRowsOutput with field(s):
- rows(Option<HashMap<String, UpsertRowsResult>>):
 A map with the batch item id as the key and the result of the upsert operation as the value. The result of the upsert operation specifies whether existing rows were updated or a new row was appended, along with the list of row ids that were affected.
- workbook_cursor(i64):
 The updated workbook cursor after updating or appending rows in the table.
- failed_batch_items(Option<Vec<FailedBatchItem>>):
 The list of batch items in the request that could not be updated or appended in the table. Each element in this list contains one item from the request that could not be updated in the table along with the reason why that item could not be updated or appended.
On failure, responds with SdkError<BatchUpsertTableRowsError>

source

pub fn describe_table_data_import_job(
&self
) -> DescribeTableDataImportJob<C, M, R>

Constructs a fluent builder for the DescribeTableDataImportJob operation.

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook into which data was imported.
 
 If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
- table_id(impl Into<String>) / set_table_id(Option<String>):
 The ID of the table into which data was imported.
 
 If a table with the specified id could not be found, this API throws ResourceNotFoundException.
- job_id(impl Into<String>) / set_job_id(Option<String>):
 The ID of the job that was returned by the StartTableDataImportJob request.
 
 If a job with the specified id could not be found, this API throws ResourceNotFoundException.
On success, responds with DescribeTableDataImportJobOutput with field(s):
- job_status(Option<TableDataImportJobStatus>):
 The current status of the import job.
- message(Option<String>):
 A message providing more details about the current status of the import job.
- job_metadata(Option<TableDataImportJobMetadata>):
 The metadata about the job that was submitted for import.
- error_code(Option<ErrorCode>):
 If job status is failed, error code to understand reason for the failure.
On failure, responds with SdkError<DescribeTableDataImportJobError>

source

pub fn get_screen_data(&self) -> GetScreenData<C, M, R>

Constructs a fluent builder for the GetScreenData operation.

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook that contains the screen.
- app_id(impl Into<String>) / set_app_id(Option<String>):
 The ID of the app that contains the screen.
- screen_id(impl Into<String>) / set_screen_id(Option<String>):
 The ID of the screen.
- variables(HashMap<String, VariableValue>) / set_variables(Option<HashMap<String, VariableValue>>):
 Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.
- max_results(i32) / set_max_results(Option<i32>):
 The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.
 
 This parameter is optional. If you don’t specify this parameter, the default page size is 100.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
 
 Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
On success, responds with GetScreenDataOutput with field(s):
- results(Option<HashMap<String, ResultSet>>):
 A map of all the rows on the screen keyed by block name.
- workbook_cursor(i64):
 Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps increasing with every update and the increments are not sequential.
- next_token(Option<String>):
 Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the query has been loaded.
On failure, responds with SdkError<GetScreenDataError>

source

pub fn invoke_screen_automation(&self) -> InvokeScreenAutomation<C, M, R>

Constructs a fluent builder for the InvokeScreenAutomation operation.

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook that contains the screen automation.
- app_id(impl Into<String>) / set_app_id(Option<String>):
 The ID of the app that contains the screen automation.
- screen_id(impl Into<String>) / set_screen_id(Option<String>):
 The ID of the screen that contains the screen automation.
- screen_automation_id(impl Into<String>) / set_screen_automation_id(Option<String>):
 The ID of the automation action to be performed.
- variables(HashMap<String, VariableValue>) / set_variables(Option<HashMap<String, VariableValue>>):
 Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.
- row_id(impl Into<String>) / set_row_id(Option<String>):
 The row ID for the automation if the automation is defined inside a block with source or list.
- client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
 The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.
 
 Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
On success, responds with InvokeScreenAutomationOutput with field(s):
- workbook_cursor(i64):
  The updated workbook cursor after performing the automation action.
On failure, responds with SdkError<InvokeScreenAutomationError>

source

pub fn list_table_columns(&self) -> ListTableColumns<C, M, R>

Constructs a fluent builder for the ListTableColumns operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook that contains the table whose columns are being retrieved.
 
 If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
- table_id(impl Into<String>) / set_table_id(Option<String>):
 The ID of the table whose columns are being retrieved.
 
 If a table with the specified id could not be found, this API throws ResourceNotFoundException.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
 
 Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
On success, responds with ListTableColumnsOutput with field(s):
- table_columns(Option<Vec<TableColumn>>):
 The list of columns in the table.
- next_token(Option<String>):
 Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.
- workbook_cursor(i64):
 Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.
On failure, responds with SdkError<ListTableColumnsError>

source

pub fn list_table_rows(&self) -> ListTableRows<C, M, R>

Constructs a fluent builder for the ListTableRows operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook that contains the table whose rows are being retrieved.
 
 If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
- table_id(impl Into<String>) / set_table_id(Option<String>):
 The ID of the table whose rows are being retrieved.
 
 If a table with the specified id could not be found, this API throws ResourceNotFoundException.
- row_ids(Vec<String>) / set_row_ids(Option<Vec<String>>):
 This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of rows to return in each page of the results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
 
 Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
On success, responds with ListTableRowsOutput with field(s):
- column_ids(Option<Vec<String>>):
 The list of columns in the table whose row data is returned in the result.
- rows(Option<Vec<TableRow>>):
 The list of rows in the table. Note that this result is paginated, so this list contains a maximum of 100 rows.
- row_ids_not_found(Option<Vec<String>>):
 The list of row ids included in the request that were not found in the table.
- next_token(Option<String>):
 Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.
- workbook_cursor(i64):
 Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.
On failure, responds with SdkError<ListTableRowsError>

source

pub fn list_tables(&self) -> ListTables<C, M, R>

Constructs a fluent builder for the ListTables operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook whose tables are being retrieved.
 
 If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of tables to return in each page of the results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
 
 Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
On success, responds with ListTablesOutput with field(s):
- tables(Option<Vec<Table>>):
 The list of tables in the workbook.
- next_token(Option<String>):
 Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.
- workbook_cursor(i64):
 Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.
On failure, responds with SdkError<ListTablesError>

source

pub fn list_tags_for_resource(&self) -> ListTagsForResource<C, M, R>

Constructs a fluent builder for the ListTagsForResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The resource’s Amazon Resource Name (ARN).
On success, responds with ListTagsForResourceOutput with field(s):
- tags(Option<HashMap<String, String>>):
 The resource’s tags.
On failure, responds with SdkError<ListTagsForResourceError>

source

pub fn query_table_rows(&self) -> QueryTableRows<C, M, R>

Constructs a fluent builder for the QueryTableRows operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook whose table rows are being queried.
 
 If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
- table_id(impl Into<String>) / set_table_id(Option<String>):
 The ID of the table whose rows are being queried.
 
 If a table with the specified id could not be found, this API throws ResourceNotFoundException.
- filter_formula(Filter) / set_filter_formula(Option<Filter>):
 An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of rows to return in each page of the results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
 
 Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
On success, responds with QueryTableRowsOutput with field(s):
- column_ids(Option<Vec<String>>):
 The list of columns in the table whose row data is returned in the result.
- rows(Option<Vec<TableRow>>):
 The list of rows in the table that match the query filter.
- next_token(Option<String>):
 Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.
- workbook_cursor(i64):
 Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.
On failure, responds with SdkError<QueryTableRowsError>

source

pub fn start_table_data_import_job(&self) -> StartTableDataImportJob<C, M, R>

Constructs a fluent builder for the StartTableDataImportJob operation.

The fluent builder is configurable:
- workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
 The ID of the workbook where the rows are being imported.
 
 If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
- data_source(ImportDataSource) / set_data_source(Option<ImportDataSource>):
 The source of the data that is being imported. The size of source must be no larger than 100 MB. Source must have no more than 100,000 cells and no more than 1,000 rows.
- data_format(ImportSourceDataFormat) / set_data_format(Option<ImportSourceDataFormat>):
 The format of the data that is being imported. Currently the only option supported is “DELIMITED_TEXT”.
- destination_table_id(impl Into<String>) / set_destination_table_id(Option<String>):
 The ID of the table where the rows are being imported.
 
 If a table with the specified id could not be found, this API throws ResourceNotFoundException.
- import_options(ImportOptions) / set_import_options(Option<ImportOptions>):
 The options for customizing this import request.
- client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
 The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.
 
 Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
On success, responds with StartTableDataImportJobOutput with field(s):
- job_id(Option<String>):
 The id that is assigned to this import job. Future requests to find out the status of this import job need to send this id in the appropriate parameter in the request.
- job_status(Option<TableDataImportJobStatus>):
 The status of the import job immediately after submitting the request.
On failure, responds with SdkError<StartTableDataImportJobError>