AWS SDK for PHP 3.x

Client: Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient

Service ID: migration-hub-refactor-spaces

Version: 2021-10-26

This page describes the parameters and results for the operations of the AWS Migration Hub Refactor Spaces (2021-10-26), and shows how to use the Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient object to call the described operations. This documentation is specific to the 2021-10-26 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateApplication ( array $params = [] )
Creates an Amazon Web Services Migration Hub Refactor Spaces application.
CreateEnvironment ( array $params = [] )
Creates an Amazon Web Services Migration Hub Refactor Spaces environment.
CreateRoute ( array $params = [] )
Creates an Amazon Web Services Migration Hub Refactor Spaces route.
CreateService ( array $params = [] )
Creates an Amazon Web Services Migration Hub Refactor Spaces service.
DeleteApplication ( array $params = [] )
Deletes an Amazon Web Services Migration Hub Refactor Spaces application.
DeleteEnvironment ( array $params = [] )
Deletes an Amazon Web Services Migration Hub Refactor Spaces environment.
DeleteResourcePolicy ( array $params = [] )
Deletes the resource policy set for the environment.
DeleteRoute ( array $params = [] )
Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
DeleteService ( array $params = [] )
Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
GetApplication ( array $params = [] )
Gets an Amazon Web Services Migration Hub Refactor Spaces application.
GetEnvironment ( array $params = [] )
Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
GetResourcePolicy ( array $params = [] )
Gets the resource-based permission policy that is set for the given environment.
GetRoute ( array $params = [] )
Gets an Amazon Web Services Migration Hub Refactor Spaces route.
GetService ( array $params = [] )
Gets an Amazon Web Services Migration Hub Refactor Spaces service.
ListApplications ( array $params = [] )
Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
ListEnvironmentVpcs ( array $params = [] )
Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.
ListEnvironments ( array $params = [] )
Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.
ListRoutes ( array $params = [] )
Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
ListServices ( array $params = [] )
Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
ListTagsForResource ( array $params = [] )
Lists the tags of a resource.
PutResourcePolicy ( array $params = [] )
Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment.
TagResource ( array $params = [] )
Removes the tags of a given resource.
UntagResource ( array $params = [] )
Adds to or modifies the tags of the given resource.
UpdateRoute ( array $params = [] )
Updates an Amazon Web Services Migration Hub Refactor Spaces route.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListApplications
ListEnvironmentVpcs
ListEnvironments
ListRoutes
ListServices

Operations

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.

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

Members

ApiGatewayProxy

Type: ApiGatewayProxyInput structure

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

ClientToken

Type: string

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

EnvironmentIdentifier

Required: Yes
Type: string

The unique identifier of the environment.

Name

Required: Yes
Type: string

The name to use for the application.

ProxyType

Required: Yes
Type: string

The proxy type of the proxy created within the application.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

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.

VpcId

Required: Yes
Type: string

The ID of the virtual private cloud (VPC).

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

Members

ApiGatewayProxy

Type: ApiGatewayProxyInput structure

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

ApplicationId

Type: string

The unique identifier of the application.

Arn

Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CreatedByAccountId

Type: string

The Amazon Web Services account ID of application creator.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the application is created.

EnvironmentId

Type: string

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

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the application was last updated.

Name

Type: string

The name of the application.

OwnerAccountId

Type: string

The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).

ProxyType

Type: string

The proxy type of the proxy created within the application.

State

Type: string

The current state of the application.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

The tags assigned 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.

VpcId

Type: string

The ID of the Amazon VPC.

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 network fabric type of TRANSIT_GATEWAY, Refactor Spaces provisions a transit gateway in your account.

Parameter Syntax

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

Parameter Details

Members

ClientToken

Type: string

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

Description

Type: string

The description of the environment.

Name

Required: Yes
Type: string

The name of the environment.

NetworkFabricType

Required: Yes
Type: string

The network fabric type of the environment.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

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.

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

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the environment.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the environment is created.

Description

Type: string

A description of the environment.

EnvironmentId

Type: string

The unique identifier of the environment.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the environment was last updated.

Name

Type: string

The name of the environment.

NetworkFabricType

Type: string

The network fabric type of the environment.

OwnerAccountId

Type: string

The Amazon Web Services account ID of environment owner.

State

Type: string

The current state of the environment.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

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

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:

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 the service has a URL endpoint, and the endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet.
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.

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 Lambda functions, 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.

