Class: Aws::MigrationHubOrchestrator::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb

Overview

An API client for MigrationHubOrchestrator. To construct a client, you need to configure a :region and :credentials.

client = Aws::MigrationHubOrchestrator::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::MigrationHubOrchestrator::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::MigrationHubOrchestrator::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#create_template(params = {}) ⇒ Types::CreateTemplateResponse

Creates a migration workflow template.

Examples:

Request syntax with placeholder values


resp = client.create_template({
  template_name: "CreateTemplateRequestTemplateNameString", # required
  template_description: "CreateTemplateRequestTemplateDescriptionString",
  template_source: { # required
    workflow_id: "MigrationWorkflowId",
  },
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.template_id #=> String
resp.template_arn #=> String
resp.tags #=> Hash
resp.tags["StringMapKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the migration workflow template.

  • :template_description (String) —

    A description of the migration workflow template.

  • :template_source (required, Types::TemplateSource) —

    The source of the migration workflow template.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    The tags to add to the migration workflow template.

Returns:

See Also:



536
537
538
539
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 536

def create_template(params = {}, options = {})
  req = build_request(:create_template, params)
  req.send_request(options)
end

#create_workflow(params = {}) ⇒ Types::CreateMigrationWorkflowResponse

Create a workflow to orchestrate your migrations.

Examples:

Request syntax with placeholder values


resp = client.create_workflow({
  name: "CreateMigrationWorkflowRequestNameString", # required
  description: "CreateMigrationWorkflowRequestDescriptionString",
  template_id: "CreateMigrationWorkflowRequestTemplateIdString", # required
  application_configuration_id: "CreateMigrationWorkflowRequestApplicationConfigurationIdString",
  input_parameters: { # required
    "StepInputParametersKey" => {
      integer_value: 1,
      string_value: "StringValue",
      list_of_strings_value: ["StringListMember"],
      map_of_string_value: {
        "StringMapKey" => "StringMapValue",
      },
    },
  },
  step_targets: ["StringListMember"],
  tags: {
    "StringMapKey" => "StringMapValue",
  },
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.template_id #=> String
resp.ads_application_configuration_id #=> String
resp.workflow_inputs #=> Hash
resp.workflow_inputs["StepInputParametersKey"].integer_value #=> Integer
resp.workflow_inputs["StepInputParametersKey"].string_value #=> String
resp.workflow_inputs["StepInputParametersKey"].list_of_strings_value #=> Array
resp.workflow_inputs["StepInputParametersKey"].list_of_strings_value[0] #=> String
resp.workflow_inputs["StepInputParametersKey"].map_of_string_value #=> Hash
resp.workflow_inputs["StepInputParametersKey"].map_of_string_value["StringMapKey"] #=> String
resp.step_targets #=> Array
resp.step_targets[0] #=> String
resp.status #=> String, one of "CREATING", "NOT_STARTED", "CREATION_FAILED", "STARTING", "IN_PROGRESS", "WORKFLOW_FAILED", "PAUSED", "PAUSING", "PAUSING_FAILED", "USER_ATTENTION_REQUIRED", "DELETING", "DELETION_FAILED", "DELETED", "COMPLETED"
resp.creation_time #=> Time
resp.tags #=> Hash
resp.tags["StringMapKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the migration workflow.

  • :description (String) —

    The description of the migration workflow.

  • :template_id (required, String) —

    The ID of the template.

  • :application_configuration_id (String) —

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

  • :input_parameters (required, Hash<String,Types::StepInput>) —

    The input parameters required to create a migration workflow.

  • :step_targets (Array<String>) —

    The servers on which a step will be run.

  • :tags (Hash<String,String>) —

    The tags to add on a migration workflow.

Returns:

See Also:



628
629
630
631
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 628

def create_workflow(params = {}, options = {})
  req = build_request(:create_workflow, params)
  req.send_request(options)
end

#create_workflow_step(params = {}) ⇒ Types::CreateWorkflowStepResponse

Create a step in the migration workflow.

Examples:

Request syntax with placeholder values


resp = client.create_workflow_step({
  name: "MigrationWorkflowName", # required
  step_group_id: "StepGroupId", # required
  workflow_id: "MigrationWorkflowId", # required
  step_action_type: "MANUAL", # required, accepts MANUAL, AUTOMATED
  description: "MigrationWorkflowDescription",
  workflow_step_automation_configuration: {
    script_location_s3_bucket: "S3Bucket",
    script_location_s3_key: {
      linux: "S3Key",
      windows: "S3Key",
    },
    command: {
      linux: "String",
      windows: "String",
    },
    run_environment: "AWS", # accepts AWS, ONPREMISE
    target_type: "SINGLE", # accepts SINGLE, ALL, NONE
  },
  step_target: ["StringListMember"],
  outputs: [
    {
      name: "WorkflowStepOutputName",
      data_type: "STRING", # accepts STRING, INTEGER, STRINGLIST, STRINGMAP
      required: false,
      value: {
        integer_value: 1,
        string_value: "MaxStringValue",
        list_of_string_value: ["MaxStringValue"],
      },
    },
  ],
  previous: ["StringListMember"],
  next: ["StringListMember"],
})

Response structure


resp.id #=> String
resp.step_group_id #=> String
resp.workflow_id #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the step.

  • :step_group_id (required, String) —

    The ID of the step group.

  • :workflow_id (required, String) —

    The ID of the migration workflow.

  • :step_action_type (required, String) —

    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 (String) —

    The description of the step.

  • :workflow_step_automation_configuration (Types::WorkflowStepAutomationConfiguration) —

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

  • :step_target (Array<String>) —

    The servers on which a step will be run.

  • :outputs (Array<Types::WorkflowStepOutput>) —

    The key value pairs added for the expected output.

  • :previous (Array<String>) —

    The previous step.

  • :next (Array<String>) —

    The next step.

Returns:

See Also:



723
724
725
726
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 723

def create_workflow_step(params = {}, options = {})
  req = build_request(:create_workflow_step, params)
  req.send_request(options)
end

#create_workflow_step_group(params = {}) ⇒ Types::CreateWorkflowStepGroupResponse

Create a step group in a migration workflow.

Examples:

Request syntax with placeholder values


resp = client.create_workflow_step_group({
  workflow_id: "MigrationWorkflowId", # required
  name: "StepGroupName", # required
  description: "StepGroupDescription",
  next: ["StringListMember"],
  previous: ["StringListMember"],
})

Response structure


resp.workflow_id #=> String
resp.name #=> String
resp.id #=> String
resp.description #=> String
resp.tools #=> Array
resp.tools[0].name #=> String
resp.tools[0].url #=> String
resp.next #=> Array
resp.next[0] #=> String
resp.previous #=> Array
resp.previous[0] #=> String
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_id (required, String) —

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

  • :name (required, String) —

    The name of the step group.

  • :description (String) —

    The description of the step group.

  • :next (Array<String>) —

    The next step group.

  • :previous (Array<String>) —

    The previous step group.

Returns:

See Also:



785
786
787
788
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 785

def create_workflow_step_group(params = {}, options = {})
  req = build_request(:create_workflow_step_group, params)
  req.send_request(options)
end

#delete_template(params = {}) ⇒ Struct

Deletes a migration workflow template.

Examples:

Request syntax with placeholder values


resp = client.delete_template({
  id: "TemplateId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



807
808
809
810
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 807

def delete_template(params = {}, options = {})
  req = build_request(:delete_template, params)
  req.send_request(options)
end

#delete_workflow(params = {}) ⇒ Types::DeleteMigrationWorkflowResponse

Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.

Examples:

Request syntax with placeholder values


resp = client.delete_workflow({
  id: "MigrationWorkflowId", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "NOT_STARTED", "CREATION_FAILED", "STARTING", "IN_PROGRESS", "WORKFLOW_FAILED", "PAUSED", "PAUSING", "PAUSING_FAILED", "USER_ATTENTION_REQUIRED", "DELETING", "DELETION_FAILED", "DELETED", "COMPLETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the migration workflow you want to delete.

Returns:

See Also:



840
841
842
843
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 840

def delete_workflow(params = {}, options = {})
  req = build_request(:delete_workflow, params)
  req.send_request(options)
end

#delete_workflow_step(params = {}) ⇒ Struct

Delete a step in a migration workflow. Pause the workflow to delete a running step.

Examples:

Request syntax with placeholder values


resp = client.delete_workflow_step({
  id: "StepId", # required
  step_group_id: "StepGroupId", # required
  workflow_id: "MigrationWorkflowId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the step you want to delete.

  • :step_group_id (required, String) —

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

  • :workflow_id (required, String) —

    The ID of the migration workflow.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



871
872
873
874
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 871

def delete_workflow_step(params = {}, options = {})
  req = build_request(:delete_workflow_step, params)
  req.send_request(options)
end

#delete_workflow_step_group(params = {}) ⇒ Struct

Delete a step group in a migration workflow.

Examples:

Request syntax with placeholder values


resp = client.delete_workflow_step_group({
  workflow_id: "MigrationWorkflowId", # required
  id: "StepGroupId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_id (required, String) —

    The ID of the migration workflow.

  • :id (required, String) —

    The ID of the step group you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



897
898
899
900
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 897

def delete_workflow_step_group(params = {}, options = {})
  req = build_request(:delete_workflow_step_group, params)
  req.send_request(options)
end

#get_template(params = {}) ⇒ Types::GetMigrationWorkflowTemplateResponse

Get the template you want to use for creating a migration workflow.

Examples:

Request syntax with placeholder values


resp = client.get_template({
  id: "TemplateId", # required
})

Response structure


resp.id #=> String
resp.template_arn #=> String
resp.name #=> String
resp.description #=> String
resp.inputs #=> Array
resp.inputs[0].input_name #=> String
resp.inputs[0].data_type #=> String, one of "STRING", "INTEGER", "STRINGLIST", "STRINGMAP"
resp.inputs[0].required #=> Boolean
resp.tools #=> Array
resp.tools[0].name #=> String
resp.tools[0].url #=> String
resp.creation_time #=> Time
resp.owner #=> String
resp.status #=> String, one of "CREATED", "READY", "PENDING_CREATION", "CREATING", "CREATION_FAILED"
resp.status_message #=> String
resp.template_class #=> String
resp.tags #=> Hash
resp.tags["StringMapKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the template.

Returns:

See Also:



953
954
955
956
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 953

def get_template(params = {}, options = {})
  req = build_request(:get_template, params)
  req.send_request(options)
end

#get_template_step(params = {}) ⇒ Types::GetTemplateStepResponse

Get a specific step in a template.

Examples:

Request syntax with placeholder values


resp = client.get_template_step({
  id: "StepId", # required
  template_id: "TemplateId", # required
  step_group_id: "StepGroupId", # required
})

Response structure


resp.id #=> String
resp.step_group_id #=> String
resp.template_id #=> String
resp.name #=> String
resp.description #=> String
resp.step_action_type #=> String, one of "MANUAL", "AUTOMATED"
resp.creation_time #=> String
resp.previous #=> Array
resp.previous[0] #=> String
resp.next #=> Array
resp.next[0] #=> String
resp.outputs #=> Array
resp.outputs[0].name #=> String
resp.outputs[0].data_type #=> String, one of "STRING", "INTEGER", "STRINGLIST", "STRINGMAP"
resp.outputs[0].required #=> Boolean
resp.step_automation_configuration.script_location_s3_bucket #=> String
resp.step_automation_configuration.script_location_s3_key.linux #=> String
resp.step_automation_configuration.script_location_s3_key.windows #=> String
resp.step_automation_configuration.command.linux #=> String
resp.step_automation_configuration.command.windows #=> String
resp.step_automation_configuration.run_environment #=> String, one of "AWS", "ONPREMISE"
resp.step_automation_configuration.target_type #=> String, one of "SINGLE", "ALL", "NONE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the step.

  • :template_id (required, String) —

    The ID of the template.

  • :step_group_id (required, String) —

    The ID of the step group.

Returns:

See Also:



1020
1021
1022
1023
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1020

def get_template_step(params = {}, options = {})
  req = build_request(:get_template_step, params)
  req.send_request(options)
end

#get_template_step_group(params = {}) ⇒ Types::GetTemplateStepGroupResponse

Get a step group in a template.

Examples:

Request syntax with placeholder values


resp = client.get_template_step_group({
  template_id: "TemplateId", # required
  id: "StepGroupId", # required
})

Response structure


resp.template_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "AWAITING_DEPENDENCIES", "READY", "IN_PROGRESS", "COMPLETED", "FAILED", "PAUSED", "PAUSING", "USER_ATTENTION_REQUIRED"
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.tools #=> Array
resp.tools[0].name #=> String
resp.tools[0].url #=> String
resp.previous #=> Array
resp.previous[0] #=> String
resp.next #=> Array
resp.next[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_id (required, String) —

    The ID of the template.

  • :id (required, String) —

    The ID of the step group.

Returns:

See Also:



1074
1075
1076
1077
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1074

def get_template_step_group(params = {}, options = {})
  req = build_request(:get_template_step_group, params)
  req.send_request(options)
end

#get_workflow(params = {}) ⇒ Types::GetMigrationWorkflowResponse

Get migration workflow.

Examples:

Request syntax with placeholder values


resp = client.get_workflow({
  id: "MigrationWorkflowId", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.template_id #=> String
resp.ads_application_configuration_id #=> String
resp.ads_application_name #=> String
resp.status #=> String, one of "CREATING", "NOT_STARTED", "CREATION_FAILED", "STARTING", "IN_PROGRESS", "WORKFLOW_FAILED", "PAUSED", "PAUSING", "PAUSING_FAILED", "USER_ATTENTION_REQUIRED", "DELETING", "DELETION_FAILED", "DELETED", "COMPLETED"
resp.status_message #=> String
resp.creation_time #=> Time
resp.last_start_time #=> Time
resp.last_stop_time #=> Time
resp.last_modified_time #=> Time
resp.end_time #=> Time
resp.tools #=> Array
resp.tools[0].name #=> String
resp.tools[0].url #=> String
resp.total_steps #=> Integer
resp.completed_steps #=> Integer
resp.workflow_inputs #=> Hash
resp.workflow_inputs["StepInputParametersKey"].integer_value #=> Integer
resp.workflow_inputs["StepInputParametersKey"].string_value #=> String
resp.workflow_inputs["StepInputParametersKey"].list_of_strings_value #=> Array
resp.workflow_inputs["StepInputParametersKey"].list_of_strings_value[0] #=> String
resp.workflow_inputs["StepInputParametersKey"].map_of_string_value #=> Hash
resp.workflow_inputs["StepInputParametersKey"].map_of_string_value["StringMapKey"] #=> String
resp.tags #=> Hash
resp.tags["StringMapKey"] #=> String
resp.workflow_bucket #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the migration workflow.

Returns:

See Also:



1149
1150
1151
1152
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1149

def get_workflow(params = {}, options = {})
  req = build_request(:get_workflow, params)
  req.send_request(options)
end

#get_workflow_step(params = {}) ⇒ Types::GetWorkflowStepResponse

Get a step in the migration workflow.

Examples:

Request syntax with placeholder values


resp = client.get_workflow_step({
  workflow_id: "MigrationWorkflowId", # required
  step_group_id: "StepGroupId", # required
  id: "StepId", # required
})

Response structure


resp.name #=> String
resp.step_group_id #=> String
resp.workflow_id #=> String
resp.step_id #=> String
resp.description #=> String
resp.step_action_type #=> String, one of "MANUAL", "AUTOMATED"
resp.owner #=> String, one of "AWS_MANAGED", "CUSTOM"
resp.workflow_step_automation_configuration.script_location_s3_bucket #=> String
resp.workflow_step_automation_configuration.script_location_s3_key.linux #=> String
resp.workflow_step_automation_configuration.script_location_s3_key.windows #=> String
resp.workflow_step_automation_configuration.command.linux #=> String
resp.workflow_step_automation_configuration.command.windows #=> String
resp.workflow_step_automation_configuration.run_environment #=> String, one of "AWS", "ONPREMISE"
resp.workflow_step_automation_configuration.target_type #=> String, one of "SINGLE", "ALL", "NONE"
resp.step_target #=> Array
resp.step_target[0] #=> String
resp.outputs #=> Array
resp.outputs[0].name #=> String
resp.outputs[0].data_type #=> String, one of "STRING", "INTEGER", "STRINGLIST", "STRINGMAP"
resp.outputs[0].required #=> Boolean
resp.outputs[0].value.integer_value #=> Integer
resp.outputs[0].value.string_value #=> String
resp.outputs[0].value.list_of_string_value #=> Array
resp.outputs[0].value.list_of_string_value[0] #=> String
resp.previous #=> Array
resp.previous[0] #=> String
resp.next #=> Array
resp.next[0] #=> String
resp.status #=> String, one of "AWAITING_DEPENDENCIES", "SKIPPED", "READY", "IN_PROGRESS", "COMPLETED", "FAILED", "PAUSED", "USER_ATTENTION_REQUIRED"
resp.status_message #=> String
resp.script_output_location #=> String
resp.creation_time #=> Time
resp.last_start_time #=> Time
resp.end_time #=> Time
resp.no_of_srv_completed #=> Integer
resp.no_of_srv_failed #=> Integer
resp.total_no_of_srv #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_id (required, String) —

    The ID of the migration workflow.

  • :step_group_id (required, String) —

    The ID of the step group.

  • :id (required, String) —

    The ID of the step.

Returns:

See Also:



1241
1242
1243
1244
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1241

def get_workflow_step(params = {}, options = {})
  req = build_request(:get_workflow_step, params)
  req.send_request(options)
end

#get_workflow_step_group(params = {}) ⇒ Types::GetWorkflowStepGroupResponse

Get the step group of a migration workflow.

Examples:

Request syntax with placeholder values


resp = client.get_workflow_step_group({
  id: "StepGroupId", # required
  workflow_id: "MigrationWorkflowId", # required
})

Response structure


resp.id #=> String
resp.workflow_id #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "AWAITING_DEPENDENCIES", "READY", "IN_PROGRESS", "COMPLETED", "FAILED", "PAUSED", "PAUSING", "USER_ATTENTION_REQUIRED"
resp.owner #=> String, one of "AWS_MANAGED", "CUSTOM"
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.end_time #=> Time
resp.tools #=> Array
resp.tools[0].name #=> String
resp.tools[0].url #=> String
resp.previous #=> Array
resp.previous[0] #=> String
resp.next #=> Array
resp.next[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the step group.

  • :workflow_id (required, String) —

    The ID of the migration workflow.

Returns:

See Also:



1299
1300
1301
1302
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1299

def get_workflow_step_group(params = {}, options = {})
  req = build_request(:get_workflow_step_group, params)
  req.send_request(options)
end

#list_plugins(params = {}) ⇒ Types::ListPluginsResponse

List AWS Migration Hub Orchestrator plugins.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_plugins({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.plugins #=> Array
resp.plugins[0].plugin_id #=> String
resp.plugins[0].hostname #=> String
resp.plugins[0].status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.plugins[0].ip_address #=> String
resp.plugins[0].version #=> String
resp.plugins[0].registered_time #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of plugins that can be returned.

  • :next_token (String) —

    The pagination token.

Returns:

See Also:



1341
1342
1343
1344
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1341

def list_plugins(params = {}, options = {})
  req = build_request(:list_plugins, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

List the tags added to a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



1370
1371
1372
1373
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1370

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_template_step_groups(params = {}) ⇒ Types::ListTemplateStepGroupsResponse

List the step groups in a template.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_template_step_groups({
  max_results: 1,
  next_token: "NextToken",
  template_id: "TemplateId", # required
})

Response structure


resp.next_token #=> String
resp.template_step_group_summary #=> Array
resp.template_step_group_summary[0].id #=> String
resp.template_step_group_summary[0].name #=> String
resp.template_step_group_summary[0].previous #=> Array
resp.template_step_group_summary[0].previous[0] #=> String
resp.template_step_group_summary[0].next #=> Array
resp.template_step_group_summary[0].next[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results that can be returned.

  • :next_token (String) —

    The pagination token.

  • :template_id (required, String) —

    The ID of the template.

Returns:

See Also:



1416
1417
1418
1419
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1416

def list_template_step_groups(params = {}, options = {})
  req = build_request(:list_template_step_groups, params)
  req.send_request(options)
end

#list_template_steps(params = {}) ⇒ Types::ListTemplateStepsResponse

List the steps in a template.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_template_steps({
  max_results: 1,
  next_token: "NextToken",
  template_id: "TemplateId", # required
  step_group_id: "StepGroupId", # required
})

Response structure


resp.next_token #=> String
resp.template_step_summary_list #=> Array
resp.template_step_summary_list[0].id #=> String
resp.template_step_summary_list[0].step_group_id #=> String
resp.template_step_summary_list[0].template_id #=> String
resp.template_step_summary_list[0].name #=> String
resp.template_step_summary_list[0].step_action_type #=> String, one of "MANUAL", "AUTOMATED"
resp.template_step_summary_list[0].target_type #=> String, one of "SINGLE", "ALL", "NONE"
resp.template_step_summary_list[0].owner #=> String, one of "AWS_MANAGED", "CUSTOM"
resp.template_step_summary_list[0].previous #=> Array
resp.template_step_summary_list[0].previous[0] #=> String
resp.template_step_summary_list[0].next #=> Array
resp.template_step_summary_list[0].next[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results that can be returned.

  • :next_token (String) —

    The pagination token.

  • :template_id (required, String) —

    The ID of the template.

  • :step_group_id (required, String) —

    The ID of the step group.

Returns:

See Also:



1471
1472
1473
1474
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1471

def list_template_steps(params = {}, options = {})
  req = build_request(:list_template_steps, params)
  req.send_request(options)
end

#list_templates(params = {}) ⇒ Types::ListMigrationWorkflowTemplatesResponse

List the templates available in Migration Hub Orchestrator to create a migration workflow.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_templates({
  max_results: 1,
  next_token: "NextToken",
  name: "TemplateName",
})

Response structure


resp.next_token #=> String
resp.template_summary #=> Array
resp.template_summary[0].id #=> String
resp.template_summary[0].name #=> String
resp.template_summary[0].arn #=> String
resp.template_summary[0].description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results that can be returned.

  • :next_token (String) —

    The pagination token.

  • :name (String) —

    The name of the template.

Returns:

See Also:



1516
1517
1518
1519
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1516

def list_templates(params = {}, options = {})
  req = build_request(:list_templates, params)
  req.send_request(options)
end

#list_workflow_step_groups(params = {}) ⇒ Types::ListWorkflowStepGroupsResponse

List the step groups in a migration workflow.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_workflow_step_groups({
  next_token: "NextToken",
  max_results: 1,
  workflow_id: "MigrationWorkflowId", # required
})

Response structure


resp.next_token #=> String
resp.workflow_step_groups_summary #=> Array
resp.workflow_step_groups_summary[0].id #=> String
resp.workflow_step_groups_summary[0].name #=> String
resp.workflow_step_groups_summary[0].owner #=> String, one of "AWS_MANAGED", "CUSTOM"
resp.workflow_step_groups_summary[0].status #=> String, one of "AWAITING_DEPENDENCIES", "READY", "IN_PROGRESS", "COMPLETED", "FAILED", "PAUSED", "PAUSING", "USER_ATTENTION_REQUIRED"
resp.workflow_step_groups_summary[0].previous #=> Array
resp.workflow_step_groups_summary[0].previous[0] #=> String
resp.workflow_step_groups_summary[0].next #=> Array
resp.workflow_step_groups_summary[0].next[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token.

  • :max_results (Integer) —

    The maximum number of results that can be returned.

  • :workflow_id (required, String) —

    The ID of the migration workflow.

Returns:

See Also:



1564
1565
1566
1567
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1564

def list_workflow_step_groups(params = {}, options = {})
  req = build_request(:list_workflow_step_groups, params)
  req.send_request(options)
end

#list_workflow_steps(params = {}) ⇒ Types::ListWorkflowStepsResponse

List the steps in a workflow.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_workflow_steps({
  next_token: "NextToken",
  max_results: 1,
  workflow_id: "MigrationWorkflowId", # required
  step_group_id: "StepGroupId", # required
})

Response structure


resp.next_token #=> String
resp.workflow_steps_summary #=> Array
resp.workflow_steps_summary[0].step_id #=> String
resp.workflow_steps_summary[0].name #=> String
resp.workflow_steps_summary[0].step_action_type #=> String, one of "MANUAL", "AUTOMATED"
resp.workflow_steps_summary[0].owner #=> String, one of "AWS_MANAGED", "CUSTOM"
resp.workflow_steps_summary[0].previous #=> Array
resp.workflow_steps_summary[0].previous[0] #=> String
resp.workflow_steps_summary[0].next #=> Array
resp.workflow_steps_summary[0].next[0] #=> String
resp.workflow_steps_summary[0].status #=> String, one of "AWAITING_DEPENDENCIES", "SKIPPED", "READY", "IN_PROGRESS", "COMPLETED", "FAILED", "PAUSED", "USER_ATTENTION_REQUIRED"
resp.workflow_steps_summary[0].status_message #=> String
resp.workflow_steps_summary[0].no_of_srv_completed #=> Integer
resp.workflow_steps_summary[0].no_of_srv_failed #=> Integer
resp.workflow_steps_summary[0].total_no_of_srv #=> Integer
resp.workflow_steps_summary[0].description #=> String
resp.workflow_steps_summary[0].script_location #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token.

  • :max_results (Integer) —

    The maximum number of results that can be returned.

  • :workflow_id (required, String) —

    The ID of the migration workflow.

  • :step_group_id (required, String) —

    The ID of the step group.

Returns:

See Also:



1623
1624
1625
1626
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1623

def list_workflow_steps(params = {}, options = {})
  req = build_request(:list_workflow_steps, params)
  req.send_request(options)
end

#list_workflows(params = {}) ⇒ Types::ListMigrationWorkflowsResponse

List the migration workflows.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_workflows({
  max_results: 1,
  next_token: "NextToken",
  template_id: "TemplateId",
  ads_application_configuration_name: "ApplicationConfigurationName",
  status: "CREATING", # accepts CREATING, NOT_STARTED, CREATION_FAILED, STARTING, IN_PROGRESS, WORKFLOW_FAILED, PAUSED, PAUSING, PAUSING_FAILED, USER_ATTENTION_REQUIRED, DELETING, DELETION_FAILED, DELETED, COMPLETED
  name: "String",
})

Response structure


resp.next_token #=> String
resp.migration_workflow_summary #=> Array
resp.migration_workflow_summary[0].id #=> String
resp.migration_workflow_summary[0].name #=> String
resp.migration_workflow_summary[0].template_id #=> String
resp.migration_workflow_summary[0].ads_application_configuration_name #=> String
resp.migration_workflow_summary[0].status #=> String, one of "CREATING", "NOT_STARTED", "CREATION_FAILED", "STARTING", "IN_PROGRESS", "WORKFLOW_FAILED", "PAUSED", "PAUSING", "PAUSING_FAILED", "USER_ATTENTION_REQUIRED", "DELETING", "DELETION_FAILED", "DELETED", "COMPLETED"
resp.migration_workflow_summary[0].creation_time #=> Time
resp.migration_workflow_summary[0].end_time #=> Time
resp.migration_workflow_summary[0].status_message #=> String
resp.migration_workflow_summary[0].completed_steps #=> Integer
resp.migration_workflow_summary[0].total_steps #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results that can be returned.

  • :next_token (String) —

    The pagination token.

  • :template_id (String) —

    The ID of the template.

  • :ads_application_configuration_name (String) —

    The name of the application configured in Application Discovery Service.

  • :status (String) —

    The status of the migration workflow.

  • :name (String) —

    The name of the migration workflow.

Returns:

See Also:



1686
1687
1688
1689
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1686

def list_workflows(params = {}, options = {})
  req = build_request(:list_workflows, params)
  req.send_request(options)
end

#retry_workflow_step(params = {}) ⇒ Types::RetryWorkflowStepResponse

Retry a failed step in a migration workflow.

Examples:

Request syntax with placeholder values


resp = client.retry_workflow_step({
  workflow_id: "MigrationWorkflowId", # required
  step_group_id: "StepGroupId", # required
  id: "StepId", # required
})

Response structure


resp.step_group_id #=> String
resp.workflow_id #=> String
resp.id #=> String
resp.status #=> String, one of "AWAITING_DEPENDENCIES", "SKIPPED", "READY", "IN_PROGRESS", "COMPLETED", "FAILED", "PAUSED", "USER_ATTENTION_REQUIRED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_id (required, String) —

    The ID of the migration workflow.

  • :step_group_id (required, String) —

    The ID of the step group.

  • :id (required, String) —

    The ID of the step.

Returns:

See Also:



1728
1729
1730
1731
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1728

def retry_workflow_step(params = {}, options = {})
  req = build_request(:retry_workflow_step, params)
  req.send_request(options)
end

#start_workflow(params = {}) ⇒ Types::StartMigrationWorkflowResponse

Start a migration workflow.

Examples:

Request syntax with placeholder values


resp = client.start_workflow({
  id: "MigrationWorkflowId", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "NOT_STARTED", "CREATION_FAILED", "STARTING", "IN_PROGRESS", "WORKFLOW_FAILED", "PAUSED", "PAUSING", "PAUSING_FAILED", "USER_ATTENTION_REQUIRED", "DELETING", "DELETION_FAILED", "DELETED", "COMPLETED"
resp.status_message #=> String
resp.last_start_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the migration workflow.

Returns:

See Also:



1764
1765
1766
1767
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1764

def start_workflow(params = {}, options = {})
  req = build_request(:start_workflow, params)
  req.send_request(options)
end

#stop_workflow(params = {}) ⇒ Types::StopMigrationWorkflowResponse

Stop an ongoing migration workflow.

Examples:

Request syntax with placeholder values


resp = client.stop_workflow({
  id: "MigrationWorkflowId", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "NOT_STARTED", "CREATION_FAILED", "STARTING", "IN_PROGRESS", "WORKFLOW_FAILED", "PAUSED", "PAUSING", "PAUSING_FAILED", "USER_ATTENTION_REQUIRED", "DELETING", "DELETION_FAILED", "DELETED", "COMPLETED"
resp.status_message #=> String
resp.last_stop_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the migration workflow.

Returns:

See Also:



1800
1801
1802
1803
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1800

def stop_workflow(params = {}, options = {})
  req = build_request(:stop_workflow, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Tag a resource by specifying its Amazon Resource Name (ARN).

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tags (required, Hash<String,String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1830
1831
1832
1833
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1830

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Deletes the tags for a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1857
1858
1859
1860
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1857

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_template(params = {}) ⇒ Types::UpdateTemplateResponse

Updates a migration workflow template.

Examples:

Request syntax with placeholder values


resp = client.update_template({
  id: "TemplateId", # required
  template_name: "UpdateTemplateRequestTemplateNameString",
  template_description: "UpdateTemplateRequestTemplateDescriptionString",
  client_token: "ClientToken",
})

Response structure


resp.template_id #=> String
resp.template_arn #=> String
resp.tags #=> Hash
resp.tags["StringMapKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

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

  • :template_name (String) —

    The name of the migration workflow template to update.

  • :template_description (String) —

    The description of the migration workflow template to update.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1906
1907
1908
1909
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1906

def update_template(params = {}, options = {})
  req = build_request(:update_template, params)
  req.send_request(options)
end

#update_workflow(params = {}) ⇒ Types::UpdateMigrationWorkflowResponse

Update a migration workflow.

Examples:

Request syntax with placeholder values


resp = client.update_workflow({
  id: "MigrationWorkflowId", # required
  name: "UpdateMigrationWorkflowRequestNameString",
  description: "UpdateMigrationWorkflowRequestDescriptionString",
  input_parameters: {
    "StepInputParametersKey" => {
      integer_value: 1,
      string_value: "StringValue",
      list_of_strings_value: ["StringListMember"],
      map_of_string_value: {
        "StringMapKey" => "StringMapValue",
      },
    },
  },
  step_targets: ["StringListMember"],
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.template_id #=> String
resp.ads_application_configuration_id #=> String
resp.workflow_inputs #=> Hash
resp.workflow_inputs["StepInputParametersKey"].integer_value #=> Integer
resp.workflow_inputs["StepInputParametersKey"].string_value #=> String
resp.workflow_inputs["StepInputParametersKey"].list_of_strings_value #=> Array
resp.workflow_inputs["StepInputParametersKey"].list_of_strings_value[0] #=> String
resp.workflow_inputs["StepInputParametersKey"].map_of_string_value #=> Hash
resp.workflow_inputs["StepInputParametersKey"].map_of_string_value["StringMapKey"] #=> String
resp.step_targets #=> Array
resp.step_targets[0] #=> String
resp.status #=> String, one of "CREATING", "NOT_STARTED", "CREATION_FAILED", "STARTING", "IN_PROGRESS", "WORKFLOW_FAILED", "PAUSED", "PAUSING", "PAUSING_FAILED", "USER_ATTENTION_REQUIRED", "DELETING", "DELETION_FAILED", "DELETED", "COMPLETED"
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.tags #=> Hash
resp.tags["StringMapKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the migration workflow.

  • :name (String) —

    The name of the migration workflow.

  • :description (String) —

    The description of the migration workflow.

  • :input_parameters (Hash<String,Types::StepInput>) —

    The input parameters required to update a migration workflow.

  • :step_targets (Array<String>) —

    The servers on which a step will be run.

Returns:

See Also:



1989
1990
1991
1992
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 1989

def update_workflow(params = {}, options = {})
  req = build_request(:update_workflow, params)
  req.send_request(options)
end

#update_workflow_step(params = {}) ⇒ Types::UpdateWorkflowStepResponse

Update a step in a migration workflow.

Examples:

Request syntax with placeholder values


resp = client.update_workflow_step({
  id: "StepId", # required
  step_group_id: "StepGroupId", # required
  workflow_id: "MigrationWorkflowId", # required
  name: "StepName",
  description: "StepDescription",
  step_action_type: "MANUAL", # accepts MANUAL, AUTOMATED
  workflow_step_automation_configuration: {
    script_location_s3_bucket: "S3Bucket",
    script_location_s3_key: {
      linux: "S3Key",
      windows: "S3Key",
    },
    command: {
      linux: "String",
      windows: "String",
    },
    run_environment: "AWS", # accepts AWS, ONPREMISE
    target_type: "SINGLE", # accepts SINGLE, ALL, NONE
  },
  step_target: ["StringListMember"],
  outputs: [
    {
      name: "WorkflowStepOutputName",
      data_type: "STRING", # accepts STRING, INTEGER, STRINGLIST, STRINGMAP
      required: false,
      value: {
        integer_value: 1,
        string_value: "MaxStringValue",
        list_of_string_value: ["MaxStringValue"],
      },
    },
  ],
  previous: ["StringListMember"],
  next: ["StringListMember"],
  status: "AWAITING_DEPENDENCIES", # accepts AWAITING_DEPENDENCIES, SKIPPED, READY, IN_PROGRESS, COMPLETED, FAILED, PAUSED, USER_ATTENTION_REQUIRED
})

Response structure


resp.id #=> String
resp.step_group_id #=> String
resp.workflow_id #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the step.

  • :step_group_id (required, String) —

    The ID of the step group.

  • :workflow_id (required, String) —

    The ID of the migration workflow.

  • :name (String) —

    The name of the step.

  • :description (String) —

    The description of the step.

  • :step_action_type (String) —

    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 (Types::WorkflowStepAutomationConfiguration) —

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

  • :step_target (Array<String>) —

    The servers on which a step will be run.

  • :outputs (Array<Types::WorkflowStepOutput>) —

    The outputs of a step.

  • :previous (Array<String>) —

    The previous step.

  • :next (Array<String>) —

    The next step.

  • :status (String) —

    The status of the step.

Returns:

See Also:



2092
2093
2094
2095
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 2092

def update_workflow_step(params = {}, options = {})
  req = build_request(:update_workflow_step, params)
  req.send_request(options)
end

#update_workflow_step_group(params = {}) ⇒ Types::UpdateWorkflowStepGroupResponse

Update the step group in a migration workflow.

Examples:

Request syntax with placeholder values


resp = client.update_workflow_step_group({
  workflow_id: "MigrationWorkflowId", # required
  id: "StepGroupId", # required
  name: "StepGroupName",
  description: "StepGroupDescription",
  next: ["StringListMember"],
  previous: ["StringListMember"],
})

Response structure


resp.workflow_id #=> String
resp.name #=> String
resp.id #=> String
resp.description #=> String
resp.tools #=> Array
resp.tools[0].name #=> String
resp.tools[0].url #=> String
resp.next #=> Array
resp.next[0] #=> String
resp.previous #=> Array
resp.previous[0] #=> String
resp.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_id (required, String) —

    The ID of the migration workflow.

  • :id (required, String) —

    The ID of the step group.

  • :name (String) —

    The name of the step group.

  • :description (String) —

    The description of the step group.

  • :next (Array<String>) —

    The next step group.

  • :previous (Array<String>) —

    The previous step group.

Returns:

See Also:



2158
2159
2160
2161
 
# File 'gems/aws-sdk-migrationhuborchestrator/lib/aws-sdk-migrationhuborchestrator/client.rb', line 2158

def update_workflow_step_group(params = {}, options = {})
  req = build_request(:update_workflow_step_group, params)
  req.send_request(options)
end