Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Migration Hub Config

Client for invoking operations on AWS Migration Hub Config. Each operation on AWS Migration Hub Config 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_migrationhubconfig::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_migrationhubconfig::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 CreateHomeRegionControl operation has a Client::create_home_region_control, 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_home_region_control()
    .home_region("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 create_home_region_control(&self) -> CreateHomeRegionControlFluentBuilder

Constructs a fluent builder for the CreateHomeRegionControl operation.

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

    The name of the home region of the calling account.

    
    
  • target(Target) / set_target(Option<Target>):
    required: true
    

    The account for which this command sets up a home region control. The Target is always of type ACCOUNT.

    
    
  • dry_run(bool) / set_dry_run(Option<bool>):
    required: false
    

    Optional Boolean flag to indicate whether any effect should take place. It tests whether the caller has permission to make the call.

    
    
• On success, responds with CreateHomeRegionControlOutput with field(s):
  • home_region_control(Option<HomeRegionControl>):

    This object is the HomeRegionControl object that’s returned by a successful call to CreateHomeRegionControl.

• On failure, responds with SdkError<CreateHomeRegionControlError>

impl Client

pub fn delete_home_region_control(&self) -> DeleteHomeRegionControlFluentBuilder

Constructs a fluent builder for the DeleteHomeRegionControl operation.

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

    A unique identifier that’s generated for each home region control. It’s always a string that begins with “hrc-” followed by 12 lowercase letters and numbers.

    
    
• On success, responds with DeleteHomeRegionControlOutput
• On failure, responds with SdkError<DeleteHomeRegionControlError>

impl Client

pub fn describe_home_region_controls( &self, ) -> DescribeHomeRegionControlsFluentBuilder

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

• The fluent builder is configurable:
  • control_id(impl Into<String>) / set_control_id(Option<String>):
    required: false
    

    The ControlID is a unique identifier string of your HomeRegionControl object.

    
    
  • home_region(impl Into<String>) / set_home_region(Option<String>):
    required: false
    

    The name of the home region you’d like to view.

    
    
  • target(Target) / set_target(Option<Target>):
    required: false
    

    The target parameter specifies the identifier to which the home region is applied, which is always of type ACCOUNT. It applies the home region to the current ACCOUNT.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of filtering results to display per page.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If a NextToken was returned by a previous call, more results are available. To retrieve the next page of results, make the call again using the returned token in NextToken.

    
    
• On success, responds with DescribeHomeRegionControlsOutput with field(s):
  • home_region_controls(Option<Vec::<HomeRegionControl>>):

    An array that contains your HomeRegionControl objects.

  • next_token(Option<String>):

    If a NextToken was returned by a previous call, more results are available. To retrieve the next page of results, make the call again using the returned token in NextToken.

• On failure, responds with SdkError<DescribeHomeRegionControlsError>

impl Client

pub fn get_home_region(&self) -> GetHomeRegionFluentBuilder

Constructs a fluent builder for the GetHomeRegion operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetHomeRegionOutput with field(s):
  • home_region(Option<String>):

    The name of the home region of the calling account.

• On failure, responds with SdkError<GetHomeRegionError>

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 duplicate 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.