Struct Client 

pub struct Client { /* private fields */ }

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.

Implementations

impl Client

pub fn create_template(&self) -> CreateTemplateFluentBuilder

Constructs a fluent builder for the CreateTemplate operation.

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

    The name of the migration workflow template.

    
    
  • template_description(impl Into<String>) / set_template_description(Option<String>):
    required: false
    

    A description of the migration workflow template.

    
    
  • template_source(TemplateSource) / set_template_source(Option<TemplateSource>):
    required: true
    

    The source of the migration workflow template.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Idempotency in the Smithy documentation.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to add to the migration workflow template.

    
    
• On success, responds with CreateTemplateOutput with field(s):
  • template_id(Option<String>):

    The ID of the migration workflow template.

  • template_arn(Option<String>):

    The Amazon Resource Name (ARN) of the migration workflow template. The format for an Migration Hub Orchestrator template ARN is arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

  • tags(Option<HashMap::<String, String>>):

    The tags added to the migration workflow template.

• On failure, responds with SdkError<CreateTemplateError>

impl Client

pub fn create_workflow(&self) -> CreateWorkflowFluentBuilder

Constructs a fluent builder for the CreateWorkflow operation.

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

    The name of the migration workflow.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the migration workflow.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID of the template.

    
    
  • application_configuration_id(impl Into<String>) / set_application_configuration_id(Option<String>):
    required: false
    

    The configuration ID of the application configured in Application Discovery Service.

    
    
  • input_parameters(impl Into<String>, StepInput) / set_input_parameters(Option<HashMap::<String, StepInput>>):
    required: true
    

    The input parameters required to create a migration workflow.

    
    
  • step_targets(impl Into<String>) / set_step_targets(Option<Vec::<String>>):
    required: false
    

    The servers on which a step will be run.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to add on a migration workflow.

    
    
• On success, responds with CreateWorkflowOutput with field(s):
  • id(Option<String>):

    The ID of the migration workflow.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the migration workflow.

  • name(Option<String>):

    The name of the migration workflow.

  • description(Option<String>):

    The description of the migration workflow.

  • template_id(Option<String>):

    The ID of the template.

  • ads_application_configuration_id(Option<String>):

    The configuration ID of the application configured in Application Discovery Service.

  • workflow_inputs(Option<HashMap::<String, StepInput>>):

    The inputs for creating a migration workflow.

  • step_targets(Option<Vec::<String>>):

    The servers on which a step will be run.

  • status(Option<MigrationWorkflowStatusEnum>):

    The status of the migration workflow.

  • creation_time(Option<DateTime>):

    The time at which the migration workflow was created.

  • tags(Option<HashMap::<String, String>>):

    The tags to add on a migration workflow.

• On failure, responds with SdkError<CreateWorkflowError>

impl Client

pub fn create_workflow_step(&self) -> CreateWorkflowStepFluentBuilder

Constructs a fluent builder for the CreateWorkflowStep operation.

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

    The name of the step.

    
    
  • step_group_id(impl Into<String>) / set_step_group_id(Option<String>):
    required: true
    

    The ID of the step group.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The ID of the migration workflow.

    
    
  • step_action_type(StepActionType) / set_step_action_type(Option<StepActionType>):
    required: true
    

    The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the step.

    
    
  • workflow_step_automation_configuration(WorkflowStepAutomationConfiguration) / set_workflow_step_automation_configuration(Option<WorkflowStepAutomationConfiguration>):
    required: false
    

    The custom script to run tests on source or target environments.

    
    
  • step_target(impl Into<String>) / set_step_target(Option<Vec::<String>>):
    required: false
    

    The servers on which a step will be run.

    
    
  • outputs(WorkflowStepOutput) / set_outputs(Option<Vec::<WorkflowStepOutput>>):
    required: false
    

    The key value pairs added for the expected output.

    
    
  • previous(impl Into<String>) / set_previous(Option<Vec::<String>>):
    required: false
    

    The previous step.

    
    
  • next(impl Into<String>) / set_next(Option<Vec::<String>>):
    required: false
    

    The next step.

    
    