For Lambda endpoints, 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.

Refactor Spaces automatically resolves the public Domain Name System (DNS) names that are set in CreateServiceRequest$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.

For private URLS, a target group is created on the Elastic Load Balancing and the target group health check is run. The HealthCheckProtocol, HealthCheckPort, and HealthCheckPath are the same protocol, port, and path specified in the URL or health URL, if used. All other settings use the default values, as described in Health checks for your target groups. The health check is considered successful if at least one target within the target group transitions to a healthy state.

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.

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
        'IncludeChildPaths' => true || false,
        'Methods' => ['<string>', ...],
        'SourcePath' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

ApplicationIdentifier

Required: Yes
Type: string

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

ClientToken

Type: string

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

DefaultRoute

Type: DefaultRouteInput structure

Configuration for the default route type.

EnvironmentIdentifier

Required: Yes
Type: string

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

RouteType

Required: Yes
Type: 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.

ServiceIdentifier

Required: Yes
Type: string

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

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

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..

UriPathRoute

Type: UriPathRouteInput structure

The configuration for the URI path route type.

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',
        'IncludeChildPaths' => true || false,
        'Methods' => ['<string>', ...],
        'SourcePath' => '<string>',
    ],
]

Result Details

Members

ApplicationId

Type: string

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

Arn

Type: string

The Amazon Resource Name (ARN) of the route. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CreatedByAccountId

Type: string

The Amazon Web Services account ID of the route creator.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the route is created.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the route was last updated.

OwnerAccountId

Type: string

The Amazon Web Services account ID of the route owner.

RouteId

Type: string

The unique identifier of the route.

RouteType

Type: string

The route type of the route.

ServiceId

Type: string

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

State

Type: string

The current state of the route. Activation state only allows ACTIVE or INACTIVE as user inputs. FAILED is a route state that is system generated.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

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

UriPathRoute

Type: UriPathRouteInput structure

Configuration for the URI path route type.

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.

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.

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

Members

ApplicationIdentifier

Required: Yes
Type: string

The ID of the application which the service is created.

ClientToken

Type: string

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

Description

Type: string

The description of the service.

EndpointType

Required: Yes
Type: string

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

EnvironmentIdentifier

Required: Yes
Type: string

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

LambdaEndpoint

Type: LambdaEndpointInput structure

The configuration for the Lambda endpoint type.

Name

Required: Yes
Type: string

The name of the service.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

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..

UrlEndpoint

Type: UrlEndpointInput structure

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.

VpcId

Type: string

The ID of the VPC.

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

Members

ApplicationId

Type: string

The ID of the application that the created service belongs to.

Arn

Type: string

The Amazon Resource Name (ARN) of the service.

CreatedByAccountId

Type: string

The Amazon Web Services account ID of the service creator.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the service is created.

Description

Type: string

The description of the created service.

EndpointType

Type: string

The endpoint type of the service.

EnvironmentId

Type: string

The unique identifier of the environment.

LambdaEndpoint

Type: LambdaEndpointInput structure

The configuration for the Lambda endpoint type.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the service was last updated.

Name

Type: string

The name of the service.

OwnerAccountId

Type: string

The Amazon Web Services account ID of the service owner.

ServiceId

Type: string

The unique identifier of the service.

State

Type: string

The current state of the service.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

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

UrlEndpoint

Type: UrlEndpointInput structure

The configuration for the URL endpoint type.

VpcId

Type: string

The ID of the VPC.

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

Members

ApplicationIdentifier

Required: Yes
Type: string

The ID of the application.

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment.

Result Syntax

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

Result Details

Members

ApplicationId

Type: string

The ID of the application.

Arn

Type: string

The Amazon Resource Name (ARN) of the application.

EnvironmentId

Type: string

The unique identifier of the application’s environment.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the environment was last updated.

Name

Type: string

The name of the application.

State

Type: string

The current state of the application.

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

Members

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment.

Result Syntax

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

Result Details

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the environment.

EnvironmentId

Type: string

The unique identifier of the environment.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the environment was last updated.

Name

Type: string

The name of the environment.

State

Type: string

The current state of the environment.

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

Members

Identifier

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

ApplicationIdentifier

Required: Yes
Type: string

The ID of the application to delete the route from.

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment to delete the route from.

RouteIdentifier

Required: Yes
Type: string

The ID of the route to delete.

Result Syntax

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

Result Details

Members

ApplicationId

