Class: Aws::MigrationHubRefactorSpaces::Client

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

Overview

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

client = Aws::MigrationHubRefactorSpaces::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. This can be an 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, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails 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)
  • :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.

  • :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 —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :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_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.

  • :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) —

    A Bearer Token Provider. This can be an 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::MigrationHubRefactorSpaces::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::MigrationHubRefactorSpaces::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.



440
441
442
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 440

def initialize(*args)
  super
end

Instance Method Details

#create_application(params = {}) ⇒ Types::CreateApplicationResponse

Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the applications created inside the environment, regardless of the account that creates the application. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and Network Load Balancer for the application proxy inside your account.

In environments created with a CreateEnvironment:NetworkFabricType of NONE you need to configure VPC to VPC connectivity between your service VPC and the application proxy VPC to route traffic through the application proxy to a service with a private URL endpoint. For more information, see Create an application in the Refactor Spaces User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_application({
  api_gateway_proxy: {
    endpoint_type: "REGIONAL", # accepts REGIONAL, PRIVATE
    stage_name: "StageName",
  },
  client_token: "ClientToken",
  environment_identifier: "EnvironmentId", # required
  name: "ApplicationName", # required
  proxy_type: "API_GATEWAY", # required, accepts API_GATEWAY
  tags: {
    "TagMapKeyString" => "TagMapValueString",
  },
  vpc_id: "VpcId", # required
})

Response structure


resp.api_gateway_proxy.endpoint_type #=> String, one of "REGIONAL", "PRIVATE"
resp.api_gateway_proxy.stage_name #=> String
resp.application_id #=> String
resp.arn #=> String
resp. #=> String
resp.created_time #=> Time
resp.environment_id #=> String
resp.last_updated_time #=> Time
resp.name #=> String
resp. #=> String
resp.proxy_type #=> String, one of "API_GATEWAY"
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
resp.tags #=> Hash
resp.tags["TagMapKeyString"] #=> String
resp.vpc_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :api_gateway_proxy (Types::ApiGatewayProxyInput) —

    A wrapper object holding the API Gateway endpoint type and stage name for the proxy.

  • :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.**

  • :environment_identifier (required, String) —

    The unique identifier of the environment.

  • :name (required, String) —

    The name to use for the application.

  • :proxy_type (required, String) —

    The proxy type of the proxy created within the application.

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

    The tags to assign to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

  • :vpc_id (required, String) —

    The ID of the virtual private cloud (VPC).

Returns:

See Also:



549
550
551
552
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 549

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

#create_environment(params = {}) ⇒ Types::CreateEnvironmentResponse

Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all Refactor Spaces applications, services, and routes created within the environment. They are referred to as the environment owner. The environment owner has cross-account visibility and control of Refactor Spaces resources that are added to the environment by other accounts that the environment is shared with.

When creating an environment with a CreateEnvironment:NetworkFabricType of TRANSIT_GATEWAY, Refactor Spaces provisions a transit gateway to enable services in VPCs to communicate directly across accounts. If CreateEnvironment:NetworkFabricType is NONE, Refactor Spaces does not create a transit gateway and you must use your network infrastructure to route traffic to services with private URL endpoints.

Examples:

Request syntax with placeholder values


resp = client.create_environment({
  client_token: "ClientToken",
  description: "Description",
  name: "EnvironmentName", # required
  network_fabric_type: "TRANSIT_GATEWAY", # required, accepts TRANSIT_GATEWAY, NONE
  tags: {
    "TagMapKeyString" => "TagMapValueString",
  },
})

Response structure


