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
impl Client
Sourcepub fn batch_create_table_rows(&self) -> BatchCreateTableRowsFluentBuilder
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: trueThe 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: trueThe 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: trueThe 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: falseThe 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(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§impl Client
impl Client
Sourcepub fn batch_delete_table_rows(&self) -> BatchDeleteTableRowsFluentBuilder
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: trueThe 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: trueThe 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: trueThe 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: falseThe 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
impl Client
Sourcepub fn batch_update_table_rows(&self) -> BatchUpdateTableRowsFluentBuilder
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: trueThe 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: trueThe 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: trueThe 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: falseThe 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
impl Client
Sourcepub fn batch_upsert_table_rows(&self) -> BatchUpsertTableRowsFluentBuilder
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: trueThe 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: trueThe 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: trueThe 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: falseThe 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
impl Client
Sourcepub fn describe_table_data_import_job(
&self,
) -> DescribeTableDataImportJobFluentBuilder
pub fn describe_table_data_import_job( &self, ) -> DescribeTableDataImportJobFluentBuilder
Constructs a fluent builder for the DescribeTableDataImportJob
operation.
- The fluent builder is configurable:
workbook_id(impl Into<String>)
/set_workbook_id(Option<String>)
:
required: trueThe 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>)
:
required: trueThe 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>)
:
required: trueThe 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(TableDataImportJobStatus)
:The current status of the import job.
message(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§impl Client
impl Client
Sourcepub fn get_screen_data(&self) -> GetScreenDataFluentBuilder
pub fn get_screen_data(&self) -> GetScreenDataFluentBuilder
Constructs a fluent builder for the GetScreenData
operation.
- The fluent builder is configurable:
workbook_id(impl Into<String>)
/set_workbook_id(Option<String>)
:
required: trueThe ID of the workbook that contains the screen.
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe ID of the app that contains the screen.
screen_id(impl Into<String>)
/set_screen_id(Option<String>)
:
required: trueThe ID of the screen.
variables(impl Into<String>, VariableValue)
/set_variables(Option<HashMap::<String, VariableValue>>)
:
required: falseVariables 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>)
:
required: falseThe 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>)
:
required: falseThis 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(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§impl Client
impl Client
Sourcepub fn invoke_screen_automation(&self) -> InvokeScreenAutomationFluentBuilder
pub fn invoke_screen_automation(&self) -> InvokeScreenAutomationFluentBuilder
Constructs a fluent builder for the InvokeScreenAutomation
operation.
- The fluent builder is configurable:
workbook_id(impl Into<String>)
/set_workbook_id(Option<String>)
:
required: trueThe ID of the workbook that contains the screen automation.
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe ID of the app that contains the screen automation.
screen_id(impl Into<String>)
/set_screen_id(Option<String>)
:
required: trueThe ID of the screen that contains the screen automation.
screen_automation_id(impl Into<String>)
/set_screen_automation_id(Option<String>)
:
required: trueThe ID of the automation action to be performed.
variables(impl Into<String>, VariableValue)
/set_variables(Option<HashMap::<String, VariableValue>>)
:
required: falseVariables 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>)
:
required: falseThe 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>)
:
required: falseThe 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§impl Client
impl Client
Sourcepub fn list_table_columns(&self) -> ListTableColumnsFluentBuilder
pub fn list_table_columns(&self) -> ListTableColumnsFluentBuilder
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>)
:
required: trueThe 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>)
:
required: trueThe 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>)
:
required: falseThis 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(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§impl Client
impl Client
Sourcepub fn list_table_rows(&self) -> ListTableRowsFluentBuilder
pub fn list_table_rows(&self) -> ListTableRowsFluentBuilder
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>)
:
required: trueThe 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>)
:
required: trueThe 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(impl Into<String>)
/set_row_ids(Option<Vec::<String>>)
:
required: falseThis 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>)
:
required: falseThe maximum number of rows to return in each page of the results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThis 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(Vec::<String>)
:The list of columns in the table whose row data is returned in the result.
rows(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§impl Client
impl Client
Sourcepub fn list_tables(&self) -> ListTablesFluentBuilder
pub fn list_tables(&self) -> ListTablesFluentBuilder
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>)
:
required: trueThe 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>)
:
required: falseThe maximum number of tables to return in each page of the results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThis 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(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§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe 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§impl Client
impl Client
Sourcepub fn query_table_rows(&self) -> QueryTableRowsFluentBuilder
pub fn query_table_rows(&self) -> QueryTableRowsFluentBuilder
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>)
:
required: trueThe 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>)
:
required: trueThe 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>)
:
required: trueAn 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>)
:
required: falseThe maximum number of rows to return in each page of the results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThis 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(Vec::<String>)
:The list of columns in the table whose row data is returned in the result.
rows(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§impl Client
impl Client
Sourcepub fn start_table_data_import_job(
&self,
) -> StartTableDataImportJobFluentBuilder
pub fn start_table_data_import_job( &self, ) -> StartTableDataImportJobFluentBuilder
Constructs a fluent builder for the StartTableDataImportJob
operation.
- The fluent builder is configurable:
workbook_id(impl Into<String>)
/set_workbook_id(Option<String>)
:
required: trueThe 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>)
:
required: trueThe 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>)
:
required: trueThe 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>)
:
required: trueThe 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>)
:
required: trueThe options for customizing this import request.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: trueThe 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(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(TableDataImportJobStatus)
:The status of the import job immediately after submitting the request.
- On failure, responds with
SdkError<StartTableDataImportJobError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe resource’s Amazon Resource Name (ARN).
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueA list of tags to apply to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe resource’s Amazon Resource Name (ARN).
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA list of tag keys to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
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
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_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, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);