Type: string

The ID of the application that the route belongs to.

Arn

Type: string

The Amazon Resource Name (ARN) of the route.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the route was last updated.

RouteId

Type: string

The ID of the route to delete.

ServiceId

Type: string

The ID of the service that the route belongs to.

State

Type: string

The current state of the route.

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

Members

ApplicationIdentifier

Required: Yes
Type: 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.

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment that the service is in.

ServiceIdentifier

Required: Yes
Type: string

The ID of the service to delete.

Result Syntax

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

Result Details

Members

ApplicationId

Type: string

The ID of the application that the service is in.

Arn

Type: string

The Amazon Resource Name (ARN) of the service.

EnvironmentId

Type: string

The unique identifier of the environment.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the service was last updated.

Name

Type: string

The name of the service.

ServiceId

Type: string

The unique identifier of the service.

State

Type: string

The current state of the service.

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

Members

ApplicationIdentifier

Required: Yes
Type: string

The ID of the application.

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment.

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

Members

ApiGatewayProxy

Type: ApiGatewayProxyConfig structure

The endpoint URL of the API Gateway proxy.

ApplicationId

Type: string

The unique identifier of the application.

Arn

Type: string

The Amazon Resource Name (ARN) of the application.

CreatedByAccountId

Type: string

The Amazon Web Services account ID of the application creator.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the application is created.

EnvironmentId

Type: string

The unique identifier of the environment.

Error

Type: ErrorResponse structure

Any error associated with the application resource.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the application was last updated.

Name

Type: string

The name of the application.

OwnerAccountId

Type: string

The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).

ProxyType

Type: string

The proxy type of the proxy created within the application.

State

Type: string

The current state of the application.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

The tags assigned 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.

VpcId

Type: string

The ID of the virtual private cloud (VPC).

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

Members

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment.

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

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the environment.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the environment is created.

Description

Type: string

The description of the environment.

EnvironmentId

Type: string

The unique identifier of the environment.

Error

Type: ErrorResponse structure

Any error associated with the environment resource.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the environment was last updated.

Name

Type: string

The name of the environment.

NetworkFabricType

Type: string

The network fabric type of the environment.

OwnerAccountId

Type: string

The Amazon Web Services account ID of the environment owner.

State

Type: string

The current state of the environment.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

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.

TransitGatewayId

Type: string

The ID of the transit gateway set up by the environment.

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

Members

Identifier

Required: Yes
Type: string

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

Result Syntax

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

Result Details

Members

Policy

Type: string

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

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

Members

ApplicationIdentifier

Required: Yes
Type: string

The ID of the application.

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment.

RouteIdentifier

Required: Yes
Type: string

The ID of the route.

Result Syntax