• On success, responds with CreateWorkflowStepOutput with field(s):
  • id(Option<String>):

    The ID of the step.

  • step_group_id(Option<String>):

    The ID of the step group.

  • workflow_id(Option<String>):

    The ID of the migration workflow.

  • name(Option<String>):

    The name of the step.

• On failure, responds with SdkError<CreateWorkflowStepError>

impl Client

pub fn create_workflow_step_group(&self) -> CreateWorkflowStepGroupFluentBuilder

Constructs a fluent builder for the CreateWorkflowStepGroup operation.

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

    The ID of the migration workflow that will contain the step group.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the step group.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the step group.

    
    
  • next(impl Into<String>) / set_next(Option<Vec::<String>>):
    required: false
    

    The next step group.

    
    
  • previous(impl Into<String>) / set_previous(Option<Vec::<String>>):
    required: false
    

    The previous step group.

    
    
• On success, responds with CreateWorkflowStepGroupOutput with field(s):
  • workflow_id(Option<String>):

    The ID of the migration workflow that contains the step group.

  • name(Option<String>):

    The name of the step group.

  • id(Option<String>):

    The ID of the step group.

  • description(Option<String>):

    The description of the step group.

  • tools(Option<Vec::<Tool>>):

    List of AWS services utilized in a migration workflow.

  • next(Option<Vec::<String>>):

    The next step group.

  • previous(Option<Vec::<String>>):

    The previous step group.

  • creation_time(Option<DateTime>):

    The time at which the step group is created.

• On failure, responds with SdkError<CreateWorkflowStepGroupError>

impl Client

pub fn delete_template(&self) -> DeleteTemplateFluentBuilder

Constructs a fluent builder for the DeleteTemplate operation.

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

    The ID of the request to delete a migration workflow template.

    
    
• On success, responds with DeleteTemplateOutput
• On failure, responds with SdkError<DeleteTemplateError>

impl Client

pub fn delete_workflow(&self) -> DeleteWorkflowFluentBuilder

Constructs a fluent builder for the DeleteWorkflow operation.

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

    The ID of the migration workflow you want to delete.

    
    
• On success, responds with DeleteWorkflowOutput with field(s):
  • id(Option<String>):

    The ID of the migration workflow.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the migration workflow.

  • status(Option<MigrationWorkflowStatusEnum>):

    The status of the migration workflow.

• On failure, responds with SdkError<DeleteWorkflowError>

impl Client

pub fn delete_workflow_step(&self) -> DeleteWorkflowStepFluentBuilder

Constructs a fluent builder for the DeleteWorkflowStep operation.

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

    The ID of the step you want to delete.

    
    
  • step_group_id(impl Into<String>) / set_step_group_id(Option<String>):
    required: true
    

    The ID of the step group that contains the step you want to delete.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The ID of the migration workflow.

    
    
• On success, responds with DeleteWorkflowStepOutput
• On failure, responds with SdkError<DeleteWorkflowStepError>

impl Client

pub fn delete_workflow_step_group(&self) -> DeleteWorkflowStepGroupFluentBuilder

Constructs a fluent builder for the DeleteWorkflowStepGroup operation.

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

    The ID of the migration workflow.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the step group you want to delete.

    
    
• On success, responds with DeleteWorkflowStepGroupOutput
• On failure, responds with SdkError<DeleteWorkflowStepGroupError>

impl Client

pub fn get_template(&self) -> GetTemplateFluentBuilder

Constructs a fluent builder for the GetTemplate operation.

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

    The ID of the template.

    
    
