aws_sdk_migrationhuborchestrator::client

Struct Client

pub struct Client { /* private fields */ }

Expand description

Client for AWS Migration Hub Orchestrator

Client for invoking operations on AWS Migration Hub Orchestrator. Each operation on AWS Migration Hub Orchestrator 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_migrationhuborchestrator::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_migrationhuborchestrator::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 CreateTemplate operation has a Client::create_template, 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.create_template()
    .template_name("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.

Struct ClientCopy item path

§Constructing a Client

§Using the Client

Implementations§

impl Client

pub fn create_template(&self) -> CreateTemplateFluentBuilder

impl Client

pub fn create_workflow(&self) -> CreateWorkflowFluentBuilder

impl Client

pub fn create_workflow_step(&self) -> CreateWorkflowStepFluentBuilder

impl Client

pub fn create_workflow_step_group(&self) -> CreateWorkflowStepGroupFluentBuilder

impl Client

pub fn delete_template(&self) -> DeleteTemplateFluentBuilder

impl Client

pub fn delete_workflow(&self) -> DeleteWorkflowFluentBuilder

impl Client

pub fn delete_workflow_step(&self) -> DeleteWorkflowStepFluentBuilder

impl Client

pub fn delete_workflow_step_group(&self) -> DeleteWorkflowStepGroupFluentBuilder

impl Client

pub fn get_template(&self) -> GetTemplateFluentBuilder

impl Client

pub fn get_template_step(&self) -> GetTemplateStepFluentBuilder

impl Client

pub fn get_template_step_group(&self) -> GetTemplateStepGroupFluentBuilder

impl Client

pub fn get_workflow(&self) -> GetWorkflowFluentBuilder

impl Client

pub fn get_workflow_step(&self) -> GetWorkflowStepFluentBuilder

impl Client

pub fn get_workflow_step_group(&self) -> GetWorkflowStepGroupFluentBuilder

impl Client

pub fn list_plugins(&self) -> ListPluginsFluentBuilder

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

impl Client

pub fn list_template_step_groups(&self) -> ListTemplateStepGroupsFluentBuilder

impl Client

pub fn list_template_steps(&self) -> ListTemplateStepsFluentBuilder

impl Client

pub fn list_templates(&self) -> ListTemplatesFluentBuilder

impl Client

pub fn list_workflow_step_groups(&self) -> ListWorkflowStepGroupsFluentBuilder

impl Client

pub fn list_workflow_steps(&self) -> ListWorkflowStepsFluentBuilder

impl Client

pub fn list_workflows(&self) -> ListWorkflowsFluentBuilder

impl Client

pub fn retry_workflow_step(&self) -> RetryWorkflowStepFluentBuilder

impl Client

pub fn start_workflow(&self) -> StartWorkflowFluentBuilder

impl Client

pub fn stop_workflow(&self) -> StopWorkflowFluentBuilder

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

impl Client

pub fn update_template(&self) -> UpdateTemplateFluentBuilder

impl Client

pub fn update_workflow(&self) -> UpdateWorkflowFluentBuilder

impl Client

pub fn update_workflow_step(&self) -> UpdateWorkflowStepFluentBuilder

impl Client

pub fn update_workflow_step_group(&self) -> UpdateWorkflowStepGroupFluentBuilder

impl Client

pub fn from_conf(conf: Config) -> Self

§Panics

pub fn config(&self) -> &Config

impl Client

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

§Panics

Trait Implementations§

impl Clone for Client

fn clone(&self) -> Client

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

impl Debug for Client

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

Auto Trait Implementations§

Struct Client

§Constructing a `Client`

§Using the `Client`

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

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

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

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

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

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

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

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