Struct Client

pub struct Client { /* private fields */ }

Client for Runtime for Amazon Bedrock Data Automation

Client for invoking operations on Runtime for Amazon Bedrock Data Automation. Each operation on Runtime for Amazon Bedrock Data Automation 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_bedrockdataautomationruntime::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 Builder 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_bedrockdataautomationruntime::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 GetDataAutomationStatus operation has a Client::get_data_automation_status, 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.get_data_automation_status()
    .invocation_arn("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

impl Client

pub fn get_data_automation_status(&self) -> GetDataAutomationStatusFluentBuilder

Constructs a fluent builder for the GetDataAutomationStatus operation.

• The fluent builder is configurable:
  • invocation_arn(impl Into<String>) / set_invocation_arn(Option<String>):
    required: true
    Invocation arn.
    
• On success, responds with GetDataAutomationStatusOutput with field(s):
  • status(Option<AutomationJobStatus>): Job Status.
  • error_type(Option<String>): Error Type.
  • error_message(Option<String>): Error Message.
  • output_configuration(Option<OutputConfiguration>): Output configuration.
• On failure, responds with SdkError<GetDataAutomationStatusError>

impl Client

pub fn invoke_data_automation_async( &self, ) -> InvokeDataAutomationAsyncFluentBuilder

Constructs a fluent builder for the InvokeDataAutomationAsync operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Idempotency token.
    
  • input_configuration(InputConfiguration) / set_input_configuration(Option<InputConfiguration>):
    required: true
    Input configuration.
    
  • output_configuration(OutputConfiguration) / set_output_configuration(Option<OutputConfiguration>):
    required: true
    Output configuration.
    
  • data_automation_configuration(DataAutomationConfiguration) / set_data_automation_configuration(Option<DataAutomationConfiguration>):
    required: false
    Data automation configuration.
    
  • encryption_configuration(EncryptionConfiguration) / set_encryption_configuration(Option<EncryptionConfiguration>):
    required: false
    Encryption configuration.
    
  • notification_configuration(NotificationConfiguration) / set_notification_configuration(Option<NotificationConfiguration>):
    required: false
    Notification configuration.
    
  • blueprints(Blueprint) / set_blueprints(Option<Vec::<Blueprint>>):
    required: false
    Blueprint list.
    
  • data_automation_profile_arn(impl Into<String>) / set_data_automation_profile_arn(Option<String>):
    required: true
    Data automation profile ARN
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    List of tags.
    
• On success, responds with InvokeDataAutomationAsyncOutput with field(s):
  • invocation_arn(String): ARN of the automation job
• On failure, responds with SdkError<InvokeDataAutomationAsyncError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    ARN of a taggable resource
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>): List of tags
• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

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: true
    ARN of a taggable resource
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    List of tags
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

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: true
    ARN of a taggable resource
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    List of tag keys
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

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.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.