[
    '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

Members

ApplicationId

Type: string

The ID of the application that the route belongs to.

Arn

Type: string

The Amazon Resource Name (ARN) of the route.

CreatedByAccountId

Type: string

The Amazon Web Services account ID of the route creator.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the route is created.

EnvironmentId

Type: string

Unique identifier of the environment.

Error

Type: ErrorResponse structure

Any error associated with the route resource.

IncludeChildPaths

Type: boolean

Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the route was last updated.

Methods

Type: Array of strings

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

OwnerAccountId

Type: string

The Amazon Web Services account ID of the route owner.

PathResourceToId

Type: Associative array of custom strings keys (PathResourceToIdKey) to strings

A mapping of Amazon API Gateway path resources to resource IDs.

RouteId

Type: string

The unique identifier of the route.

DEFAULT: 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: A route that is based on a URI path.

RouteType

Type: string

The type of route.

ServiceId

Type: string

The unique identifier of the service.

SourcePath

Type: string

The path to use to match traffic. Paths must start with / and are relative to the base of the application.

State

Type: string

The current state of the route.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

The tags assigned 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.

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

Members

ApplicationIdentifier

Required: Yes
Type: string

The ID of the application.

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment.

ServiceIdentifier

Required: Yes
Type: string

The ID of the service.

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

Members

ApplicationId

Type: string

The ID of the application.

Arn

Type: string

The Amazon Resource Name (ARN) of the service.

CreatedByAccountId

Type: string

The Amazon Web Services account ID of the service creator.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the service is created.

Description

Type: string

The description of the service.

EndpointType

Type: string

The endpoint type of the service.

EnvironmentId

Type: string

The unique identifier of the environment.

Error

Type: ErrorResponse structure

Any error associated with the service resource.

LambdaEndpoint

Type: LambdaEndpointConfig structure

The configuration for the Lambda endpoint type.

The Arn is the Amazon Resource Name (ARN) of the Lambda function associated with this service.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the service was last updated.

Name

Type: string

The name of the service.

OwnerAccountId

Type: string

The Amazon Web Services account ID of the service owner.

ServiceId

Type: string

The unique identifier of the service.

State

Type: string

The current state of the service.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

The tags assigned 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.

UrlEndpoint

Type: UrlEndpointConfig structure

The configuration for the URL endpoint type.

The Url isthe URL of the endpoint type.

The HealthUrl is the health check URL of the endpoint type.

VpcId

Type: string

The ID of the virtual private cloud (VPC).

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

Members

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment.

MaxResults

Type: int

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

NextToken

Type: string

The token for the next page of results.

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

Members

ApplicationSummaryList

Type: Array of ApplicationSummary structures

The list of ApplicationSummary objects.

NextToken

Type: string

The token for the next page of results.

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

Members

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment.

MaxResults

Type: int

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

NextToken

Type: string

The token for the next page of results.

Result Syntax

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

Result Details

Members

EnvironmentVpcList

Type: Array of EnvironmentVpc structures

The list of EnvironmentVpc objects.

NextToken

Type: string

The token for the next page of results.

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

Members

MaxResults

Type: int

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

NextToken

Type: string

The token for the next page of results.

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

Members

EnvironmentSummaryList

Type: Array of EnvironmentSummary structures

The list of EnvironmentSummary objects.

NextToken

Type: string

The token for the next page of results.

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

Members

ApplicationIdentifier

Required: Yes
Type: string

The ID of the application.

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment.

MaxResults

Type: int

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

NextToken

Type: string

The token for the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'RouteSummaryList' => [
        [
            '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

Members

NextToken

Type: string

The token for the next page of results.

RouteSummaryList

Type: Array of RouteSummary structures

The list of RouteSummary objects.

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

Members

ApplicationIdentifier

Required: Yes
Type: string

The ID of the application.

EnvironmentIdentifier

Required: Yes
Type: string

The ID of the environment.

MaxResults

Type: int

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

NextToken

Type: string

The token for the next page of results.

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

Members

NextToken

Type: string

The token for the next page of results.

ServiceSummaryList

Type: Array of ServiceSummary structures

The list of ServiceSummary objects.

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

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

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

Result Details

Members

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

The list of tags assigned to the resource.

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

Members

Policy

Required: Yes
Type: string

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

ResourceArn

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

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

Parameter Syntax

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

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Tags

Required: Yes
Type: Associative array of custom strings keys (TagMapKeyString) to strings

The new or modified tags for the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

TagKeys

Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

ActivationState

Required: Yes
Type: string

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

ApplicationIdentifier

Required: Yes
Type: string

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

EnvironmentIdentifier

Required: Yes
Type: string

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

RouteIdentifier

Required: Yes
Type: string

The unique identifier of the route to update.

Result Syntax

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

Result Details

Members

ApplicationId

Type: string

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

Arn

Type: string

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the route was last updated.

RouteId

Type: string

The unique identifier of the route.

ServiceId

Type: string

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

State

Type: string

The current state of the route.

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.

Shapes

AccessDeniedException

Description

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

Members

Message

Required: Yes
Type: string

ApiGatewayProxyConfig

Description

A wrapper object holding the Amazon API Gateway proxy configuration.

Members

ApiGatewayId

Type: string

The resource ID of the API Gateway for the proxy.

EndpointType

Type: string

The type of API Gateway endpoint created.

NlbArn

Type: string

The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.

NlbName

Type: string

The name of the Network Load Balancer that is configured by the API Gateway proxy.

ProxyUrl

Type: string

The endpoint URL of the API Gateway proxy.

StageName

Type: string

The name of the API Gateway stage. The name defaults to prod.

VpcLinkId

Type: string

The VpcLink ID of the API Gateway proxy.

ApiGatewayProxyInput

Description

A wrapper object holding the Amazon API Gateway endpoint input.

Members

EndpointType

Type: string

The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) endpoints for Amazon API Gateway that have been granted access.

StageName

Type: string

The name of the API Gateway stage. The name defaults to prod.

ApiGatewayProxySummary

Description

A wrapper object holding the Amazon API Gateway proxy summary.

Members

ApiGatewayId

Type: string

The resource ID of the API Gateway for the proxy.

EndpointType

Type: string

The type of API Gateway endpoint created.

NlbArn

Type: string

The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.

NlbName

Type: string

The name of the Network Load Balancer that is configured by the API Gateway proxy.

ProxyUrl

Type: string

The endpoint URL of the API Gateway proxy.

StageName

Type: string

The name of the API Gateway stage. The name defaults to prod.

VpcLinkId

Type: string

The VpcLink ID of the API Gateway proxy.

ApplicationSummary

Description

The list of ApplicationSummary objects.

Members

ApiGatewayProxy

Type: ApiGatewayProxySummary structure

The endpoint URL of the Amazon API Gateway proxy.

ApplicationId

Type: string

The unique identifier of the application.

Arn

Type: string

The Amazon Resource Name (ARN) of the application.

CreatedByAccountId

Type: string

The Amazon Web Services account ID of the application creator.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the application is created.

EnvironmentId

Type: string

The unique identifier of the environment.

Error

Type: ErrorResponse structure

Any error associated with the application resource.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the application was last updated.

Name

Type: string

The name of the application.

OwnerAccountId

Type: string

The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).

ProxyType

Type: string

The proxy type of the proxy created within the application.

State

Type: string

The current state of the application.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

The tags assigned to the application.

VpcId

Type: string

The ID of the virtual private cloud (VPC).

ConflictException

Description

Updating or deleting a resource can cause an inconsistent state.

Members

Message

Required: Yes
Type: string

ResourceId

Required: Yes
Type: string

The ID of the resource.

ResourceType

Required: Yes
Type: string

The type of resource.

DefaultRouteInput

Description

The configuration for the default route type.

Members

ActivationState

Type: string

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

EnvironmentSummary

Description

The summary information for environments as a response to ListEnvironments.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the environment.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the environment is created.

Description

Type: string

A description of the environment.

EnvironmentId

Type: string

The unique identifier of the environment.

Error

Type: ErrorResponse structure

Any error associated with the environment resource.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the environment was last updated.

Name

Type: string

The name of the environment.

NetworkFabricType

Type: string

The network fabric type of the environment.

OwnerAccountId

Type: string

The Amazon Web Services account ID of the environment owner.

State

Type: string

The current state of the environment.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

The tags assigned to the environment.

TransitGatewayId

Type: string

The ID of the transit gateway set up by the environment.

EnvironmentVpc

Description

Provides summary information for the EnvironmentVpc resource as a response to ListEnvironmentVpc.

Members

AccountId

Type: string

The Amazon Web Services account ID of the virtual private cloud (VPC) owner.

CidrBlocks

Type: Array of strings

The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the VPC is first added to the environment.

EnvironmentId

Type: string

The unique identifier of the environment.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the VPC was last updated by the environment.

VpcId

Type: string

The ID of the VPC.

VpcName

Type: string

The name of the VPC at the time it is added to the environment.

ErrorResponse

Description

Error associated with a resource returned for a Get or List resource response.

Members

AccountId

Type: string

The Amazon Web Services account ID of the resource owner.

AdditionalDetails

Type: Associative array of custom strings keys (AdditionalDetailsKey) to strings

Additional details about the error.

Code

Type: string

The error code associated with the error.

Message

Type: string

The message associated with the error.

ResourceIdentifier

Type: string

The ID of the resource.

ResourceType

Type: string

The type of resource.

InternalServerException

Description

An unexpected error occurred while processing the request.

Members

Message

Required: Yes
Type: string

InvalidResourcePolicyException

Description

The resource policy is not valid.

Members

Message

Required: Yes
Type: string

LambdaEndpointConfig

Description

The configuration for the Lambda endpoint type.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the Lambda endpoint.

LambdaEndpointInput

Description

The input for the Lambda endpoint type.

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Lambda function or alias.

LambdaEndpointSummary

Description

The summary for the Lambda endpoint type.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the Lambda endpoint.

ResourceNotFoundException

Description

The request references a resource that does not exist.

Members

Message

Required: Yes
Type: string

ResourceId

Required: Yes
Type: string

The ID of the resource.

ResourceType

Required: Yes
Type: string

The type of resource.

RouteSummary

Description

The summary information for the routes as a response to ListRoutes.

Members

ApplicationId

Type: string

The unique identifier of the application.

Arn

Type: string

The Amazon Resource Name (ARN) of the route.

CreatedByAccountId

Type: string

The Amazon Web Services account ID of the route creator.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the route is created.

EnvironmentId

Type: string

The unique identifier of the environment.

Error

Type: ErrorResponse structure

Any error associated with the route resource.

IncludeChildPaths

Type: boolean

Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the route was last updated.

Methods

Type: Array of strings

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

OwnerAccountId

Type: string

The Amazon Web Services account ID of the route owner.

PathResourceToId

Type: Associative array of custom strings keys (PathResourceToIdKey) to strings

A mapping of Amazon API Gateway path resources to resource IDs.

RouteId

Type: string

The unique identifier of the route.

RouteType

Type: string

The route type of the route.

ServiceId

Type: string

The unique identifier of the service.

SourcePath

Type: string

The path to use to match traffic. Paths must start with / and are relative to the base of the application.

State

Type: string

The current state of the route.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

The tags assigned to the route.

ServiceQuotaExceededException

Description

The request would cause a service quota to be exceeded.

Members

Message

Required: Yes
Type: string

QuotaCode

Type: string

Service quota requirement to identify originating quota. Reached throttling quota exception.

ResourceId

Required: Yes
Type: string

The ID of the resource.

ResourceType

Required: Yes
Type: string

The type of resource.

ServiceCode

Required: Yes
Type: string

Service quota requirement to identify originating service. Reached throttling quota exception service code.

ServiceSummary

Description

A summary for the service as a response to ListServices.

Members

ApplicationId

Type: string

The unique identifier of the application.

Arn

Type: string

The Amazon Resource Name (ARN) of the service.

CreatedByAccountId

Type: string

The Amazon Web Services account ID of the service creator.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the service is created.

Description

Type: string

A description of the service.

EndpointType

Type: string

The endpoint type of the service.

EnvironmentId

Type: string

The unique identifier of the environment.

Error

Type: ErrorResponse structure

Any error associated with the service resource.

LambdaEndpoint

Type: LambdaEndpointSummary structure

A summary of the configuration for the Lambda endpoint type.

LastUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the service was last updated.

Name

Type: string

The name of the service.

OwnerAccountId

Type: string

The Amazon Web Services account ID of the service owner.

ServiceId

Type: string

The unique identifier of the service.

State

Type: string

The current state of the service.

Tags

Type: Associative array of custom strings keys (TagMapKeyString) to strings

The tags assigned to the service.

UrlEndpoint

Type: UrlEndpointSummary structure

The summary of the configuration for the URL endpoint type.

VpcId

Type: string

The ID of the virtual private cloud (VPC).

ThrottlingException

Description

Request was denied because the request was throttled.

Members

Message

Required: Yes
Type: string

QuotaCode

Type: string

Service quota requirement to identify originating quota. Reached throttling quota exception.

RetryAfterSeconds

Type: int

The number of seconds to wait before retrying.

ServiceCode

Type: string

Service quota requirement to identify originating service. Reached throttling quota exception service code.

UriPathRouteInput

Description

The configuration for the URI path route type.

Members

ActivationState

Required: Yes
Type: string

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

IncludeChildPaths

Type: boolean

Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

Methods

Type: Array of strings

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

SourcePath

Required: Yes
Type: string

The path to use to match traffic. Paths must start with / and are relative to the base of the application.

UrlEndpointConfig

Description

The configuration for the URL endpoint type.

Members

HealthUrl

Type: string

The health check URL of the URL endpoint type.

Url

Type: string

The HTTP URL endpoint.

UrlEndpointInput

Description

The configuration for the URL endpoint type.

Members

HealthUrl

Type: string

The health check URL of the URL endpoint type. If the URL is a public endpoint, the HealthUrl must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.

Url

Required: Yes
Type: string

The URL to route traffic to. The URL must be an rfc3986-formatted URL. If the host is a domain name, the name must be resolvable over the public internet. If the scheme is https, the top level domain of the host must be listed in the IANA root zone database.

UrlEndpointSummary

Description

The summary of the configuration for the URL endpoint type.

Members

HealthUrl

Type: string

Url

Type: string

ValidationException

Description

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

Members

Message

Required: Yes
Type: string

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Migration Hub Refactor Spaces 2021-10-26

Operation Summary

Paginators

Operations

CreateApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateRoute

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateService

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteResourcePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteRoute

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteService

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members