• On success, responds with GetTemplateOutput with field(s):
  • id(Option<String>):

    The ID of the template.

  • template_arn(Option<String>):

    >The Amazon Resource Name (ARN) of the migration workflow template. The format for an Migration Hub Orchestrator template ARN is arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

  • name(Option<String>):

    The name of the template.

  • description(Option<String>):

    The time at which the template was last created.

  • inputs(Option<Vec::<TemplateInput>>):

    The inputs provided for the creation of the migration workflow.

  • tools(Option<Vec::<Tool>>):

    List of AWS services utilized in a migration workflow.

  • creation_time(Option<DateTime>):

    The time at which the template was last created.

  • owner(Option<String>):

    The owner of the migration workflow template.

  • status(Option<TemplateStatus>):

    The status of the template.

  • status_message(Option<String>):

    The status message of retrieving migration workflow templates.

  • template_class(Option<String>):

    The class of the migration workflow template. The available template classes are:

    • A2C

    • MGN

    • SAP_MULTI

    • SQL_EC2

    • SQL_RDS

    • VMIE

  • tags(Option<HashMap::<String, String>>):

    The tags added to the migration workflow template.

• On failure, responds with SdkError<GetTemplateError>

impl Client

pub fn get_template_step(&self) -> GetTemplateStepFluentBuilder

Constructs a fluent builder for the GetTemplateStep operation.

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

    The ID of the step.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID of the template.

    
    
  • step_group_id(impl Into<String>) / set_step_group_id(Option<String>):
    required: true
    

    The ID of the step group.

    
    
• On success, responds with GetTemplateStepOutput with field(s):
  • id(Option<String>):

    The ID of the step.

  • step_group_id(Option<String>):

    The ID of the step group.

  • template_id(Option<String>):

    The ID of the template.

  • name(Option<String>):

    The name of the step.

  • description(Option<String>):

    The description of the step.

  • step_action_type(Option<StepActionType>):

    The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

  • creation_time(Option<String>):

    The time at which the step was created.

  • previous(Option<Vec::<String>>):

    The previous step.

  • next(Option<Vec::<String>>):

    The next step.

  • outputs(Option<Vec::<StepOutput>>):

    The outputs of the step.

  • step_automation_configuration(Option<StepAutomationConfiguration>):

    The custom script to run tests on source or target environments.

• On failure, responds with SdkError<GetTemplateStepError>

impl Client

pub fn get_template_step_group(&self) -> GetTemplateStepGroupFluentBuilder

Constructs a fluent builder for the GetTemplateStepGroup operation.

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

    The ID of the template.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the step group.

    
    
• On success, responds with GetTemplateStepGroupOutput with field(s):
  • template_id(Option<String>):

    The ID of the template.

  • id(Option<String>):

    The ID of the step group.

  • name(Option<String>):

    The name of the step group.

  • description(Option<String>):

    The description of the step group.

  • status(Option<StepGroupStatus>):

    The status of the step group.

  • creation_time(Option<DateTime>):

    The time at which the step group was created.

  • last_modified_time(Option<DateTime>):

    The time at which the step group was last modified.

  • tools(Option<Vec::<Tool>>):

    List of AWS services utilized in a migration workflow.

  • previous(Option<Vec::<String>>):

    The previous step group.

  • next(Option<Vec::<String>>):

    The next step group.

• On failure, responds with SdkError<GetTemplateStepGroupError>

impl Client

pub fn get_workflow(&self) -> GetWorkflowFluentBuilder

Constructs a fluent builder for the GetWorkflow operation.

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

    The ID of the migration workflow.

    
    
