pub struct Client { /* private fields */ }
Expand description

Client for AWS Migration Hub

Client for invoking operations on AWS Migration Hub. Each operation on AWS Migration Hub 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_migrationhub::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_migrationhub::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 AssociateCreatedArtifact operation has a Client::associate_created_artifact, 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.associate_created_artifact()
    .progress_update_stream("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 associate_created_artifact( &self ) -> AssociateCreatedArtifactFluentBuilder

Constructs a fluent builder for the AssociateCreatedArtifact operation.

source§

impl Client

source

pub fn associate_discovered_resource( &self ) -> AssociateDiscoveredResourceFluentBuilder

Constructs a fluent builder for the AssociateDiscoveredResource operation.

source§

impl Client

source

pub fn create_progress_update_stream( &self ) -> CreateProgressUpdateStreamFluentBuilder

Constructs a fluent builder for the CreateProgressUpdateStream operation.

source§

impl Client

source

pub fn delete_progress_update_stream( &self ) -> DeleteProgressUpdateStreamFluentBuilder

Constructs a fluent builder for the DeleteProgressUpdateStream operation.

source§

impl Client

source

pub fn describe_application_state( &self ) -> DescribeApplicationStateFluentBuilder

Constructs a fluent builder for the DescribeApplicationState operation.

source§

impl Client

source

pub fn describe_migration_task(&self) -> DescribeMigrationTaskFluentBuilder

Constructs a fluent builder for the DescribeMigrationTask operation.

source§

impl Client

source

pub fn disassociate_created_artifact( &self ) -> DisassociateCreatedArtifactFluentBuilder

Constructs a fluent builder for the DisassociateCreatedArtifact operation.

source§

impl Client

source

pub fn disassociate_discovered_resource( &self ) -> DisassociateDiscoveredResourceFluentBuilder

Constructs a fluent builder for the DisassociateDiscoveredResource operation.

source§

impl Client

source

pub fn import_migration_task(&self) -> ImportMigrationTaskFluentBuilder

Constructs a fluent builder for the ImportMigrationTask operation.

source§

impl Client

source

pub fn list_application_states(&self) -> ListApplicationStatesFluentBuilder

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

source§

impl Client

source

pub fn list_created_artifacts(&self) -> ListCreatedArtifactsFluentBuilder

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

source§

impl Client

source

pub fn list_discovered_resources(&self) -> ListDiscoveredResourcesFluentBuilder

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

source§

impl Client

source

pub fn list_migration_tasks(&self) -> ListMigrationTasksFluentBuilder

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

source§

impl Client

source

pub fn list_progress_update_streams( &self ) -> ListProgressUpdateStreamsFluentBuilder

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

source§

impl Client

source

pub fn notify_application_state(&self) -> NotifyApplicationStateFluentBuilder

Constructs a fluent builder for the NotifyApplicationState operation.

source§

impl Client

source

pub fn notify_migration_task_state( &self ) -> NotifyMigrationTaskStateFluentBuilder

Constructs a fluent builder for the NotifyMigrationTaskState operation.

source§

impl Client

source

pub fn put_resource_attributes(&self) -> PutResourceAttributesFluentBuilder

Constructs a fluent builder for the PutResourceAttributes operation.

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

      The name of the ProgressUpdateStream.


    • migration_task_name(impl Into<String>) / set_migration_task_name(Option<String>):
      required: true

      Unique identifier that references the migration task. Do not store personal data in this field.


    • resource_attribute_list(ResourceAttribute) / set_resource_attribute_list(Option<Vec::<ResourceAttribute>>):
      required: true

      Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.

      Takes the object array of ResourceAttribute where the Type field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256 characters.

      • If any “VM” related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all “VM” fields will be discarded and “VM” fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the Example section below for a use case of specifying “VM” related values.

      • If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.


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

      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.


  • On success, responds with PutResourceAttributesOutput
  • On failure, responds with SdkError<PutResourceAttributesError>
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<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