resp.arn #=> String
resp.created_time #=> Time
resp.description #=> String
resp.environment_id #=> String
resp.last_updated_time #=> Time
resp.name #=> String
resp.network_fabric_type #=> String, one of "TRANSIT_GATEWAY", "NONE"
resp. #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.tags #=> Hash
resp.tags["TagMapKeyString"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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.**

  • :description (String) —

    The description of the environment.

  • :name (required, String) —

    The name of the environment.

  • :network_fabric_type (required, String) —

    The network fabric type of the environment.

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

    The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

Returns:

See Also:



639
640
641
642
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 639

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

#create_route(params = {}) ⇒ Types::CreateRouteResponse

Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a DEFAULT RouteType.

When created, the default route defaults to an active state so state is not a required input. However, like all other state values the state of the default route can be updated after creation, but only when all other routes are also inactive. Conversely, no route can be active without the default route also being active.

When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service as follows:

  • URL Endpoints

    If the service has a URL endpoint, and the endpoint resolves to a private IP address, Refactor Spaces routes traffic using the API Gateway VPC link. If a service endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet. Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed certificates are supported. Private Certificate Authorities (CAs) are permitted only if the CA's domain is also publicly resolvable.

    Refactor Spaces automatically resolves the public Domain Name System (DNS) names that are set in CreateService:UrlEndpointwhen you create a service. The DNS names resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60 seconds. This periodic DNS resolution ensures that the route configuration remains up-to-date.

    One-time health check

    A one-time health check is performed on the service when either the route is updated from inactive to active, or when it is created with an active state. If the health check fails, the route transitions the route state to FAILED, an error code of SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no traffic is sent to the service.

    For private URLs, a target group is created on the Network Load Balancer and the load balancer target group runs default target health checks. By default, the health check is run against the service endpoint URL. Optionally, the health check can be performed against a different protocol, port, and/or path using the CreateService:UrlEndpoint parameter. All other health check settings for the load balancer use the default values described in the Health checks for your target groups in the Elastic Load Balancing guide. The health check is considered successful if at least one target within the target group transitions to a healthy state.

  • Lambda function endpoints

    If the service has an Lambda function endpoint, then Refactor Spaces configures the Lambda function's resource policy to allow the application's API Gateway to invoke the function.

    The Lambda function state is checked. If the function is not active, the function configuration is updated so that Lambda resources are provisioned. If the Lambda state is Failed, then the route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.

    A check is performed to determine that a Lambda function with the specified ARN exists. If it does not exist, the health check fails. For public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails.

Environments without a network bridge

When you create environments without a network bridge (CreateEnvironment:NetworkFabricType is NONE) and you use your own networking infrastructure, you need to configure VPC to VPC connectivity between your network and the application proxy VPC. Route creation from the application proxy to service endpoints will fail if your network is not configured to connect to the application proxy VPC. For more information, see Create a route in the Refactor Spaces User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_route({
  application_identifier: "ApplicationId", # required
  client_token: "ClientToken",
  default_route: {
    activation_state: "ACTIVE", # accepts ACTIVE, INACTIVE
  },
  environment_identifier: "EnvironmentId", # required
  route_type: "DEFAULT", # required, accepts DEFAULT, URI_PATH
  service_identifier: "ServiceId", # required
  tags: {
    "TagMapKeyString" => "TagMapValueString",
  },
  uri_path_route: {
    activation_state: "ACTIVE", # required, accepts ACTIVE, INACTIVE
    append_source_path: false,
    include_child_paths: false,
    methods: ["DELETE"], # accepts DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT
    source_path: "UriPath", # required
  },
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp. #=> String
resp.created_time #=> Time
resp.last_updated_time #=> Time
resp. #=> String
resp.route_id #=> String
resp.route_type #=> String, one of "DEFAULT", "URI_PATH"
resp.service_id #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "INACTIVE"
resp.tags #=> Hash
resp.tags["TagMapKeyString"] #=> String
resp.uri_path_route.activation_state #=> String, one of "ACTIVE", "INACTIVE"
resp.uri_path_route.append_source_path #=> Boolean
resp.uri_path_route.include_child_paths #=> Boolean
resp.uri_path_route.methods #=> Array
resp.uri_path_route.methods[0] #=> String, one of "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"
resp.uri_path_route.source_path #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_identifier (required, String) —

    The ID of the application within which the route is being created.

  • :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.**

  • :default_route (Types::DefaultRouteInput) —

    Configuration for the default route type.

  • :environment_identifier (required, String) —

    The ID of the environment in which the route is created.

  • :route_type (required, String) —

    The route type of the route. DEFAULT indicates that all traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created. URI_PATH indicates a route that is based on a URI path.

  • :service_identifier (required, String) —

    The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.

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

    The tags to assign to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..

  • :uri_path_route (Types::UriPathRouteInput) —

    The configuration for the URI path route type.

Returns:

See Also:



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

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

#create_service(params = {}) ⇒ Types::CreateServiceResponse

Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the environment owner, regardless of which account in the environment creates the service. Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint.

If an Amazon Web Services resource is launched in a service VPC, and you want it to be accessible to all of an environment’s services with VPCs and routes, apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to add more cross-account constraints, apply your own security group.

Examples:

Request syntax with placeholder values


resp = client.create_service({
  application_identifier: "ApplicationId", # required
  client_token: "ClientToken",
  description: "Description",
  endpoint_type: "LAMBDA", # required, accepts LAMBDA, URL
  environment_identifier: "EnvironmentId", # required
  lambda_endpoint: {
    arn: "LambdaArn", # required
  },
  name: "ServiceName", # required
  tags: {
    "TagMapKeyString" => "TagMapValueString",
  },
  url_endpoint: {
    health_url: "Uri",
    url: "Uri", # required
  },
  vpc_id: "VpcId",
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp. #=> String
resp.created_time #=> Time
resp.description #=> String
resp.endpoint_type #=> String, one of "LAMBDA", "URL"
resp.environment_id #=> String
resp.lambda_endpoint.arn #=> String
resp.last_updated_time #=> Time
resp.name #=> String
resp. #=> String
resp.service_id #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.tags #=> Hash
resp.tags["TagMapKeyString"] #=> String
resp.url_endpoint.health_url #=> String
resp.url_endpoint.url #=> String
resp.vpc_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_identifier (required, String) —

    The ID of the application which the service is created.

  • :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.**

  • :description (String) —

    The description of the service.

  • :endpoint_type (required, String) —

    The type of endpoint to use for the service. The type can be a URL in a VPC or an Lambda function.

  • :environment_identifier (required, String) —

    The ID of the environment in which the service is created.

  • :lambda_endpoint (Types::LambdaEndpointInput) —

    The configuration for the Lambda endpoint type.

  • :name (required, String) —

    The name of the service.

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

    The tags to assign to the service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..

  • :url_endpoint (Types::UrlEndpointInput) —

    The configuration for the URL endpoint type. When creating a route to a service, Refactor Spaces automatically resolves the address in the UrlEndpointInput object URL when the Domain Name System (DNS) time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60 seconds.

  • :vpc_id (String) —

    The ID of the VPC.

Returns:

See Also:



964
965
966
967
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 964

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

#delete_application(params = {}) ⇒ Types::DeleteApplicationResponse

Deletes an Amazon Web Services Migration Hub Refactor Spaces application. Before you can delete an application, you must first delete any services or routes within the application.

Examples:

Request syntax with placeholder values


resp = client.delete_application({
  application_identifier: "ApplicationId", # required
  environment_identifier: "EnvironmentId", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.environment_id #=> String
resp.last_updated_time #=> Time
resp.name #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"

Parameters:

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

    ({})

Options Hash (params):

  • :application_identifier (required, String) —

    The ID of the application.

  • :environment_identifier (required, String) —

    The ID of the environment.

Returns:

See Also:



1008
1009
1010
1011
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1008

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

#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentResponse

Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first delete any applications and services within the environment.

Examples:

Request syntax with placeholder values


resp = client.delete_environment({
  environment_identifier: "EnvironmentId", # required
})

Response structure


resp.arn #=> String
resp.environment_id #=> String
resp.last_updated_time #=> Time
resp.name #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :environment_identifier (required, String) —

    The ID of the environment.

Returns:

See Also:



1046
1047
1048
1049
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1046

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

#delete_resource_policy(params = {}) ⇒ Struct

Deletes the resource policy set for the environment.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  identifier: "ResourcePolicyIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    Amazon Resource Name (ARN) of the resource associated with the policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1068
1069
1070
1071
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1068

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

#delete_route(params = {}) ⇒ Types::DeleteRouteResponse

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

Examples:

Request syntax with placeholder values


resp = client.delete_route({
  application_identifier: "ApplicationId", # required
  environment_identifier: "EnvironmentId", # required
  route_identifier: "RouteId", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.last_updated_time #=> Time
resp.route_id #=> String
resp.service_id #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "INACTIVE"

Parameters:

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

    ({})

Options Hash (params):

  • :application_identifier (required, String) —

    The ID of the application to delete the route from.

  • :environment_identifier (required, String) —

    The ID of the environment to delete the route from.

  • :route_identifier (required, String) —

    The ID of the route to delete.

Returns:

See Also:



1114
1115
1116
1117
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1114

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

#delete_service(params = {}) ⇒ Types::DeleteServiceResponse

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

Examples:

Request syntax with placeholder values


resp = client.delete_service({
  application_identifier: "ApplicationId", # required
  environment_identifier: "EnvironmentId", # required
  service_identifier: "ServiceId", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.environment_id #=> String
resp.last_updated_time #=> Time
resp.name #=> String
resp.service_id #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :application_identifier (required, String) —

    Deletes a Refactor Spaces service.

    The RefactorSpacesSecurityGroup security group must be removed from all Amazon Web Services resources in the virtual private cloud (VPC) prior to deleting a service with a URL endpoint in a VPC.

  • :environment_identifier (required, String) —

    The ID of the environment that the service is in.

  • :service_identifier (required, String) —

    The ID of the service to delete.

Returns:

See Also:



1168
1169
1170
1171
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1168

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

#get_application(params = {}) ⇒ Types::GetApplicationResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

Examples:

Request syntax with placeholder values


resp = client.get_application({
  application_identifier: "ApplicationId", # required
  environment_identifier: "EnvironmentId", # required
})

Response structure


resp.api_gateway_proxy.api_gateway_id #=> String
resp.api_gateway_proxy.endpoint_type #=> String, one of "REGIONAL", "PRIVATE"
resp.api_gateway_proxy.nlb_arn #=> String
resp.api_gateway_proxy.nlb_name #=> String
resp.api_gateway_proxy.proxy_url #=> String
resp.api_gateway_proxy.stage_name #=> String
resp.api_gateway_proxy.vpc_link_id #=> String
resp.application_id #=> String
resp.arn #=> String
resp. #=> String
resp.created_time #=> Time
resp.environment_id #=> String
resp.error. #=> String
resp.error.additional_details #=> Hash
resp.error.additional_details["AdditionalDetailsKey"] #=> String
resp.error.code #=> String, one of "INVALID_RESOURCE_STATE", "RESOURCE_LIMIT_EXCEEDED", "RESOURCE_CREATION_FAILURE", "RESOURCE_UPDATE_FAILURE", "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE", "RESOURCE_DELETION_FAILURE", "RESOURCE_RETRIEVAL_FAILURE", "RESOURCE_IN_USE", "RESOURCE_NOT_FOUND", "STATE_TRANSITION_FAILURE", "REQUEST_LIMIT_EXCEEDED", "NOT_AUTHORIZED"
resp.error.message #=> String
resp.error.resource_identifier #=> String
resp.error.resource_type #=> String, one of "ENVIRONMENT", "APPLICATION", "ROUTE", "SERVICE", "TRANSIT_GATEWAY", "TRANSIT_GATEWAY_ATTACHMENT", "API_GATEWAY", "NLB", "TARGET_GROUP", "LOAD_BALANCER_LISTENER", "VPC_LINK", "LAMBDA", "VPC", "SUBNET", "ROUTE_TABLE", "SECURITY_GROUP", "VPC_ENDPOINT_SERVICE_CONFIGURATION", "RESOURCE_SHARE", "IAM_ROLE"
resp.last_updated_time #=> Time
resp.name #=> String
resp. #=> String
resp.proxy_type #=> String, one of "API_GATEWAY"
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
resp.tags #=> Hash
resp.tags["TagMapKeyString"] #=> String
resp.vpc_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_identifier (required, String) —

    The ID of the application.

  • :environment_identifier (required, String) —

    The ID of the environment.

Returns:

See Also:



1239
1240
1241
1242
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1239

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

#get_environment(params = {}) ⇒ Types::GetEnvironmentResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

Examples:

Request syntax with placeholder values


resp = client.get_environment({
  environment_identifier: "EnvironmentId", # required
})

Response structure


resp.arn #=> String
resp.created_time #=> Time
resp.description #=> String
resp.environment_id #=> String
resp.error. #=> String
resp.error.additional_details #=> Hash
resp.error.additional_details["AdditionalDetailsKey"] #=> String
resp.error.code #=> String, one of "INVALID_RESOURCE_STATE", "RESOURCE_LIMIT_EXCEEDED", "RESOURCE_CREATION_FAILURE", "RESOURCE_UPDATE_FAILURE", "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE", "RESOURCE_DELETION_FAILURE", "RESOURCE_RETRIEVAL_FAILURE", "RESOURCE_IN_USE", "RESOURCE_NOT_FOUND", "STATE_TRANSITION_FAILURE", "REQUEST_LIMIT_EXCEEDED", "NOT_AUTHORIZED"
resp.error.message #=> String
resp.error.resource_identifier #=> String
resp.error.resource_type #=> String, one of "ENVIRONMENT", "APPLICATION", "ROUTE", "SERVICE", "TRANSIT_GATEWAY", "TRANSIT_GATEWAY_ATTACHMENT", "API_GATEWAY", "NLB", "TARGET_GROUP", "LOAD_BALANCER_LISTENER", "VPC_LINK", "LAMBDA", "VPC", "SUBNET", "ROUTE_TABLE", "SECURITY_GROUP", "VPC_ENDPOINT_SERVICE_CONFIGURATION", "RESOURCE_SHARE", "IAM_ROLE"
resp.last_updated_time #=> Time
resp.name #=> String
resp.network_fabric_type #=> String, one of "TRANSIT_GATEWAY", "NONE"
resp. #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.tags #=> Hash
resp.tags["TagMapKeyString"] #=> String
resp.transit_gateway_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :environment_identifier (required, String) —

    The ID of the environment.

Returns:

See Also:



1296
1297
1298
1299
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1296

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

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse

Gets the resource-based permission policy that is set for the given environment.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  identifier: "ResourcePolicyIdentifier", # required
})

Response structure


resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The Amazon Resource Name (ARN) of the resource associated with the policy.

Returns:

See Also:



1326
1327
1328
1329
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1326

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

#get_route(params = {}) ⇒ Types::GetRouteResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

Examples:

Request syntax with placeholder values


resp = client.get_route({
  application_identifier: "ApplicationId", # required
  environment_identifier: "EnvironmentId", # required
  route_identifier: "RouteId", # required
})

Response structure


resp.append_source_path #=> Boolean
resp.application_id #=> String
resp.arn #=> String
resp. #=> String
resp.created_time #=> Time
resp.environment_id #=> String
resp.error. #=> String
resp.error.additional_details #=> Hash
resp.error.additional_details["AdditionalDetailsKey"] #=> String
resp.error.code #=> String, one of "INVALID_RESOURCE_STATE", "RESOURCE_LIMIT_EXCEEDED", "RESOURCE_CREATION_FAILURE", "RESOURCE_UPDATE_FAILURE", "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE", "RESOURCE_DELETION_FAILURE", "RESOURCE_RETRIEVAL_FAILURE", "RESOURCE_IN_USE", "RESOURCE_NOT_FOUND", "STATE_TRANSITION_FAILURE", "REQUEST_LIMIT_EXCEEDED", "NOT_AUTHORIZED"
resp.error.message #=> String
resp.error.resource_identifier #=> String
resp.error.resource_type #=> String, one of "ENVIRONMENT", "APPLICATION", "ROUTE", "SERVICE", "TRANSIT_GATEWAY", "TRANSIT_GATEWAY_ATTACHMENT", "API_GATEWAY", "NLB", "TARGET_GROUP", "LOAD_BALANCER_LISTENER", "VPC_LINK", "LAMBDA", "VPC", "SUBNET", "ROUTE_TABLE", "SECURITY_GROUP", "VPC_ENDPOINT_SERVICE_CONFIGURATION", "RESOURCE_SHARE", "IAM_ROLE"
resp.include_child_paths #=> Boolean
resp.last_updated_time #=> Time
resp.data.methods #=> Array
resp.data.methods[0] #=> String, one of "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"
resp. #=> String
resp.path_resource_to_id #=> Hash
resp.path_resource_to_id["PathResourceToIdKey"] #=> String
resp.route_id #=> String
resp.route_type #=> String, one of "DEFAULT", "URI_PATH"
resp.service_id #=> String
resp.source_path #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "INACTIVE"
resp.tags #=> Hash
resp.tags["TagMapKeyString"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_identifier (required, String) —

    The ID of the application.

  • :environment_identifier (required, String) —

    The ID of the environment.

  • :route_identifier (required, String) —

    The ID of the route.

Returns:

See Also:



1405
1406
1407
1408
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1405

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

#get_service(params = {}) ⇒ Types::GetServiceResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

Examples:

Request syntax with placeholder values


resp = client.get_service({
  application_identifier: "ApplicationId", # required
  environment_identifier: "EnvironmentId", # required
  service_identifier: "ServiceId", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp. #=> String
resp.created_time #=> Time
resp.description #=> String
resp.endpoint_type #=> String, one of "LAMBDA", "URL"
resp.environment_id #=> String
resp.error. #=> String
resp.error.additional_details #=> Hash
resp.error.additional_details["AdditionalDetailsKey"] #=> String
resp.error.code #=> String, one of "INVALID_RESOURCE_STATE", "RESOURCE_LIMIT_EXCEEDED", "RESOURCE_CREATION_FAILURE", "RESOURCE_UPDATE_FAILURE", "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE", "RESOURCE_DELETION_FAILURE", "RESOURCE_RETRIEVAL_FAILURE", "RESOURCE_IN_USE", "RESOURCE_NOT_FOUND", "STATE_TRANSITION_FAILURE", "REQUEST_LIMIT_EXCEEDED", "NOT_AUTHORIZED"
resp.error.message #=> String
resp.error.resource_identifier #=> String
resp.error.resource_type #=> String, one of "ENVIRONMENT", "APPLICATION", "ROUTE", "SERVICE", "TRANSIT_GATEWAY", "TRANSIT_GATEWAY_ATTACHMENT", "API_GATEWAY", "NLB", "TARGET_GROUP", "LOAD_BALANCER_LISTENER", "VPC_LINK", "LAMBDA", "VPC", "SUBNET", "ROUTE_TABLE", "SECURITY_GROUP", "VPC_ENDPOINT_SERVICE_CONFIGURATION", "RESOURCE_SHARE", "IAM_ROLE"
resp.lambda_endpoint.arn #=> String
resp.last_updated_time #=> Time
resp.name #=> String
resp. #=> String
resp.service_id #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.tags #=> Hash
resp.tags["TagMapKeyString"] #=> String
resp.url_endpoint.health_url #=> String
resp.url_endpoint.url #=> String
resp.vpc_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_identifier (required, String) —

    The ID of the application.

  • :environment_identifier (required, String) —

    The ID of the environment.

  • :service_identifier (required, String) —

    The ID of the service.

Returns:

See Also:



1481
1482
1483
1484
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1481

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

#list_applications(params = {}) ⇒ Types::ListApplicationsResponse

Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.

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_applications({
  environment_identifier: "EnvironmentId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.application_summary_list #=> Array
resp.application_summary_list[0].api_gateway_proxy.api_gateway_id #=> String
resp.application_summary_list[0].api_gateway_proxy.endpoint_type #=> String, one of "REGIONAL", "PRIVATE"
resp.application_summary_list[0].api_gateway_proxy.nlb_arn #=> String
resp.application_summary_list[0].api_gateway_proxy.nlb_name #=> String
resp.application_summary_list[0].api_gateway_proxy.proxy_url #=> String
resp.application_summary_list[0].api_gateway_proxy.stage_name #=> String
resp.application_summary_list[0].api_gateway_proxy.vpc_link_id #=> String
resp.application_summary_list[0].application_id #=> String
resp.application_summary_list[0].arn #=> String
resp.application_summary_list[0]. #=> String
resp.application_summary_list[0].created_time #=> Time
resp.application_summary_list[0].environment_id #=> String
resp.application_summary_list[0].error. #=> String
resp.application_summary_list[0].error.additional_details #=> Hash
resp.application_summary_list[0].error.additional_details["AdditionalDetailsKey"] #=> String
resp.application_summary_list[0].error.code #=> String, one of "INVALID_RESOURCE_STATE", "RESOURCE_LIMIT_EXCEEDED", "RESOURCE_CREATION_FAILURE", "RESOURCE_UPDATE_FAILURE", "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE", "RESOURCE_DELETION_FAILURE", "RESOURCE_RETRIEVAL_FAILURE", "RESOURCE_IN_USE", "RESOURCE_NOT_FOUND", "STATE_TRANSITION_FAILURE", "REQUEST_LIMIT_EXCEEDED", "NOT_AUTHORIZED"
resp.application_summary_list[0].error.message #=> String
resp.application_summary_list[0].error.resource_identifier #=> String
resp.application_summary_list[0].error.resource_type #=> String, one of "ENVIRONMENT", "APPLICATION", "ROUTE", "SERVICE", "TRANSIT_GATEWAY", "TRANSIT_GATEWAY_ATTACHMENT", "API_GATEWAY", "NLB", "TARGET_GROUP", "LOAD_BALANCER_LISTENER", "VPC_LINK", "LAMBDA", "VPC", "SUBNET", "ROUTE_TABLE", "SECURITY_GROUP", "VPC_ENDPOINT_SERVICE_CONFIGURATION", "RESOURCE_SHARE", "IAM_ROLE"
resp.application_summary_list[0].last_updated_time #=> Time
resp.application_summary_list[0].name #=> String
resp.application_summary_list[0]. #=> String
resp.application_summary_list[0].proxy_type #=> String, one of "API_GATEWAY"
resp.application_summary_list[0].state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
resp.application_summary_list[0].tags #=> Hash
resp.application_summary_list[0].tags["TagMapKeyString"] #=> String
resp.application_summary_list[0].vpc_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :environment_identifier (required, String) —

    The ID of the environment.

  • :max_results (Integer) —

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1551
1552
1553
1554
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1551

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

#list_environment_vpcs(params = {}) ⇒ Types::ListEnvironmentVpcsResponse

Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.

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_environment_vpcs({
  environment_identifier: "EnvironmentId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.environment_vpc_list #=> Array
resp.environment_vpc_list[0]. #=> String
resp.environment_vpc_list[0].cidr_blocks #=> Array
resp.environment_vpc_list[0].cidr_blocks[0] #=> String
resp.environment_vpc_list[0].created_time #=> Time
resp.environment_vpc_list[0].environment_id #=> String
resp.environment_vpc_list[0].last_updated_time #=> Time
resp.environment_vpc_list[0].vpc_id #=> String
resp.environment_vpc_list[0].vpc_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :environment_identifier (required, String) —

    The ID of the environment.

  • :max_results (Integer) —

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1602
1603
1604
1605
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1602

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

#list_environments(params = {}) ⇒ Types::ListEnvironmentsResponse

Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.

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_environments({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.environment_summary_list #=> Array
resp.environment_summary_list[0].arn #=> String
resp.environment_summary_list[0].created_time #=> Time
resp.environment_summary_list[0].description #=> String
resp.environment_summary_list[0].environment_id #=> String
resp.environment_summary_list[0].error. #=> String
resp.environment_summary_list[0].error.additional_details #=> Hash
resp.environment_summary_list[0].error.additional_details["AdditionalDetailsKey"] #=> String
resp.environment_summary_list[0].error.code #=> String, one of "INVALID_RESOURCE_STATE", "RESOURCE_LIMIT_EXCEEDED", "RESOURCE_CREATION_FAILURE", "RESOURCE_UPDATE_FAILURE", "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE", "RESOURCE_DELETION_FAILURE", "RESOURCE_RETRIEVAL_FAILURE", "RESOURCE_IN_USE", "RESOURCE_NOT_FOUND", "STATE_TRANSITION_FAILURE", "REQUEST_LIMIT_EXCEEDED", "NOT_AUTHORIZED"
resp.environment_summary_list[0].error.message #=> String
resp.environment_summary_list[0].error.resource_identifier #=> String
resp.environment_summary_list[0].error.resource_type #=> String, one of "ENVIRONMENT", "APPLICATION", "ROUTE", "SERVICE", "TRANSIT_GATEWAY", "TRANSIT_GATEWAY_ATTACHMENT", "API_GATEWAY", "NLB", "TARGET_GROUP", "LOAD_BALANCER_LISTENER", "VPC_LINK", "LAMBDA", "VPC", "SUBNET", "ROUTE_TABLE", "SECURITY_GROUP", "VPC_ENDPOINT_SERVICE_CONFIGURATION", "RESOURCE_SHARE", "IAM_ROLE"
resp.environment_summary_list[0].last_updated_time #=> Time
resp.environment_summary_list[0].name #=> String
resp.environment_summary_list[0].network_fabric_type #=> String, one of "TRANSIT_GATEWAY", "NONE"
resp.environment_summary_list[0]. #=> String
resp.environment_summary_list[0].state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.environment_summary_list[0].tags #=> Hash
resp.environment_summary_list[0].tags["TagMapKeyString"] #=> String
resp.environment_summary_list[0].transit_gateway_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1660
1661
1662
1663
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1660

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

#list_routes(params = {}) ⇒ Types::ListRoutesResponse

Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.

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_routes({
  application_identifier: "ApplicationId", # required
  environment_identifier: "EnvironmentId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.route_summary_list #=> Array
resp.route_summary_list[0].append_source_path #=> Boolean
resp.route_summary_list[0].application_id #=> String
resp.route_summary_list[0].arn #=> String
resp.route_summary_list[0]. #=> String
resp.route_summary_list[0].created_time #=> Time
resp.route_summary_list[0].environment_id #=> String
resp.route_summary_list[0].error. #=> String
resp.route_summary_list[0].error.additional_details #=> Hash
resp.route_summary_list[0].error.additional_details["AdditionalDetailsKey"] #=> String
resp.route_summary_list[0].error.code #=> String, one of "INVALID_RESOURCE_STATE", "RESOURCE_LIMIT_EXCEEDED", "RESOURCE_CREATION_FAILURE", "RESOURCE_UPDATE_FAILURE", "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE", "RESOURCE_DELETION_FAILURE", "RESOURCE_RETRIEVAL_FAILURE", "RESOURCE_IN_USE", "RESOURCE_NOT_FOUND", "STATE_TRANSITION_FAILURE", "REQUEST_LIMIT_EXCEEDED", "NOT_AUTHORIZED"
resp.route_summary_list[0].error.message #=> String
resp.route_summary_list[0].error.resource_identifier #=> String
resp.route_summary_list[0].error.resource_type #=> String, one of "ENVIRONMENT", "APPLICATION", "ROUTE", "SERVICE", "TRANSIT_GATEWAY", "TRANSIT_GATEWAY_ATTACHMENT", "API_GATEWAY", "NLB", "TARGET_GROUP", "LOAD_BALANCER_LISTENER", "VPC_LINK", "LAMBDA", "VPC", "SUBNET", "ROUTE_TABLE", "SECURITY_GROUP", "VPC_ENDPOINT_SERVICE_CONFIGURATION", "RESOURCE_SHARE", "IAM_ROLE"
resp.route_summary_list[0].include_child_paths #=> Boolean
resp.route_summary_list[0].last_updated_time #=> Time
resp.route_summary_list[0].methods #=> Array
resp.route_summary_list[0].methods[0] #=> String, one of "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"
resp.route_summary_list[0]. #=> String
resp.route_summary_list[0].path_resource_to_id #=> Hash
resp.route_summary_list[0].path_resource_to_id["PathResourceToIdKey"] #=> String
resp.route_summary_list[0].route_id #=> String
resp.route_summary_list[0].route_type #=> String, one of "DEFAULT", "URI_PATH"
resp.route_summary_list[0].service_id #=> String
resp.route_summary_list[0].source_path #=> String
resp.route_summary_list[0].state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "INACTIVE"
resp.route_summary_list[0].tags #=> Hash
resp.route_summary_list[0].tags["TagMapKeyString"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_identifier (required, String) —

    The ID of the application.

  • :environment_identifier (required, String) —

    The ID of the environment.

  • :max_results (Integer) —

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1734
1735
1736
1737
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1734

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

#list_services(params = {}) ⇒ Types::ListServicesResponse

Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.

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_services({
  application_identifier: "ApplicationId", # required
  environment_identifier: "EnvironmentId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.service_summary_list #=> Array
resp.service_summary_list[0].application_id #=> String
resp.service_summary_list[0].arn #=> String
resp.service_summary_list[0]. #=> String
resp.service_summary_list[0].created_time #=> Time
resp.service_summary_list[0].description #=> String
resp.service_summary_list[0].endpoint_type #=> String, one of "LAMBDA", "URL"
resp.service_summary_list[0].environment_id #=> String
resp.service_summary_list[0].error. #=> String
resp.service_summary_list[0].error.additional_details #=> Hash
resp.service_summary_list[0].error.additional_details["AdditionalDetailsKey"] #=> String
resp.service_summary_list[0].error.code #=> String, one of "INVALID_RESOURCE_STATE", "RESOURCE_LIMIT_EXCEEDED", "RESOURCE_CREATION_FAILURE", "RESOURCE_UPDATE_FAILURE", "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE", "RESOURCE_DELETION_FAILURE", "RESOURCE_RETRIEVAL_FAILURE", "RESOURCE_IN_USE", "RESOURCE_NOT_FOUND", "STATE_TRANSITION_FAILURE", "REQUEST_LIMIT_EXCEEDED", "NOT_AUTHORIZED"
resp.service_summary_list[0].error.message #=> String
resp.service_summary_list[0].error.resource_identifier #=> String
resp.service_summary_list[0].error.resource_type #=> String, one of "ENVIRONMENT", "APPLICATION", "ROUTE", "SERVICE", "TRANSIT_GATEWAY", "TRANSIT_GATEWAY_ATTACHMENT", "API_GATEWAY", "NLB", "TARGET_GROUP", "LOAD_BALANCER_LISTENER", "VPC_LINK", "LAMBDA", "VPC", "SUBNET", "ROUTE_TABLE", "SECURITY_GROUP", "VPC_ENDPOINT_SERVICE_CONFIGURATION", "RESOURCE_SHARE", "IAM_ROLE"
resp.service_summary_list[0].lambda_endpoint.arn #=> String
resp.service_summary_list[0].last_updated_time #=> Time
resp.service_summary_list[0].name #=> String
resp.service_summary_list[0]. #=> String
resp.service_summary_list[0].service_id #=> String
resp.service_summary_list[0].state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.service_summary_list[0].tags #=> Hash
resp.service_summary_list[0].tags["TagMapKeyString"] #=> String
resp.service_summary_list[0].url_endpoint.health_url #=> String
resp.service_summary_list[0].url_endpoint.url #=> String
resp.service_summary_list[0].vpc_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_identifier (required, String) —

    The ID of the application.

  • :environment_identifier (required, String) —

    The ID of the environment.

  • :max_results (Integer) —

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1806
1807
1808
1809
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1806

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

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

Lists the tags of a resource. The caller account must be the same as the resource’s OwnerAccountId. Listing tags in other accounts is not supported.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



1837
1838
1839
1840
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1837

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

#put_resource_policy(params = {}) ⇒ Struct

Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment. The policy must contain the same actions and condition statements as the arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment permission in Resource Access Manager. The policy must not contain new lines or blank lines.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  policy: "PolicyString", # required
  resource_arn: "ResourceArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :policy (required, String) —

    A JSON-formatted string for an Amazon Web Services resource-based policy.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to which the policy is being attached.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1870
1871
1872
1873
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1870

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

#tag_resource(params = {}) ⇒ Struct

Removes the tags of a given resource. Tags are metadata which can be used to manage a resource. To tag a resource, the caller account must be the same as the resource’s OwnerAccountId. Tagging resources in other accounts is not supported.

Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an environment’s transit gateway.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "TagMapKeyString" => "TagMapValueString",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

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

    The new or modified tags for the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#untag_resource(params = {}) ⇒ Struct

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. To untag a resource, the caller account must be the same as the resource’s OwnerAccountId. Untagging resources across accounts is not supported.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

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

    The list of keys of the tags to be removed from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1936
1937
1938
1939
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1936

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

#update_route(params = {}) ⇒ Types::UpdateRouteResponse

Updates an Amazon Web Services Migration Hub Refactor Spaces route.

Examples:

Request syntax with placeholder values


resp = client.update_route({
  activation_state: "ACTIVE", # required, accepts ACTIVE, INACTIVE
  application_identifier: "ApplicationId", # required
  environment_identifier: "EnvironmentId", # required
  route_identifier: "RouteId", # required
})

Response structure


resp.application_id #=> String
resp.arn #=> String
resp.last_updated_time #=> Time
resp.route_id #=> String
resp.service_id #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "INACTIVE"

Parameters:

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

    ({})

Options Hash (params):

  • :activation_state (required, String) —

    If set to ACTIVE, traffic is forwarded to this route’s service after the route is updated.

  • :application_identifier (required, String) —

    The ID of the application within which the route is being updated.

  • :environment_identifier (required, String) —

    The ID of the environment in which the route is being updated.

  • :route_identifier (required, String) —

    The unique identifier of the route to update.

Returns:

See Also:



1987
1988
1989
1990
 
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1987

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