• On success, responds with GetWorkflowOutput with field(s):
  • id(Option<String>):

    The ID of the migration workflow.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the migration workflow.

  • name(Option<String>):

    The name of the migration workflow.

  • description(Option<String>):

    The description of the migration workflow.

  • template_id(Option<String>):

    The ID of the template.

  • ads_application_configuration_id(Option<String>):

    The configuration ID of the application configured in Application Discovery Service.

  • ads_application_name(Option<String>):

    The name of the application configured in Application Discovery Service.

  • status(Option<MigrationWorkflowStatusEnum>):

    The status of the migration workflow.

  • status_message(Option<String>):

    The status message of the migration workflow.

  • creation_time(Option<DateTime>):

    The time at which the migration workflow was created.

  • last_start_time(Option<DateTime>):

    The time at which the migration workflow was last started.

  • last_stop_time(Option<DateTime>):

    The time at which the migration workflow was last stopped.

  • last_modified_time(Option<DateTime>):

    The time at which the migration workflow was last modified.

  • end_time(Option<DateTime>):

    The time at which the migration workflow ended.

  • tools(Option<Vec::<Tool>>):

    List of AWS services utilized in a migration workflow.

  • total_steps(Option<i32>):

    The total number of steps in the migration workflow.

  • completed_steps(Option<i32>):

    Get a list of completed steps in the migration workflow.

  • workflow_inputs(Option<HashMap::<String, StepInput>>):

    The inputs required for creating the migration workflow.

  • tags(Option<HashMap::<String, String>>):

    The tags added to the migration workflow.

  • workflow_bucket(Option<String>):

    The Amazon S3 bucket where the migration logs are stored.

• On failure, responds with SdkError<GetWorkflowError>

impl Client

pub fn get_workflow_step(&self) -> GetWorkflowStepFluentBuilder

Constructs a fluent builder for the GetWorkflowStep operation.

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

    The ID of the migration workflow.

    
    
  • step_group_id(impl Into<String>) / set_step_group_id(Option<String>):
    required: true
    

    The ID of the step group.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the step.

    
    
• On success, responds with GetWorkflowStepOutput with field(s):
  • name(Option<String>):

    The name of the step.

  • step_group_id(Option<String>):

    The ID of the step group.

  • workflow_id(Option<String>):

    The ID of the migration workflow.

  • step_id(Option<String>):

    The ID of the step.

  • description(Option<String>):

    The description of the step.

  • step_action_type(Option<StepActionType>):

    The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

  • owner(Option<Owner>):

    The owner of the step.

  • workflow_step_automation_configuration(Option<WorkflowStepAutomationConfiguration>):

    The custom script to run tests on source or target environments.

  • step_target(Option<Vec::<String>>):

    The servers on which a step will be run.

  • outputs(Option<Vec::<WorkflowStepOutput>>):

    The outputs of the step.

  • previous(Option<Vec::<String>>):

    The previous step.

  • next(Option<Vec::<String>>):

    The next step.

  • status(Option<StepStatus>):

    The status of the step.

  • status_message(Option<String>):

    The status message of the migration workflow.

  • script_output_location(Option<String>):

    The output location of the script.

  • creation_time(Option<DateTime>):

    The time at which the step was created.

  • last_start_time(Option<DateTime>):

    The time at which the workflow was last started.

  • end_time(Option<DateTime>):

    The time at which the step ended.

  • no_of_srv_completed(Option<i32>):

    The number of servers that have been migrated.

  • no_of_srv_failed(Option<i32>):

    The number of servers that have failed to migrate.

  • total_no_of_srv(Option<i32>):

    The total number of servers that have been migrated.

• On failure, responds with SdkError<GetWorkflowStepError>

impl Client

pub fn get_workflow_step_group(&self) -> GetWorkflowStepGroupFluentBuilder

Constructs a fluent builder for the GetWorkflowStepGroup operation.

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

    The ID of the step group.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The ID of the migration workflow.

    
    
• On success, responds with GetWorkflowStepGroupOutput with field(s):
  • id(Option<String>):

    The ID of the step group.

  • workflow_id(Option<String>):

    The ID of the migration workflow.

  • name(Option<String>):

    The name of the step group.

  • description(Option<String>):

    The description of the step group.

  • status(Option<StepGroupStatus>):

    The status of the step group.

  • owner(Option<Owner>):

    The owner of the step group.

  • creation_time(Option<DateTime>):

    The time at which the step group was created.

  • last_modified_time(Option<DateTime>):

    The time at which the step group was last modified.

  • end_time(Option<DateTime>):

    The time at which the step group ended.

  • tools(Option<Vec::<Tool>>):

    List of AWS services utilized in a migration workflow.

  • previous(Option<Vec::<String>>):

    The previous step group.

  • next(Option<Vec::<String>>):

    The next step group.

