Struct aws_sdk_migrationhubstrategy::Client

pub struct Client { /* private fields */ }

Client for Migration Hub Strategy Recommendations

Client for invoking operations on Migration Hub Strategy Recommendations. Each operation on Migration Hub Strategy Recommendations 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_migrationhubstrategy::Client::new(&config);

Occasionally, SDKs may have additional service-specific 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_migrationhubstrategy::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 GetApplicationComponentDetails operation has a Client::get_application_component_details, 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.get_application_component_details()
    .application_component_id("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 get_application_component_details( &self ) -> GetApplicationComponentDetailsFluentBuilder

Constructs a fluent builder for the GetApplicationComponentDetails operation.

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

    The ID of the application component. The ID is unique within an AWS account.

    
    
• On success, responds with GetApplicationComponentDetailsOutput with field(s):
  • application_component_detail(Option<ApplicationComponentDetail>):

    Detailed information about an application component.

  • associated_applications(Option<Vec::<AssociatedApplication>>):

    The associated application group as defined in AWS Application Discovery Service.

  • more_application_resource(Option<bool>):

    Set to true if the application component belongs to more than one application group.

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

    A list of the IDs of the servers on which the application component is running.

• On failure, responds with SdkError<GetApplicationComponentDetailsError>

impl Client

pub fn get_application_component_strategies( &self ) -> GetApplicationComponentStrategiesFluentBuilder

Constructs a fluent builder for the GetApplicationComponentStrategies operation.

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

    The ID of the application component. The ID is unique within an AWS account.

    
    
• On success, responds with GetApplicationComponentStrategiesOutput with field(s):
  • application_component_strategies(Option<Vec::<ApplicationComponentStrategy>>):

    A list of application component strategy recommendations.

• On failure, responds with SdkError<GetApplicationComponentStrategiesError>

impl Client

pub fn get_assessment(&self) -> GetAssessmentFluentBuilder

Constructs a fluent builder for the GetAssessment operation.

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

    The assessmentid returned by StartAssessment.

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

    The ID for the specific assessment task.

  • data_collection_details(Option<DataCollectionDetails>):

    Detailed information about the assessment.

  • assessment_targets(Option<Vec::<AssessmentTarget>>):

    List of criteria for assessment.

• On failure, responds with SdkError<GetAssessmentError>

impl Client

pub fn get_import_file_task(&self) -> GetImportFileTaskFluentBuilder

Constructs a fluent builder for the GetImportFileTask operation.

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

    The ID of the import file task. This ID is returned in the response of StartImportFileTask.

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

    The import file task id returned in the response of StartImportFileTask.

  • status(Option<ImportFileTaskStatus>):

    Status of import file task.

  • start_time(Option<DateTime>):

    Start time of the import task.

  • input_s3_bucket(Option<String>):

    The S3 bucket where import file is located.

  • input_s3_key(Option<String>):

    The Amazon S3 key name of the import file.

  • status_report_s3_bucket(Option<String>):

    The S3 bucket name for status report of import task.

  • status_report_s3_key(Option<String>):

    The Amazon S3 key name for status report of import task. The report contains details about whether each record imported successfully or why it did not.

  • completion_time(Option<DateTime>):

    The time that the import task completed.

  • number_of_records_success(Option<i32>):

    The number of records successfully imported.

  • number_of_records_failed(Option<i32>):

    The number of records that failed to be imported.

  • import_name(Option<String>):

    The name of the import task given in StartImportFileTask.

• On failure, responds with SdkError<GetImportFileTaskError>

impl Client

pub fn get_latest_assessment_id(&self) -> GetLatestAssessmentIdFluentBuilder

Constructs a fluent builder for the GetLatestAssessmentId operation.

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

    The latest ID for the specific assessment task.

• On failure, responds with SdkError<GetLatestAssessmentIdError>

impl Client

pub fn get_portfolio_preferences(&self) -> GetPortfolioPreferencesFluentBuilder

Constructs a fluent builder for the GetPortfolioPreferences operation.

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

    The rank of business goals based on priority.

  • application_preferences(Option<ApplicationPreferences>):

    The transformation preferences for non-database applications.

  • database_preferences(Option<DatabasePreferences>):

    The transformation preferences for database applications.

  • application_mode(Option<ApplicationMode>):

    The classification for application component types.

• On failure, responds with SdkError<GetPortfolioPreferencesError>

impl Client

pub fn get_portfolio_summary(&self) -> GetPortfolioSummaryFluentBuilder

Constructs a fluent builder for the GetPortfolioSummary operation.

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

    An assessment summary for the portfolio including the number of servers to rehost and the overall number of anti-patterns.

• On failure, responds with SdkError<GetPortfolioSummaryError>

impl Client

pub fn get_recommendation_report_details( &self ) -> GetRecommendationReportDetailsFluentBuilder

Constructs a fluent builder for the GetRecommendationReportDetails operation.

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

    The recommendation report generation task id returned by StartRecommendationReportGeneration.

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

    The ID of the recommendation report generation task. See the response of StartRecommendationReportGeneration.

  • recommendation_report_details(Option<RecommendationReportDetails>):

    Detailed information about the recommendation report.

• On failure, responds with SdkError<GetRecommendationReportDetailsError>

impl Client

pub fn get_server_details(&self) -> GetServerDetailsFluentBuilder

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

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

    The ID of the server.

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

    The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

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

    The maximum number of items to include in the response. The maximum value is 100.

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

    The token you use to retrieve the next set of results, or null if there are no more results.

  • server_detail(Option<ServerDetail>):

    Detailed information about the server.

  • associated_applications(Option<Vec::<AssociatedApplication>>):

    The associated application group the server belongs to, as defined in AWS Application Discovery Service.

• On failure, responds with SdkError<GetServerDetailsError>

impl Client

pub fn get_server_strategies(&self) -> GetServerStrategiesFluentBuilder

Constructs a fluent builder for the GetServerStrategies operation.

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

    The ID of the server.

    
    
• On success, responds with GetServerStrategiesOutput with field(s):
  • server_strategies(Option<Vec::<ServerStrategy>>):

    A list of strategy recommendations for the server.

• On failure, responds with SdkError<GetServerStrategiesError>

impl Client

pub fn list_analyzable_servers(&self) -> ListAnalyzableServersFluentBuilder

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

• The fluent builder is configurable:
  • sort(SortOrder) / set_sort(Option<SortOrder>):
    required: false
    Specifies whether to sort by ascending (ASC) or descending (DESC) order.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    The maximum number of items to include in the response. The maximum value is 100.
    
• On success, responds with ListAnalyzableServersOutput with field(s):
  • analyzable_servers(Option<Vec::<AnalyzableServerSummary>>): The list of analyzable servers with summary information about each server.
  • next_token(Option<String>): The token you use to retrieve the next set of results, or null if there are no more results.
• On failure, responds with SdkError<ListAnalyzableServersError>

impl Client

pub fn list_application_components( &self ) -> ListApplicationComponentsFluentBuilder

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

• The fluent builder is configurable:
  • application_component_criteria(ApplicationComponentCriteria) / set_application_component_criteria(Option<ApplicationComponentCriteria>):
    required: false
    

    Criteria for filtering the list of application components.

    
    
  • filter_value(impl Into<String>) / set_filter_value(Option<String>):
    required: false
    

    Specify the value based on the application component criteria type. For example, if applicationComponentCriteria is set to SERVER_ID and filterValue is set to server1, then ListApplicationComponents returns all the application components running on server1.

    
    
  • sort(SortOrder) / set_sort(Option<SortOrder>):
    required: false
    

    Specifies whether to sort by ascending (ASC) or descending (DESC) order.

    
    
  • group_id_filter(Group) / set_group_id_filter(Option<Vec::<Group>>):
    required: false
    

    The group ID specified in to filter on.

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

    The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

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

    The maximum number of items to include in the response. The maximum value is 100.

    
    
• On success, responds with ListApplicationComponentsOutput with field(s):
  • application_component_infos(Option<Vec::<ApplicationComponentDetail>>):

    The list of application components with detailed information about each component.

  • next_token(Option<String>):

    The token you use to retrieve the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListApplicationComponentsError>

impl Client

pub fn list_collectors(&self) -> ListCollectorsFluentBuilder

Constructs a fluent builder for the ListCollectors 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 token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

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

    The maximum number of items to include in the response. The maximum value is 100.

    
    
• On success, responds with ListCollectorsOutput with field(s):
  • collectors(Option<Vec::<Collector>>):

    The list of all the installed collectors.

  • next_token(Option<String>):

    The token you use to retrieve the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListCollectorsError>

impl Client

pub fn list_import_file_task(&self) -> ListImportFileTaskFluentBuilder

Constructs a fluent builder for the ListImportFileTask 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 token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

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

    The total number of items to return. The maximum value is 100.

    
    
• On success, responds with ListImportFileTaskOutput with field(s):
  • task_infos(Option<Vec::<ImportFileTaskInformation>>):

    Lists information about the files you import.

  • next_token(Option<String>):

    The token you use to retrieve the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListImportFileTaskError>

impl Client

pub fn list_servers(&self) -> ListServersFluentBuilder

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

• The fluent builder is configurable:
  • server_criteria(ServerCriteria) / set_server_criteria(Option<ServerCriteria>):
    required: false
    

    Criteria for filtering servers.

    
    
  • filter_value(impl Into<String>) / set_filter_value(Option<String>):
    required: false
    

    Specifies the filter value, which is based on the type of server criteria. For example, if serverCriteria is OS_NAME, and the filterValue is equal to WindowsServer, then ListServers returns all of the servers matching the OS name WindowsServer.

    
    
  • sort(SortOrder) / set_sort(Option<SortOrder>):
    required: false
    

    Specifies whether to sort by ascending (ASC) or descending (DESC) order.

    
    
  • group_id_filter(Group) / set_group_id_filter(Option<Vec::<Group>>):
    required: false
    

    Specifies the group ID to filter on.

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

    The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You’ll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

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

    The maximum number of items to include in the response. The maximum value is 100.

    
    
• On success, responds with ListServersOutput with field(s):
  • server_infos(Option<Vec::<ServerDetail>>):

    The list of servers with detailed information about each server.

  • next_token(Option<String>):

    The token you use to retrieve the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListServersError>

impl Client

pub fn put_portfolio_preferences(&self) -> PutPortfolioPreferencesFluentBuilder

Constructs a fluent builder for the PutPortfolioPreferences operation.

• The fluent builder is configurable:
  • prioritize_business_goals(PrioritizeBusinessGoals) / set_prioritize_business_goals(Option<PrioritizeBusinessGoals>):
    required: false
    

    The rank of the business goals based on priority.

    
    
  • application_preferences(ApplicationPreferences) / set_application_preferences(Option<ApplicationPreferences>):
    required: false
    

    The transformation preferences for non-database applications.

    
    
  • database_preferences(DatabasePreferences) / set_database_preferences(Option<DatabasePreferences>):
    required: false
    

    The transformation preferences for database applications.

    
    
  • application_mode(ApplicationMode) / set_application_mode(Option<ApplicationMode>):
    required: false
    

    The classification for application component types.

    
    
• On success, responds with PutPortfolioPreferencesOutput
• On failure, responds with SdkError<PutPortfolioPreferencesError>

impl Client

pub fn start_assessment(&self) -> StartAssessmentFluentBuilder

Constructs a fluent builder for the StartAssessment operation.

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

    The S3 bucket used by the collectors to send analysis data to the service. The bucket name must begin with migrationhub-strategy-.

    
    
  • s3bucket_for_report_data(impl Into<String>) / set_s3bucket_for_report_data(Option<String>):
    required: false
    

    The S3 bucket where all the reports generated by the service are stored. The bucket name must begin with migrationhub-strategy-.

    
    
  • assessment_targets(AssessmentTarget) / set_assessment_targets(Option<Vec::<AssessmentTarget>>):
    required: false
    

    List of criteria for assessment.

    
    
  • assessment_data_source_type(AssessmentDataSourceType) / set_assessment_data_source_type(Option<AssessmentDataSourceType>):
    required: false
    The data source type of an assessment to be started.
    
• On success, responds with StartAssessmentOutput with field(s):
  • assessment_id(Option<String>):

    The ID of the assessment.

• On failure, responds with SdkError<StartAssessmentError>

impl Client

pub fn start_import_file_task(&self) -> StartImportFileTaskFluentBuilder

Constructs a fluent builder for the StartImportFileTask operation.

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

    A descriptive name for the request.

    
    
  • s3_bucket(impl Into<String>) / set_s3_bucket(Option<String>):
    required: true
    

    The S3 bucket where the import file is located. The bucket name is required to begin with migrationhub-strategy-.

    
    
  • s3_key(impl Into<String>) / set_s3_key(Option<String>):
    required: true
    

    The Amazon S3 key name of the import file.

    
    
  • data_source_type(DataSourceType) / set_data_source_type(Option<DataSourceType>):
    required: false
    

    Specifies the source that the servers are coming from. By default, Strategy Recommendations assumes that the servers specified in the import file are available in AWS Application Discovery Service.

    
    
  • group_id(Group) / set_group_id(Option<Vec::<Group>>):
    required: false
    

    Groups the resources in the import file together with a unique name. This ID can be as filter in ListApplicationComponents and ListServers.

    
    
  • s3bucket_for_report_data(impl Into<String>) / set_s3bucket_for_report_data(Option<String>):
    required: false
    

    The S3 bucket where Strategy Recommendations uploads import results. The bucket name is required to begin with migrationhub-strategy-.

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

    The ID for a specific import task. The ID is unique within an AWS account.

• On failure, responds with SdkError<StartImportFileTaskError>

impl Client

pub fn start_recommendation_report_generation( &self ) -> StartRecommendationReportGenerationFluentBuilder

Constructs a fluent builder for the StartRecommendationReportGeneration operation.

• The fluent builder is configurable:
  • output_format(OutputFormat) / set_output_format(Option<OutputFormat>):
    required: false
    

    The output format for the recommendation report file. The default format is Microsoft Excel.

    
    
  • group_id_filter(Group) / set_group_id_filter(Option<Vec::<Group>>):
    required: false
    

    Groups the resources in the recommendation report with a unique name.

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

    The ID of the recommendation report generation task.

• On failure, responds with SdkError<StartRecommendationReportGenerationError>

impl Client

pub fn stop_assessment(&self) -> StopAssessmentFluentBuilder

Constructs a fluent builder for the StopAssessment operation.

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

    The assessmentId returned by StartAssessment.

    
    
• On success, responds with StopAssessmentOutput
• On failure, responds with SdkError<StopAssessmentError>

impl Client

pub fn update_application_component_config( &self ) -> UpdateApplicationComponentConfigFluentBuilder

Constructs a fluent builder for the UpdateApplicationComponentConfig operation.

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

    The ID of the application component. The ID is unique within an AWS account.

    
    
  • inclusion_status(InclusionStatus) / set_inclusion_status(Option<InclusionStatus>):
    required: false
    

    Indicates whether the application component has been included for server recommendation or not.

    
    
  • strategy_option(StrategyOption) / set_strategy_option(Option<StrategyOption>):
    required: false
    

    The preferred strategy options for the application component. Use values from the GetApplicationComponentStrategies response.

    
    
  • source_code_list(SourceCode) / set_source_code_list(Option<Vec::<SourceCode>>):
    required: false
    

    The list of source code configurations to update for the application component.

    
    
  • secrets_manager_key(impl Into<String>) / set_secrets_manager_key(Option<String>):
    required: false
    

    Database credentials.

    
    
  • configure_only(bool) / set_configure_only(Option<bool>):
    required: false
    

    Update the configuration request of an application component. If it is set to true, the source code and/or database credentials are updated. If it is set to false, the source code and/or database credentials are updated and an analysis is initiated.

    
    
  • app_type(AppType) / set_app_type(Option<AppType>):
    required: false
    

    The type of known component.

    
    
• On success, responds with UpdateApplicationComponentConfigOutput
• On failure, responds with SdkError<UpdateApplicationComponentConfigError>

impl Client

pub fn update_server_config(&self) -> UpdateServerConfigFluentBuilder

Constructs a fluent builder for the UpdateServerConfig operation.

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

    The ID of the server.

    
    
  • strategy_option(StrategyOption) / set_strategy_option(Option<StrategyOption>):
    required: false
    

    The preferred strategy options for the application component. See the response from GetServerStrategies.

    
    
• On success, responds with UpdateServerConfigOutput
• On failure, responds with SdkError<UpdateServerConfigError>

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.

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.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy 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.