Struct aws_sdk_honeycode::Client

source ·
pub struct Client { /* 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.

§Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_honeycode::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_honeycode::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

§Using the Client

A client has a function for every operation that can be performed by the service. For example, the BatchCreateTableRows operation has a Client::batch_create_table_rows, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.batch_create_table_rows()
    .workbook_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations§

source§

impl Client

source

pub fn batch_create_table_rows(&self) -> BatchCreateTableRowsFluentBuilder

Constructs a fluent builder for the BatchCreateTableRows operation.

  • The fluent builder is configurable:
    • workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
      required: true

      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>):
      required: true

      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(CreateRowData) / set_rows_to_create(Option<Vec::<CreateRowData>>):
      required: true

      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>):
      required: false

      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):
  • On failure, responds with SdkError<BatchCreateTableRowsError>
source§

impl Client

source

pub fn batch_delete_table_rows(&self) -> BatchDeleteTableRowsFluentBuilder

Constructs a fluent builder for the BatchDeleteTableRows operation.

  • The fluent builder is configurable:
    • workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
      required: true

      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>):
      required: true

      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(impl Into<String>) / set_row_ids(Option<Vec::<String>>):
      required: true

      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>):
      required: false

      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§

impl Client

source

pub fn batch_update_table_rows(&self) -> BatchUpdateTableRowsFluentBuilder

Constructs a fluent builder for the BatchUpdateTableRows operation.

  • The fluent builder is configurable:
    • workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
      required: true

      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>):
      required: true

      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(UpdateRowData) / set_rows_to_update(Option<Vec::<UpdateRowData>>):
      required: true

      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>):
      required: false

      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§

impl Client

source

pub fn batch_upsert_table_rows(&self) -> BatchUpsertTableRowsFluentBuilder

Constructs a fluent builder for the BatchUpsertTableRows operation.

  • The fluent builder is configurable:
    • workbook_id(impl Into<String>) / set_workbook_id(Option<String>):
      required: true

      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>):
      required: true

      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(UpsertRowData) / set_rows_to_upsert(Option<Vec::<UpsertRowData>>):
      required: true

      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>):
      required: false

      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(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§

impl Client

source

pub fn describe_table_data_import_job( &self ) -> DescribeTableDataImportJobFluentBuilder

Constructs a fluent builder for the DescribeTableDataImportJob operation.

source§

impl Client

source

pub fn get_screen_data(&self) -> GetScreenDataFluentBuilder

Constructs a fluent builder for the GetScreenData operation.

source§

impl Client

source

pub fn invoke_screen_automation(&self) -> InvokeScreenAutomationFluentBuilder

Constructs a fluent builder for the InvokeScreenAutomation operation.

source§

impl Client

source

pub fn list_table_columns(&self) -> ListTableColumnsFluentBuilder

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

source§

impl Client

source

pub fn list_table_rows(&self) -> ListTableRowsFluentBuilder

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

source§

impl Client

source

pub fn list_tables(&self) -> ListTablesFluentBuilder

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

source§

impl Client

source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

source§

impl Client

source

pub fn query_table_rows(&self) -> QueryTableRowsFluentBuilder

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

source§

impl Client

source

pub fn start_table_data_import_job( &self ) -> StartTableDataImportJobFluentBuilder

Constructs a fluent builder for the StartTableDataImportJob operation.

source§

impl Client

source

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

source§

impl Client

source

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

source§

impl Client

source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

  • Retries or timeouts are enabled without a sleep_impl configured.
  • Identity caching is enabled without a sleep_impl and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

source

pub fn config(&self) -> &Config

Returns the client’s configuration.

source§

impl Client

source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

§Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
  • This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more