• On failure, responds with SdkError<GetWorkflowStepGroupError>

impl Client

pub fn list_plugins(&self) -> ListPluginsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of plugins that can be returned.

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

    The pagination token.

    
    
• On success, responds with ListPluginsOutput with field(s):
  • next_token(Option<String>):

    The pagination token.

  • plugins(Option<Vec::<PluginSummary>>):

    Migration Hub Orchestrator plugins.

• On failure, responds with SdkError<ListPluginsError>

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
    

    The Amazon Resource Name (ARN) of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags added to a resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_template_step_groups(&self) -> ListTemplateStepGroupsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results that can be returned.

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

    The pagination token.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID of the template.

    
    
• On success, responds with ListTemplateStepGroupsOutput with field(s):
  • next_token(Option<String>):

    The pagination token.

  • template_step_group_summary(Vec::<TemplateStepGroupSummary>):

    The summary of the step group in the template.

• On failure, responds with SdkError<ListTemplateStepGroupsError>

impl Client

pub fn list_template_steps(&self) -> ListTemplateStepsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results that can be returned.

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

    The pagination token.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    The ID of the template.

    
    
  • step_group_id(impl Into<String>) / set_step_group_id(Option<String>):
    required: true
    

    The ID of the step group.

    
    
• On success, responds with ListTemplateStepsOutput with field(s):
  • next_token(Option<String>):

    The pagination token.

  • template_step_summary_list(Option<Vec::<TemplateStepSummary>>):

    The list of summaries of steps in a template.

• On failure, responds with SdkError<ListTemplateStepsError>

impl Client

pub fn list_templates(&self) -> ListTemplatesFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results that can be returned.

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

    The pagination token.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the template.

    
    
• On success, responds with ListTemplatesOutput with field(s):
  • next_token(Option<String>):

    The pagination token.

  • template_summary(Vec::<TemplateSummary>):

    The summary of the template.

• On failure, responds with SdkError<ListTemplatesError>

impl Client

pub fn list_workflow_step_groups(&self) -> ListWorkflowStepGroupsFluentBuilder

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

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

    The pagination token.

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

    The maximum number of results that can be returned.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The ID of the migration workflow.

    
    
• On success, responds with ListWorkflowStepGroupsOutput with field(s):
  • next_token(Option<String>):

    The pagination token.

  • workflow_step_groups_summary(Vec::<WorkflowStepGroupSummary>):

    The summary of step groups in a migration workflow.

• On failure, responds with SdkError<ListWorkflowStepGroupsError>

impl Client

pub fn list_workflow_steps(&self) -> ListWorkflowStepsFluentBuilder

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

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

    The pagination token.

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

    The maximum number of results that can be returned.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The ID of the migration workflow.

    
    
  • step_group_id(impl Into<String>) / set_step_group_id(Option<String>):
    required: true
    

    The ID of the step group.

    
    
• On success, responds with ListWorkflowStepsOutput with field(s):
  • next_token(Option<String>):

    The pagination token.

  • workflow_steps_summary(Vec::<WorkflowStepSummary>):

    The summary of steps in a migration workflow.

• On failure, responds with SdkError<ListWorkflowStepsError>

impl Client

pub fn list_workflows(&self) -> ListWorkflowsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results that can be returned.

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

    The pagination token.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: false
    

    The ID of the template.

    
    
  • ads_application_configuration_name(impl Into<String>) / set_ads_application_configuration_name(Option<String>):
    required: false
    

    The name of the application configured in Application Discovery Service.

    
    
  • status(MigrationWorkflowStatusEnum) / set_status(Option<MigrationWorkflowStatusEnum>):
    required: false
    

    The status of the migration workflow.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the migration workflow.

    
    
