Struct aws_sdk_migrationhub::Client
source · [−]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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_migrationhub::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_migrationhub::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_migrationhub::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn associate_created_artifact(&self) -> AssociateCreatedArtifact
pub fn associate_created_artifact(&self) -> AssociateCreatedArtifact
Constructs a fluent builder for the AssociateCreatedArtifact
operation.
- The fluent builder is configurable:
progress_update_stream(impl Into<String>)
/set_progress_update_stream(Option<String>)
:The name of the ProgressUpdateStream.
migration_task_name(impl Into<String>)
/set_migration_task_name(Option<String>)
:Unique identifier that references the migration task. Do not store personal data in this field.
created_artifact(CreatedArtifact)
/set_created_artifact(Option<CreatedArtifact>)
:An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)
dry_run(bool)
/set_dry_run(bool)
: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
AssociateCreatedArtifactOutput
- On failure, responds with
SdkError<AssociateCreatedArtifactError>
sourcepub fn associate_discovered_resource(&self) -> AssociateDiscoveredResource
pub fn associate_discovered_resource(&self) -> AssociateDiscoveredResource
Constructs a fluent builder for the AssociateDiscoveredResource
operation.
- The fluent builder is configurable:
progress_update_stream(impl Into<String>)
/set_progress_update_stream(Option<String>)
:The name of the ProgressUpdateStream.
migration_task_name(impl Into<String>)
/set_migration_task_name(Option<String>)
:The identifier given to the MigrationTask. Do not store personal data in this field.
discovered_resource(DiscoveredResource)
/set_discovered_resource(Option<DiscoveredResource>)
:Object representing a Resource.
dry_run(bool)
/set_dry_run(bool)
: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
AssociateDiscoveredResourceOutput
- On failure, responds with
SdkError<AssociateDiscoveredResourceError>
sourcepub fn create_progress_update_stream(&self) -> CreateProgressUpdateStream
pub fn create_progress_update_stream(&self) -> CreateProgressUpdateStream
Constructs a fluent builder for the CreateProgressUpdateStream
operation.
- The fluent builder is configurable:
progress_update_stream_name(impl Into<String>)
/set_progress_update_stream_name(Option<String>)
:The name of the ProgressUpdateStream. Do not store personal data in this field.
dry_run(bool)
/set_dry_run(bool)
: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
CreateProgressUpdateStreamOutput
- On failure, responds with
SdkError<CreateProgressUpdateStreamError>
sourcepub fn delete_progress_update_stream(&self) -> DeleteProgressUpdateStream
pub fn delete_progress_update_stream(&self) -> DeleteProgressUpdateStream
Constructs a fluent builder for the DeleteProgressUpdateStream
operation.
- The fluent builder is configurable:
progress_update_stream_name(impl Into<String>)
/set_progress_update_stream_name(Option<String>)
:The name of the ProgressUpdateStream. Do not store personal data in this field.
dry_run(bool)
/set_dry_run(bool)
: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
DeleteProgressUpdateStreamOutput
- On failure, responds with
SdkError<DeleteProgressUpdateStreamError>
sourcepub fn describe_application_state(&self) -> DescribeApplicationState
pub fn describe_application_state(&self) -> DescribeApplicationState
Constructs a fluent builder for the DescribeApplicationState
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:The configurationId in Application Discovery Service that uniquely identifies the grouped application.
- On success, responds with
DescribeApplicationStateOutput
with field(s):application_status(Option<ApplicationStatus>)
:Status of the application - Not Started, In-Progress, Complete.
last_updated_time(Option<DateTime>)
:The timestamp when the application status was last updated.
- On failure, responds with
SdkError<DescribeApplicationStateError>
sourcepub fn describe_migration_task(&self) -> DescribeMigrationTask
pub fn describe_migration_task(&self) -> DescribeMigrationTask
Constructs a fluent builder for the DescribeMigrationTask
operation.
- The fluent builder is configurable:
progress_update_stream(impl Into<String>)
/set_progress_update_stream(Option<String>)
:The name of the ProgressUpdateStream.
migration_task_name(impl Into<String>)
/set_migration_task_name(Option<String>)
:The identifier given to the MigrationTask. Do not store personal data in this field.
- On success, responds with
DescribeMigrationTaskOutput
with field(s):migration_task(Option<MigrationTask>)
:Object encapsulating information about the migration task.
- On failure, responds with
SdkError<DescribeMigrationTaskError>
sourcepub fn disassociate_created_artifact(&self) -> DisassociateCreatedArtifact
pub fn disassociate_created_artifact(&self) -> DisassociateCreatedArtifact
Constructs a fluent builder for the DisassociateCreatedArtifact
operation.
- The fluent builder is configurable:
progress_update_stream(impl Into<String>)
/set_progress_update_stream(Option<String>)
:The name of the ProgressUpdateStream.
migration_task_name(impl Into<String>)
/set_migration_task_name(Option<String>)
:Unique identifier that references the migration task to be disassociated with the artifact. Do not store personal data in this field.
created_artifact_name(impl Into<String>)
/set_created_artifact_name(Option<String>)
:An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)
dry_run(bool)
/set_dry_run(bool)
: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
DisassociateCreatedArtifactOutput
- On failure, responds with
SdkError<DisassociateCreatedArtifactError>
sourcepub fn disassociate_discovered_resource(&self) -> DisassociateDiscoveredResource
pub fn disassociate_discovered_resource(&self) -> DisassociateDiscoveredResource
Constructs a fluent builder for the DisassociateDiscoveredResource
operation.
- The fluent builder is configurable:
progress_update_stream(impl Into<String>)
/set_progress_update_stream(Option<String>)
:The name of the ProgressUpdateStream.
migration_task_name(impl Into<String>)
/set_migration_task_name(Option<String>)
:The identifier given to the MigrationTask. Do not store personal data in this field.
configuration_id(impl Into<String>)
/set_configuration_id(Option<String>)
:ConfigurationId of the Application Discovery Service resource to be disassociated.
dry_run(bool)
/set_dry_run(bool)
: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
DisassociateDiscoveredResourceOutput
- On failure, responds with
SdkError<DisassociateDiscoveredResourceError>
sourcepub fn import_migration_task(&self) -> ImportMigrationTask
pub fn import_migration_task(&self) -> ImportMigrationTask
Constructs a fluent builder for the ImportMigrationTask
operation.
- The fluent builder is configurable:
progress_update_stream(impl Into<String>)
/set_progress_update_stream(Option<String>)
:The name of the ProgressUpdateStream. >
migration_task_name(impl Into<String>)
/set_migration_task_name(Option<String>)
:Unique identifier that references the migration task. Do not store personal data in this field.
dry_run(bool)
/set_dry_run(bool)
: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
ImportMigrationTaskOutput
- On failure, responds with
SdkError<ImportMigrationTaskError>
sourcepub fn list_application_states(&self) -> ListApplicationStates
pub fn list_application_states(&self) -> ListApplicationStates
Constructs a fluent builder for the ListApplicationStates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_ids(Vec<String>)
/set_application_ids(Option<Vec<String>>)
:The configurationIds from the Application Discovery Service that uniquely identifies your applications.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If a
NextToken
was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token inNextToken
.max_results(i32)
/set_max_results(Option<i32>)
:Maximum number of results to be returned per page.
- On success, responds with
ListApplicationStatesOutput
with field(s):application_state_list(Option<Vec<ApplicationState>>)
:A list of Applications that exist in Application Discovery Service.
next_token(Option<String>)
:If a
NextToken
was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token inNextToken
.
- On failure, responds with
SdkError<ListApplicationStatesError>
sourcepub fn list_created_artifacts(&self) -> ListCreatedArtifacts
pub fn list_created_artifacts(&self) -> ListCreatedArtifacts
Constructs a fluent builder for the ListCreatedArtifacts
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
progress_update_stream(impl Into<String>)
/set_progress_update_stream(Option<String>)
:The name of the ProgressUpdateStream.
migration_task_name(impl Into<String>)
/set_migration_task_name(Option<String>)
:Unique identifier that references the migration task. Do not store personal data in this field.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If a
NextToken
was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token inNextToken
.max_results(i32)
/set_max_results(Option<i32>)
:Maximum number of results to be returned per page.
- On success, responds with
ListCreatedArtifactsOutput
with field(s):next_token(Option<String>)
:If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from.
created_artifact_list(Option<Vec<CreatedArtifact>>)
:List of created artifacts up to the maximum number of results specified in the request.
- On failure, responds with
SdkError<ListCreatedArtifactsError>
sourcepub fn list_discovered_resources(&self) -> ListDiscoveredResources
pub fn list_discovered_resources(&self) -> ListDiscoveredResources
Constructs a fluent builder for the ListDiscoveredResources
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
progress_update_stream(impl Into<String>)
/set_progress_update_stream(Option<String>)
:The name of the ProgressUpdateStream.
migration_task_name(impl Into<String>)
/set_migration_task_name(Option<String>)
:The name of the MigrationTask. Do not store personal data in this field.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If a
NextToken
was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token inNextToken
.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results returned per page.
- On success, responds with
ListDiscoveredResourcesOutput
with field(s):next_token(Option<String>)
:If there are more discovered resources than the max result, return the next token to be passed to the next call as a bookmark of where to start from.
discovered_resource_list(Option<Vec<DiscoveredResource>>)
:Returned list of discovered resources associated with the given MigrationTask.
- On failure, responds with
SdkError<ListDiscoveredResourcesError>
sourcepub fn list_migration_tasks(&self) -> ListMigrationTasks
pub fn list_migration_tasks(&self) -> ListMigrationTasks
Constructs a fluent builder for the ListMigrationTasks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If a
NextToken
was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token inNextToken
.max_results(i32)
/set_max_results(Option<i32>)
:Value to specify how many results are returned per page.
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:Filter migration tasks by discovered resource name.
- On success, responds with
ListMigrationTasksOutput
with field(s):next_token(Option<String>)
:If there are more migration tasks than the max result, return the next token to be passed to the next call as a bookmark of where to start from.
migration_task_summary_list(Option<Vec<MigrationTaskSummary>>)
:Lists the migration task’s summary which includes:
MigrationTaskName
,ProgressPercent
,ProgressUpdateStream
,Status
, and theUpdateDateTime
for each task.
- On failure, responds with
SdkError<ListMigrationTasksError>
sourcepub fn list_progress_update_streams(&self) -> ListProgressUpdateStreams
pub fn list_progress_update_streams(&self) -> ListProgressUpdateStreams
Constructs a fluent builder for the ListProgressUpdateStreams
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If a
NextToken
was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token inNextToken
.max_results(i32)
/set_max_results(Option<i32>)
:Filter to limit the maximum number of results to list per page.
- On success, responds with
ListProgressUpdateStreamsOutput
with field(s):progress_update_stream_summary_list(Option<Vec<ProgressUpdateStreamSummary>>)
:List of progress update streams up to the max number of results passed in the input.
next_token(Option<String>)
:If there are more streams created than the max result, return the next token to be passed to the next call as a bookmark of where to start from.
- On failure, responds with
SdkError<ListProgressUpdateStreamsError>
sourcepub fn notify_application_state(&self) -> NotifyApplicationState
pub fn notify_application_state(&self) -> NotifyApplicationState
Constructs a fluent builder for the NotifyApplicationState
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:The configurationId in Application Discovery Service that uniquely identifies the grouped application.
status(ApplicationStatus)
/set_status(Option<ApplicationStatus>)
:Status of the application - Not Started, In-Progress, Complete.
update_date_time(DateTime)
/set_update_date_time(Option<DateTime>)
:The timestamp when the application state changed.
dry_run(bool)
/set_dry_run(bool)
: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
NotifyApplicationStateOutput
- On failure, responds with
SdkError<NotifyApplicationStateError>
sourcepub fn notify_migration_task_state(&self) -> NotifyMigrationTaskState
pub fn notify_migration_task_state(&self) -> NotifyMigrationTaskState
Constructs a fluent builder for the NotifyMigrationTaskState
operation.
- The fluent builder is configurable:
progress_update_stream(impl Into<String>)
/set_progress_update_stream(Option<String>)
:The name of the ProgressUpdateStream.
migration_task_name(impl Into<String>)
/set_migration_task_name(Option<String>)
:Unique identifier that references the migration task. Do not store personal data in this field.
task(Task)
/set_task(Option<Task>)
:Information about the task’s progress and status.
update_date_time(DateTime)
/set_update_date_time(Option<DateTime>)
:The timestamp when the task was gathered.
next_update_seconds(i32)
/set_next_update_seconds(i32)
:Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale.
dry_run(bool)
/set_dry_run(bool)
: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
NotifyMigrationTaskStateOutput
- On failure, responds with
SdkError<NotifyMigrationTaskStateError>
sourcepub fn put_resource_attributes(&self) -> PutResourceAttributes
pub fn put_resource_attributes(&self) -> PutResourceAttributes
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>)
:The name of the ProgressUpdateStream.
migration_task_name(impl Into<String>)
/set_migration_task_name(Option<String>)
:Unique identifier that references the migration task. Do not store personal data in this field.
resource_attribute_list(Vec<ResourceAttribute>)
/set_resource_attribute_list(Option<Vec<ResourceAttribute>>)
: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 theType
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 thatVM_MANAGER_ID
, as a minimum, is always set. IfVM_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(bool)
: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>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more