CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createApplication([
    'ApiGatewayProxy' => [
        'EndpointType' => 'REGIONAL|PRIVATE',
        'StageName' => '<string>',
    ],
    'ClientToken' => '<string>',
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'ProxyType' => 'API_GATEWAY', // REQUIRED
    'Tags' => ['<string>', ...],
    'VpcId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApiGatewayProxy' => [
        'EndpointType' => 'REGIONAL|PRIVATE',
        'StageName' => '<string>',
    ],
    'ApplicationId' => '<string>',
    'Arn' => '<string>',
    'CreatedByAccountId' => '<string>',
    'CreatedTime' => <DateTime>,
    'EnvironmentId' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'OwnerAccountId' => '<string>',
    'ProxyType' => 'API_GATEWAY',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
    'Tags' => ['<string>', ...],
    'VpcId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

CreateEnvironment

$result = $client->createEnvironment([/* ... */]);
$promise = $client->createEnvironmentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createEnvironment([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'NetworkFabricType' => 'TRANSIT_GATEWAY|NONE', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreatedTime' => <DateTime>,
    'Description' => '<string>',
    'EnvironmentId' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'NetworkFabricType' => 'TRANSIT_GATEWAY|NONE',
    'OwnerAccountId' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

CreateRoute

$result = $client->createRoute([/* ... */]);
$promise = $client->createRouteAsync([/* ... */]);

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:UrlEndpoint when 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.

Parameter Syntax

$result = $client->createRoute([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'DefaultRoute' => [
        'ActivationState' => 'ACTIVE|INACTIVE',
    ],
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'RouteType' => 'DEFAULT|URI_PATH', // REQUIRED
    'ServiceIdentifier' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'UriPathRoute' => [
        'ActivationState' => 'ACTIVE|INACTIVE', // REQUIRED
        'AppendSourcePath' => true || false,
        'IncludeChildPaths' => true || false,
        'Methods' => ['<string>', ...],
        'SourcePath' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ApplicationId' => '<string>',
    'Arn' => '<string>',
    'CreatedByAccountId' => '<string>',
    'CreatedTime' => <DateTime>,
    'LastUpdatedTime' => <DateTime>,
    'OwnerAccountId' => '<string>',
    'RouteId' => '<string>',
    'RouteType' => 'DEFAULT|URI_PATH',
    'ServiceId' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|INACTIVE',
    'Tags' => ['<string>', ...],
    'UriPathRoute' => [
        'ActivationState' => 'ACTIVE|INACTIVE',
        'AppendSourcePath' => true || false,
        'IncludeChildPaths' => true || false,
        'Methods' => ['<string>', ...],
        'SourcePath' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

CreateService

$result = $client->createService([/* ... */]);
$promise = $client->createServiceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createService([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'EndpointType' => 'LAMBDA|URL', // REQUIRED
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'LambdaEndpoint' => [
        'Arn' => '<string>', // REQUIRED
    ],
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'UrlEndpoint' => [
        'HealthUrl' => '<string>',
        'Url' => '<string>', // REQUIRED
    ],
    'VpcId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ApplicationId' => '<string>',
    'Arn' => '<string>',
    'CreatedByAccountId' => '<string>',
    'CreatedTime' => <DateTime>,
    'Description' => '<string>',
    'EndpointType' => 'LAMBDA|URL',
    'EnvironmentId' => '<string>',
    'LambdaEndpoint' => [
        'Arn' => '<string>',
    ],
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'OwnerAccountId' => '<string>',
    'ServiceId' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED',
    'Tags' => ['<string>', ...],
    'UrlEndpoint' => [
        'HealthUrl' => '<string>',
        'Url' => '<string>',
    ],
    'VpcId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteApplication([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'EnvironmentIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationId' => '<string>',
    'Arn' => '<string>',
    'EnvironmentId' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

DeleteEnvironment

$result = $client->deleteEnvironment([/* ... */]);
$promise = $client->deleteEnvironmentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteEnvironment([
    'EnvironmentIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'EnvironmentId' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes the resource policy set for the environment.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

DeleteRoute

$result = $client->deleteRoute([/* ... */]);
$promise = $client->deleteRouteAsync([/* ... */]);

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

Parameter Syntax

$result = $client->deleteRoute([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'RouteIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationId' => '<string>',
    'Arn' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'RouteId' => '<string>',
    'ServiceId' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|INACTIVE',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

DeleteService

$result = $client->deleteService([/* ... */]);
$promise = $client->deleteServiceAsync([/* ... */]);

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

Parameter Syntax

$result = $client->deleteService([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'ServiceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationId' => '<string>',
    'Arn' => '<string>',
    'EnvironmentId' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'ServiceId' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

GetApplication

$result = $client->getApplication([/* ... */]);
$promise = $client->getApplicationAsync([/* ... */]);

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

Parameter Syntax

$result = $client->getApplication([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'EnvironmentIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApiGatewayProxy' => [
        'ApiGatewayId' => '<string>',
        'EndpointType' => 'REGIONAL|PRIVATE',
        'NlbArn' => '<string>',
        'NlbName' => '<string>',
        'ProxyUrl' => '<string>',
        'StageName' => '<string>',
        'VpcLinkId' => '<string>',
    ],
    'ApplicationId' => '<string>',
    'Arn' => '<string>',
    'CreatedByAccountId' => '<string>',
    'CreatedTime' => <DateTime>,
    'EnvironmentId' => '<string>',
    'Error' => [
        'AccountId' => '<string>',
        'AdditionalDetails' => ['<string>', ...],
        'Code' => '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',
        'Message' => '<string>',
        'ResourceIdentifier' => '<string>',
        'ResourceType' => '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',
    ],
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'OwnerAccountId' => '<string>',
    'ProxyType' => 'API_GATEWAY',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
    'Tags' => ['<string>', ...],
    'VpcId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

GetEnvironment

$result = $client->getEnvironment([/* ... */]);
$promise = $client->getEnvironmentAsync([/* ... */]);

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

Parameter Syntax

$result = $client->getEnvironment([
    'EnvironmentIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreatedTime' => <DateTime>,
    'Description' => '<string>',
    'EnvironmentId' => '<string>',
    'Error' => [
        'AccountId' => '<string>',
        'AdditionalDetails' => ['<string>', ...],
        'Code' => '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',
        'Message' => '<string>',
        'ResourceIdentifier' => '<string>',
        'ResourceType' => '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',
    ],
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'NetworkFabricType' => 'TRANSIT_GATEWAY|NONE',
    'OwnerAccountId' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED',
    'Tags' => ['<string>', ...],
    'TransitGatewayId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getResourcePolicy([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

GetRoute

$result = $client->getRoute([/* ... */]);
$promise = $client->getRouteAsync([/* ... */]);

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

Parameter Syntax

$result = $client->getRoute([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'RouteIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AppendSourcePath' => true || false,
    'ApplicationId' => '<string>',
    'Arn' => '<string>',
    'CreatedByAccountId' => '<string>',
    'CreatedTime' => <DateTime>,
    'EnvironmentId' => '<string>',
    'Error' => [
        'AccountId' => '<string>',
        'AdditionalDetails' => ['<string>', ...],
        'Code' => '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',
        'Message' => '<string>',
        'ResourceIdentifier' => '<string>',
        'ResourceType' => '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',
    ],
    'IncludeChildPaths' => true || false,
    'LastUpdatedTime' => <DateTime>,
    'Methods' => ['<string>', ...],
    'OwnerAccountId' => '<string>',
    'PathResourceToId' => ['<string>', ...],
    'RouteId' => '<string>',
    'RouteType' => 'DEFAULT|URI_PATH',
    'ServiceId' => '<string>',
    'SourcePath' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|INACTIVE',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

GetService

$result = $client->getService([/* ... */]);
$promise = $client->getServiceAsync([/* ... */]);

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

Parameter Syntax

$result = $client->getService([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'ServiceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationId' => '<string>',
    'Arn' => '<string>',
    'CreatedByAccountId' => '<string>',
    'CreatedTime' => <DateTime>,
    'Description' => '<string>',
    'EndpointType' => 'LAMBDA|URL',
    'EnvironmentId' => '<string>',
    'Error' => [
        'AccountId' => '<string>',
        'AdditionalDetails' => ['<string>', ...],
        'Code' => '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',
        'Message' => '<string>',
        'ResourceIdentifier' => '<string>',
        'ResourceType' => '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',
    ],
    'LambdaEndpoint' => [
        'Arn' => '<string>',
    ],
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'OwnerAccountId' => '<string>',
    'ServiceId' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED',
    'Tags' => ['<string>', ...],
    'UrlEndpoint' => [
        'HealthUrl' => '<string>',
        'Url' => '<string>',
    ],
    'VpcId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listApplications([
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ApplicationSummaryList' => [
        [
            'ApiGatewayProxy' => [
                'ApiGatewayId' => '<string>',
                'EndpointType' => 'REGIONAL|PRIVATE',
                'NlbArn' => '<string>',
                'NlbName' => '<string>',
                'ProxyUrl' => '<string>',
                'StageName' => '<string>',
                'VpcLinkId' => '<string>',
            ],
            'ApplicationId' => '<string>',
            'Arn' => '<string>',
            'CreatedByAccountId' => '<string>',
            'CreatedTime' => <DateTime>,
            'EnvironmentId' => '<string>',
            'Error' => [
                'AccountId' => '<string>',
                'AdditionalDetails' => ['<string>', ...],
                'Code' => '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',
                'Message' => '<string>',
                'ResourceIdentifier' => '<string>',
                'ResourceType' => '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',
            ],
            'LastUpdatedTime' => <DateTime>,
            'Name' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProxyType' => 'API_GATEWAY',
            'State' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
            'Tags' => ['<string>', ...],
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ListEnvironmentVpcs

$result = $client->listEnvironmentVpcs([/* ... */]);
$promise = $client->listEnvironmentVpcsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEnvironmentVpcs([
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EnvironmentVpcList' => [
        [
            'AccountId' => '<string>',
            'CidrBlocks' => ['<string>', ...],
            'CreatedTime' => <DateTime>,
            'EnvironmentId' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'VpcId' => '<string>',
            'VpcName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ListEnvironments

$result = $client->listEnvironments([/* ... */]);
$promise = $client->listEnvironmentsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEnvironments([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EnvironmentSummaryList' => [
        [
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'EnvironmentId' => '<string>',
            'Error' => [
                'AccountId' => '<string>',
                'AdditionalDetails' => ['<string>', ...],
                'Code' => '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',
                'Message' => '<string>',
                'ResourceIdentifier' => '<string>',
                'ResourceType' => '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',
            ],
            'LastUpdatedTime' => <DateTime>,
            'Name' => '<string>',
            'NetworkFabricType' => 'TRANSIT_GATEWAY|NONE',
            'OwnerAccountId' => '<string>',
            'State' => 'CREATING|ACTIVE|DELETING|FAILED',
            'Tags' => ['<string>', ...],
            'TransitGatewayId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ListRoutes

$result = $client->listRoutes([/* ... */]);
$promise = $client->listRoutesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listRoutes([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RouteSummaryList' => [
        [
            'AppendSourcePath' => true || false,
            'ApplicationId' => '<string>',
            'Arn' => '<string>',
            'CreatedByAccountId' => '<string>',
            'CreatedTime' => <DateTime>,
            'EnvironmentId' => '<string>',
            'Error' => [
                'AccountId' => '<string>',
                'AdditionalDetails' => ['<string>', ...],
                'Code' => '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',
                'Message' => '<string>',
                'ResourceIdentifier' => '<string>',
                'ResourceType' => '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',
            ],
            'IncludeChildPaths' => true || false,
            'LastUpdatedTime' => <DateTime>,
            'Methods' => ['<string>', ...],
            'OwnerAccountId' => '<string>',
            'PathResourceToId' => ['<string>', ...],
            'RouteId' => '<string>',
            'RouteType' => 'DEFAULT|URI_PATH',
            'ServiceId' => '<string>',
            'SourcePath' => '<string>',
            'State' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|INACTIVE',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ListServices

$result = $client->listServices([/* ... */]);
$promise = $client->listServicesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listServices([
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ServiceSummaryList' => [
        [
            'ApplicationId' => '<string>',
            'Arn' => '<string>',
            'CreatedByAccountId' => '<string>',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'EndpointType' => 'LAMBDA|URL',
            'EnvironmentId' => '<string>',
            'Error' => [
                'AccountId' => '<string>',
                'AdditionalDetails' => ['<string>', ...],
                'Code' => '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',
                'Message' => '<string>',
                'ResourceIdentifier' => '<string>',
                'ResourceType' => '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',
            ],
            'LambdaEndpoint' => [
                'Arn' => '<string>',
            ],
            'LastUpdatedTime' => <DateTime>,
            'Name' => '<string>',
            'OwnerAccountId' => '<string>',
            'ServiceId' => '<string>',
            'State' => 'CREATING|ACTIVE|DELETING|FAILED',
            'Tags' => ['<string>', ...],
            'UrlEndpoint' => [
                'HealthUrl' => '<string>',
                'Url' => '<string>',
            ],
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putResourcePolicy([
    'Policy' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

InvalidResourcePolicyException:

The resource policy is not valid.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

UpdateRoute

$result = $client->updateRoute([/* ... */]);
$promise = $client->updateRouteAsync([/* ... */]);

Updates an Amazon Web Services Migration Hub Refactor Spaces route.

Parameter Syntax

$result = $client->updateRoute([
    'ActivationState' => 'ACTIVE|INACTIVE', // REQUIRED
    'ApplicationIdentifier' => '<string>', // REQUIRED
    'EnvironmentIdentifier' => '<string>', // REQUIRED
    'RouteIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationId' => '<string>',
    'Arn' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'RouteId' => '<string>',
    'ServiceId' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING|INACTIVE',
]

Result Details

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Service.

ThrottlingException:

Request was denied because the request was throttled.

AccessDeniedException:

The user does not have sufficient access to perform this action.