• On success, responds with ListWorkflowsOutput with field(s):
  • next_token(Option<String>):

    The pagination token.

  • migration_workflow_summary(Vec::<MigrationWorkflowSummary>):

    The summary of the migration workflow.

• On failure, responds with SdkError<ListWorkflowsError>

impl Client

pub fn retry_workflow_step(&self) -> RetryWorkflowStepFluentBuilder

Constructs a fluent builder for the RetryWorkflowStep operation.

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

    The ID of the migration workflow.

    
    
  • step_group_id(impl Into<String>) / set_step_group_id(Option<String>):
    required: true
    

    The ID of the step group.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the step.

    
    
• On success, responds with RetryWorkflowStepOutput with field(s):
  • step_group_id(Option<String>):

    The ID of the step group.

  • workflow_id(Option<String>):

    The ID of the migration workflow.

  • id(Option<String>):

    The ID of the step.

  • status(Option<StepStatus>):

    The status of the step.

• On failure, responds with SdkError<RetryWorkflowStepError>

impl Client

pub fn start_workflow(&self) -> StartWorkflowFluentBuilder

Constructs a fluent builder for the StartWorkflow operation.

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

    The ID of the migration workflow.

    
    
• On success, responds with StartWorkflowOutput with field(s):
  • id(Option<String>):

    The ID of the migration workflow.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the migration workflow.

  • status(Option<MigrationWorkflowStatusEnum>):

    The status of the migration workflow.

  • status_message(Option<String>):

    The status message of the migration workflow.

  • last_start_time(Option<DateTime>):

    The time at which the migration workflow was last started.

• On failure, responds with SdkError<StartWorkflowError>

impl Client

pub fn stop_workflow(&self) -> StopWorkflowFluentBuilder

Constructs a fluent builder for the StopWorkflow operation.

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

    The ID of the migration workflow.

    
    
• On success, responds with StopWorkflowOutput with field(s):
  • id(Option<String>):

    The ID of the migration workflow.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the migration workflow.

  • status(Option<MigrationWorkflowStatusEnum>):

    The status of the migration workflow.

  • status_message(Option<String>):

    The status message of the migration workflow.

  • last_stop_time(Option<DateTime>):

    The time at which the migration workflow was stopped.

• On failure, responds with SdkError<StopWorkflowError>

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
    

    The Amazon Resource Name (ARN) of the resource to which you want to add tags.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    A collection of labels, in the form of key:value pairs, that apply to this resource.

    
    
• 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
    

    The Amazon Resource Name (ARN) of the resource from which you want to remove tags.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    One or more tag keys. Specify only the tag keys, not the tag values.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_template(&self) -> UpdateTemplateFluentBuilder

Constructs a fluent builder for the UpdateTemplate operation.

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

    The ID of the request to update a migration workflow template.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: false
    

    The name of the migration workflow template to update.

    
    
  • template_description(impl Into<String>) / set_template_description(Option<String>):
    required: false
    

    The description of the migration workflow template to update.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with UpdateTemplateOutput with field(s):
  • template_id(Option<String>):

    The ID of the migration workflow template being updated.

  • template_arn(Option<String>):

    The ARN of the migration workflow template being updated. The format for an Migration Hub Orchestrator template ARN is arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

  • tags(Option<HashMap::<String, String>>):

    The tags added to the migration workflow template.

• On failure, responds with SdkError<UpdateTemplateError>

impl Client

pub fn update_workflow(&self) -> UpdateWorkflowFluentBuilder

Constructs a fluent builder for the UpdateWorkflow operation.

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

    The ID of the migration workflow.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the migration workflow.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the migration workflow.

    
    
  • input_parameters(impl Into<String>, StepInput) / set_input_parameters(Option<HashMap::<String, StepInput>>):
    required: false
    

    The input parameters required to update a migration workflow.

    
    
  • step_targets(impl Into<String>) / set_step_targets(Option<Vec::<String>>):
    required: false
    

    The servers on which a step will be run.

    
    
• On success, responds with UpdateWorkflowOutput with field(s):
  • id(Option<String>):

    The ID of the migration workflow.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the migration workflow.

  • name(Option<String>):

    The name of the migration workflow.

  • description(Option<String>):

    The description of the migration workflow.

  • template_id(Option<String>):

    The ID of the template.

  • ads_application_configuration_id(Option<String>):

    The ID of the application configured in Application Discovery Service.

  • workflow_inputs(Option<HashMap::<String, StepInput>>):

    The inputs required to update a migration workflow.

  • step_targets(Option<Vec::<String>>):

    The servers on which a step will be run.

  • status(Option<MigrationWorkflowStatusEnum>):

    The status of the migration workflow.

  • creation_time(Option<DateTime>):

    The time at which the migration workflow was created.

  • last_modified_time(Option<DateTime>):

    The time at which the migration workflow was last modified.

  • tags(Option<HashMap::<String, String>>):

    The tags added to the migration workflow.

• On failure, responds with SdkError<UpdateWorkflowError>

impl Client

pub fn update_workflow_step(&self) -> UpdateWorkflowStepFluentBuilder

Constructs a fluent builder for the UpdateWorkflowStep operation.

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

    The ID of the step.

    
    
  • step_group_id(impl Into<String>) / set_step_group_id(Option<String>):
    required: true
    

    The ID of the step group.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The ID of the migration workflow.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the step.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the step.

    
    
  • step_action_type(StepActionType) / set_step_action_type(Option<StepActionType>):
    required: false
    

    The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

    
    
  • workflow_step_automation_configuration(WorkflowStepAutomationConfiguration) / set_workflow_step_automation_configuration(Option<WorkflowStepAutomationConfiguration>):
    required: false
    

    The custom script to run tests on the source and target environments.

    
    
  • step_target(impl Into<String>) / set_step_target(Option<Vec::<String>>):
    required: false
    

    The servers on which a step will be run.

    
    
  • outputs(WorkflowStepOutput) / set_outputs(Option<Vec::<WorkflowStepOutput>>):
    required: false
    

    The outputs of a step.

    
    
  • previous(impl Into<String>) / set_previous(Option<Vec::<String>>):
    required: false
    

    The previous step.

    
    
  • next(impl Into<String>) / set_next(Option<Vec::<String>>):
    required: false
    

    The next step.

    
    
  • status(StepStatus) / set_status(Option<StepStatus>):
    required: false
    

    The status of the step.

    
    
• On success, responds with UpdateWorkflowStepOutput with field(s):
  • id(Option<String>):

    The ID of the step.

  • step_group_id(Option<String>):

    The ID of the step group.

  • workflow_id(Option<String>):

    The ID of the migration workflow.

  • name(Option<String>):

    The name of the step.

• On failure, responds with SdkError<UpdateWorkflowStepError>

impl Client

pub fn update_workflow_step_group(&self) -> UpdateWorkflowStepGroupFluentBuilder

Constructs a fluent builder for the UpdateWorkflowStepGroup operation.

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

    The ID of the migration workflow.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the step group.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the step group.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the step group.

    
    
  • next(impl Into<String>) / set_next(Option<Vec::<String>>):
    required: false
    

    The next step group.

    
    
  • previous(impl Into<String>) / set_previous(Option<Vec::<String>>):
    required: false
    

    The previous step group.

    
    
• On success, responds with UpdateWorkflowStepGroupOutput with field(s):
  • workflow_id(Option<String>):

    The ID of the migration workflow.

  • name(Option<String>):

    The name of the step group.

  • id(Option<String>):

    The ID of the step group.

  • description(Option<String>):

    The description of the step group.

  • tools(Option<Vec::<Tool>>):

    List of AWS services utilized in a migration workflow.

  • next(Option<Vec::<String>>):

    The next step group.

  • previous(Option<Vec::<String>>):

    The previous step group.

  • last_modified_time(Option<DateTime>):

    The time at which the step group was last modified.

• On failure, responds with SdkError<UpdateWorkflowStepGroupError>

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.