2021/11/29 - AWS Migration Hub Refactor Spaces - 23 new api methods
Changes This is the initial SDK release for AWS Migration Hub Refactor Spaces
Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
See also: AWS API Documentation
Request Syntax
client.list_applications(
EnvironmentIdentifier='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the environment.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
dict
Response 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(2015, 1, 1),
'EnvironmentId': 'string',
'Error': {
'AccountId': 'string',
'AdditionalDetails': {
'string': '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(2015, 1, 1),
'Name': 'string',
'OwnerAccountId': 'string',
'ProxyType': 'API_GATEWAY',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
'Tags': {
'string': 'string'
},
'VpcId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ApplicationSummaryList (list) --
The list of ApplicationSummary objects.
(dict) --
The list of ApplicationSummary objects.
ApiGatewayProxy (dict) --
The endpoint URL of the Amazon API Gateway proxy.
ApiGatewayId (string) --
The resource ID of the API Gateway for the proxy.
EndpointType (string) --
The type of API Gateway endpoint created.
NlbArn (string) --
The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.
NlbName (string) --
The name of the Network Load Balancer that is configured by the API Gateway proxy.
ProxyUrl (string) --
The endpoint URL of the API Gateway proxy.
StageName (string) --
The name of the API Gateway stage. The name defaults to prod .
VpcLinkId (string) --
The VpcLink ID of the API Gateway proxy.
ApplicationId (string) --
The unique identifier of the application.
Arn (string) --
he Amazon Resource Name (ARN) of the application.
CreatedByAccountId (string) --
The Amazon Web Services account ID of the application creator.
CreatedTime (datetime) --
A timestamp that indicates when the application is created.
EnvironmentId (string) --
The unique identifier of the environment.
Error (dict) --
Any error associated with the application resource.
AccountId (string) --
The Amazon Web Services account ID of the resource owner.
AdditionalDetails (dict) --
Additional details about the error.
(string) --
(string) --
Code (string) --
The error code associated with the error.
Message (string) --
The message associated with the error.
ResourceIdentifier (string) --
The ID of the resource.
ResourceType (string) --
The type of resource.
LastUpdatedTime (datetime) --
A timestamp that indicates when the application was last updated.
Name (string) --
The name of the application.
OwnerAccountId (string) --
The Amazon Web Services account ID of the application owner.
ProxyType (string) --
The proxy type of the proxy created within the application.
State (string) --
The current state of the application.
Tags (dict) --
The tags assigned to the application.
(string) --
(string) --
VpcId (string) --
The ID of the virtual private cloud (VPC).
NextToken (string) --
The token for the next page of results.
Gets an Amazon Web Services Migration Hub Refactor Spaces route.
See also: AWS API Documentation
Request Syntax
client.get_route(
ApplicationIdentifier='string',
EnvironmentIdentifier='string',
RouteIdentifier='string'
)
string
[REQUIRED]
The ID of the application.
string
[REQUIRED]
The ID of the environment.
string
[REQUIRED]
The ID of the route.
dict
Response Syntax
{
'ApplicationId': 'string',
'Arn': 'string',
'CreatedByAccountId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'EnvironmentId': 'string',
'Error': {
'AccountId': 'string',
'AdditionalDetails': {
'string': '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(2015, 1, 1),
'Methods': [
'DELETE'|'GET'|'HEAD'|'OPTIONS'|'PATCH'|'POST'|'PUT',
],
'OwnerAccountId': 'string',
'PathResourceToId': {
'string': 'string'
},
'RouteId': 'string',
'RouteType': 'DEFAULT'|'URI_PATH',
'ServiceId': 'string',
'SourcePath': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'INACTIVE',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ApplicationId (string) --
The ID of the application that the route belongs to.
Arn (string) --
The Amazon Resource Name (ARN) of the route.
CreatedByAccountId (string) --
The Amazon Web Services account ID of the route creator.
CreatedTime (datetime) --
The timestamp of when the route is created.
EnvironmentId (string) --
Unique identifier of the environment.
Error (dict) --
Any error associated with the route resource.
AccountId (string) --
The Amazon Web Services account ID of the resource owner.
AdditionalDetails (dict) --
Additional details about the error.
(string) --
(string) --
Code (string) --
The error code associated with the error.
Message (string) --
The message associated with the error.
ResourceIdentifier (string) --
The ID of the resource.
ResourceType (string) --
The type of resource.
IncludeChildPaths (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 (datetime) --
A timestamp that indicates when the route was last updated.
Methods (list) --
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.
(string) --
OwnerAccountId (string) --
The Amazon Web Services account ID of the route owner.
PathResourceToId (dict) --
A mapping of Amazon API Gateway path resources to resource IDs.
(string) --
(string) --
RouteId (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 (string) --
The type of route.
ServiceId (string) --
The unique identifier of the service.
SourcePath (string) --
The path to use to match traffic. Paths must start with / and are relative to the base of the application.
State (string) --
The current state of the route.
Tags (dict) --
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.
(string) --
(string) --
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.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
list
[REQUIRED]
The list of keys of the tags to be removed from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Gets an Amazon Web Services Migration Hub Refactor Spaces service.
See also: AWS API Documentation
Request Syntax
client.get_service(
ApplicationIdentifier='string',
EnvironmentIdentifier='string',
ServiceIdentifier='string'
)
string
[REQUIRED]
The ID of the application.
string
[REQUIRED]
The ID of the environment.
string
[REQUIRED]
The ID of the service.
dict
Response Syntax
{
'ApplicationId': 'string',
'Arn': 'string',
'CreatedByAccountId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Description': 'string',
'EndpointType': 'LAMBDA'|'URL',
'EnvironmentId': 'string',
'Error': {
'AccountId': 'string',
'AdditionalDetails': {
'string': '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(2015, 1, 1),
'Name': 'string',
'OwnerAccountId': 'string',
'ServiceId': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
'Tags': {
'string': 'string'
},
'UrlEndpoint': {
'HealthUrl': 'string',
'Url': 'string'
},
'VpcId': 'string'
}
Response Structure
(dict) --
ApplicationId (string) --
The ID of the application.
Arn (string) --
The Amazon Resource Name (ARN) of the service.
CreatedByAccountId (string) --
The Amazon Web Services account ID of the service creator.
CreatedTime (datetime) --
The timestamp of when the service is created.
Description (string) --
The description of the service.
EndpointType (string) --
The endpoint type of the service.
EnvironmentId (string) --
The unique identifier of the environment.
Error (dict) --
Any error associated with the service resource.
AccountId (string) --
The Amazon Web Services account ID of the resource owner.
AdditionalDetails (dict) --
Additional details about the error.
(string) --
(string) --
Code (string) --
The error code associated with the error.
Message (string) --
The message associated with the error.
ResourceIdentifier (string) --
The ID of the resource.
ResourceType (string) --
The type of resource.
LambdaEndpoint (dict) --
The configuration for the Lambda endpoint type.
The Arn is the Amazon Resource Name (ARN) of the Lambda function associated with this service.
Arn (string) --
The Amazon Resource Name (ARN) of the Lambda endpoint.
LastUpdatedTime (datetime) --
A timestamp that indicates when the service was last updated.
Name (string) --
The name of the service.
OwnerAccountId (string) --
The Amazon Web Services account ID of the service owner.
ServiceId (string) --
The unique identifier of the service.
State (string) --
The current state of the service.
Tags (dict) --
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.
(string) --
(string) --
UrlEndpoint (dict) --
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.
HealthUrl (string) --
The health check URL of the URL endpoint type.
Url (string) --
The HTTP URL endpoint.
VpcId (string) --
The ID of the virtual private cloud (VPC).
Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.
See also: AWS API Documentation
Request Syntax
client.list_environments(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
dict
Response Syntax
{
'EnvironmentSummaryList': [
{
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Description': 'string',
'EnvironmentId': 'string',
'Error': {
'AccountId': 'string',
'AdditionalDetails': {
'string': '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(2015, 1, 1),
'Name': 'string',
'NetworkFabricType': 'TRANSIT_GATEWAY',
'OwnerAccountId': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
'Tags': {
'string': 'string'
},
'TransitGatewayId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EnvironmentSummaryList (list) --
The list of EnvironmentSummary objects.
(dict) --
The summary information for environments as a response to ListEnvironments .
Arn (string) --
The Amazon Resource Name (ARN) of the environment.
CreatedTime (datetime) --
A timestamp that indicates when the environment is created.
Description (string) --
A description of the environment.
EnvironmentId (string) --
The unique identifier of the environment.
Error (dict) --
Any error associated with the environment resource.
AccountId (string) --
The Amazon Web Services account ID of the resource owner.
AdditionalDetails (dict) --
Additional details about the error.
(string) --
(string) --
Code (string) --
The error code associated with the error.
Message (string) --
The message associated with the error.
ResourceIdentifier (string) --
The ID of the resource.
ResourceType (string) --
The type of resource.
LastUpdatedTime (datetime) --
A timestamp that indicates when the environment was last updated.
Name (string) --
The name of the environment.
NetworkFabricType (string) --
The network fabric type of the environment.
OwnerAccountId (string) --
The Amazon Web Services account ID of the environment owner.
State (string) --
The current state of the environment.
Tags (dict) --
The tags assigned to the environment.
(string) --
(string) --
TransitGatewayId (string) --
The ID of the transit gateway set up by the environment.
NextToken (string) --
The token for the next page of results.
Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
See also: AWS API Documentation
Request Syntax
client.delete_service(
ApplicationIdentifier='string',
EnvironmentIdentifier='string',
ServiceIdentifier='string'
)
string
[REQUIRED]
Deletes a Refactor Spaces service.
Note
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.
string
[REQUIRED]
The ID of the environment that the service is in.
string
[REQUIRED]
The ID of the service to delete.
dict
Response Syntax
{
'ApplicationId': 'string',
'Arn': 'string',
'EnvironmentId': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'Name': 'string',
'ServiceId': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'
}
Response Structure
(dict) --
ApplicationId (string) --
The ID of the application that the service is in.
Arn (string) --
The Amazon Resource Name (ARN) of the service.
EnvironmentId (string) --
The unique identifier of the environment.
LastUpdatedTime (datetime) --
A timestamp that indicates when the service was last updated.
Name (string) --
The name of the service.
ServiceId (string) --
The unique identifier of the service.
State (string) --
The current state of the service.
Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
See also: AWS API Documentation
Request Syntax
client.list_routes(
ApplicationIdentifier='string',
EnvironmentIdentifier='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the application.
string
[REQUIRED]
The ID of the environment.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
dict
Response Syntax
{
'NextToken': 'string',
'RouteSummaryList': [
{
'ApplicationId': 'string',
'Arn': 'string',
'CreatedByAccountId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'EnvironmentId': 'string',
'Error': {
'AccountId': 'string',
'AdditionalDetails': {
'string': '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(2015, 1, 1),
'Methods': [
'DELETE'|'GET'|'HEAD'|'OPTIONS'|'PATCH'|'POST'|'PUT',
],
'OwnerAccountId': 'string',
'PathResourceToId': {
'string': 'string'
},
'RouteId': 'string',
'RouteType': 'DEFAULT'|'URI_PATH',
'ServiceId': 'string',
'SourcePath': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'INACTIVE',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token for the next page of results.
RouteSummaryList (list) --
The list of RouteSummary objects.
(dict) --
The summary information for the routes as a response to ListRoutes .
ApplicationId (string) --
The unique identifier of the application.
Arn (string) --
The Amazon Resource Name (ARN) of the route.
CreatedByAccountId (string) --
The Amazon Web Services account ID of the route creator.
CreatedTime (datetime) --
A timestamp that indicates when the route is created.
EnvironmentId (string) --
The unique identifier of the environment.
Error (dict) --
Any error associated with the route resource.
AccountId (string) --
The Amazon Web Services account ID of the resource owner.
AdditionalDetails (dict) --
Additional details about the error.
(string) --
(string) --
Code (string) --
The error code associated with the error.
Message (string) --
The message associated with the error.
ResourceIdentifier (string) --
The ID of the resource.
ResourceType (string) --
The type of resource.
IncludeChildPaths (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 (datetime) --
A timestamp that indicates when the route was last updated.
Methods (list) --
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.
(string) --
OwnerAccountId (string) --
The Amazon Web Services account ID of the route owner.
PathResourceToId (dict) --
A mapping of Amazon API Gateway path resources to resource IDs.
(string) --
(string) --
RouteId (string) --
The unique identifier of the route.
RouteType (string) --
The route type of the route.
ServiceId (string) --
The unique identifier of the service.
SourcePath (string) --
The path to use to match traffic. Paths must start with / and are relative to the base of the application.
State (string) --
The current state of the route.
Tags (dict) --
The tags assigned to the route.
(string) --
(string) --
Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
See also: AWS API Documentation
Request Syntax
client.get_environment(
EnvironmentIdentifier='string'
)
string
[REQUIRED]
The ID of the environment.
dict
Response Syntax
{
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Description': 'string',
'EnvironmentId': 'string',
'Error': {
'AccountId': 'string',
'AdditionalDetails': {
'string': '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(2015, 1, 1),
'Name': 'string',
'NetworkFabricType': 'TRANSIT_GATEWAY',
'OwnerAccountId': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
'Tags': {
'string': 'string'
},
'TransitGatewayId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the environment.
CreatedTime (datetime) --
A timestamp that indicates when the environment is created.
Description (string) --
The description of the environment.
EnvironmentId (string) --
The unique identifier of the environment.
Error (dict) --
Any error associated with the environment resource.
AccountId (string) --
The Amazon Web Services account ID of the resource owner.
AdditionalDetails (dict) --
Additional details about the error.
(string) --
(string) --
Code (string) --
The error code associated with the error.
Message (string) --
The message associated with the error.
ResourceIdentifier (string) --
The ID of the resource.
ResourceType (string) --
The type of resource.
LastUpdatedTime (datetime) --
A timestamp that indicates when the environment was last updated.
Name (string) --
The name of the environment.
NetworkFabricType (string) --
The network fabric type of the environment.
OwnerAccountId (string) --
The Amazon Web Services account ID of the environment owner.
State (string) --
The current state of the environment.
Tags (dict) --
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.
(string) --
(string) --
TransitGatewayId (string) --
The ID of the transit gateway set up by the environment.
Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
See also: AWS API Documentation
Request Syntax
client.delete_route(
ApplicationIdentifier='string',
EnvironmentIdentifier='string',
RouteIdentifier='string'
)
string
[REQUIRED]
The ID of the application to delete the route from.
string
[REQUIRED]
The ID of the environment to delete the route from.
string
[REQUIRED]
The ID of the route to delete.
dict
Response Syntax
{
'ApplicationId': 'string',
'Arn': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'RouteId': 'string',
'ServiceId': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'INACTIVE'
}
Response Structure
(dict) --
ApplicationId (string) --
he ID of the application that the route belongs to.
Arn (string) --
The Amazon Resource Name (ARN) of the route.
LastUpdatedTime (datetime) --
A timestamp that indicates when the route was last updated.
RouteId (string) --
The ID of the route to delete.
ServiceId (string) --
The ID of the service that the route belongs to.
State (string) --
The current state of the route.
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.
See also: AWS API Documentation
Request Syntax
client.put_resource_policy(
Policy='string',
ResourceArn='string'
)
string
[REQUIRED]
A JSON-formatted string for an Amazon Web Services resource-based policy.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to which the policy is being attached.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
See also: AWS API Documentation
Request Syntax
client.list_services(
ApplicationIdentifier='string',
EnvironmentIdentifier='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the application.
string
[REQUIRED]
The ID of the environment.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
dict
Response Syntax
{
'NextToken': 'string',
'ServiceSummaryList': [
{
'ApplicationId': 'string',
'Arn': 'string',
'CreatedByAccountId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Description': 'string',
'EndpointType': 'LAMBDA'|'URL',
'EnvironmentId': 'string',
'Error': {
'AccountId': 'string',
'AdditionalDetails': {
'string': '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(2015, 1, 1),
'Name': 'string',
'OwnerAccountId': 'string',
'ServiceId': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
'Tags': {
'string': 'string'
},
'UrlEndpoint': {
'HealthUrl': 'string',
'Url': 'string'
},
'VpcId': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token for the next page of results.
ServiceSummaryList (list) --
The list of ServiceSummary objects.
(dict) --
A summary for the service as a response to ListServices .
ApplicationId (string) --
The unique identifier of the application.
Arn (string) --
The Amazon Resource Name (ARN) of the service.
CreatedByAccountId (string) --
The Amazon Web Services account ID of the service creator.
CreatedTime (datetime) --
A timestamp that indicates when the service is created.
Description (string) --
A description of the service.
EndpointType (string) --
The endpoint type of the service.
EnvironmentId (string) --
The unique identifier of the environment.
Error (dict) --
Any error associated with the service resource.
AccountId (string) --
The Amazon Web Services account ID of the resource owner.
AdditionalDetails (dict) --
Additional details about the error.
(string) --
(string) --
Code (string) --
The error code associated with the error.
Message (string) --
The message associated with the error.
ResourceIdentifier (string) --
The ID of the resource.
ResourceType (string) --
The type of resource.
LambdaEndpoint (dict) --
A summary of the configuration for the Lambda endpoint type.
Arn (string) --
The Amazon Resource Name (ARN) of the Lambda endpoint.
LastUpdatedTime (datetime) --
A timestamp that indicates when the service was last updated.
Name (string) --
The name of the service.
OwnerAccountId (string) --
The Amazon Web Services account ID of the service owner.
ServiceId (string) --
The unique identifier of the service.
State (string) --
The current state of the service.
Tags (dict) --
The tags assigned to the service.
(string) --
(string) --
UrlEndpoint (dict) --
The summary of the configuration for the URL endpoint type.
HealthUrl (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 (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.
VpcId (string) --
The ID of the virtual private cloud (VPC).
Deletes the resource policy set for the environment.
See also: AWS API Documentation
Request Syntax
client.delete_resource_policy(
Identifier='string'
)
string
[REQUIRED]
Amazon Resource Name (ARN) of the resource associated with the policy.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
Warning
If an Amazon Web Services resourceis 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.
See also: AWS API Documentation
Request Syntax
client.create_service(
ApplicationIdentifier='string',
ClientToken='string',
Description='string',
EndpointType='LAMBDA'|'URL',
EnvironmentIdentifier='string',
LambdaEndpoint={
'Arn': 'string'
},
Name='string',
Tags={
'string': 'string'
},
UrlEndpoint={
'HealthUrl': 'string',
'Url': 'string'
},
VpcId='string'
)
string
[REQUIRED]
The ID of the application which the service is created.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
The description of the service.
string
[REQUIRED]
The type of endpoint to use for the service. The type can be a URL in a VPC or an Lambda function.
string
[REQUIRED]
The ID of the environment in which the service is created.
dict
The configuration for the Lambda endpoint type.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Lambda endpoint.
string
[REQUIRED]
The name of the service.
dict
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..
(string) --
(string) --
dict
The configuration for the URL endpoint type.
HealthUrl (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 (string) -- [REQUIRED]
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.
string
The ID of the VPC.
dict
Response Syntax
{
'ApplicationId': 'string',
'Arn': 'string',
'CreatedByAccountId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Description': 'string',
'EndpointType': 'LAMBDA'|'URL',
'EnvironmentId': 'string',
'LambdaEndpoint': {
'Arn': 'string'
},
'LastUpdatedTime': datetime(2015, 1, 1),
'Name': 'string',
'OwnerAccountId': 'string',
'ServiceId': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
'Tags': {
'string': 'string'
},
'UrlEndpoint': {
'HealthUrl': 'string',
'Url': 'string'
},
'VpcId': 'string'
}
Response Structure
(dict) --
ApplicationId (string) --
The ID of the application that the created service belongs to.
Arn (string) --
The Amazon Resource Name (ARN) of the service.
CreatedByAccountId (string) --
The Amazon Web Services account ID of the service creator.
CreatedTime (datetime) --
A timestamp that indicates when the service is created.
Description (string) --
The description of the created service.
EndpointType (string) --
The endpoint type of the service.
EnvironmentId (string) --
The unique identifier of the environment.
LambdaEndpoint (dict) --
The configuration for the Lambda endpoint type.
Arn (string) --
The Amazon Resource Name (ARN) of the Lambda endpoint.
LastUpdatedTime (datetime) --
A timestamp that indicates when the service was last updated.
Name (string) --
The name of the service.
OwnerAccountId (string) --
The Amazon Web Services account ID of the service owner.
ServiceId (string) --
The unique identifier of the service.
State (string) --
The current state of the service.
Tags (dict) --
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..
(string) --
(string) --
UrlEndpoint (dict) --
The configuration for the URL endpoint type.
HealthUrl (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 (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.
VpcId (string) --
The ID of the VPC.
Lists all the virtual private clouds (VPCs) that are part of an Amazon Web Services Migration Hub Refactor Spaces environment.
See also: AWS API Documentation
Request Syntax
client.list_environment_vpcs(
EnvironmentIdentifier='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the environment.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
dict
Response Syntax
{
'EnvironmentVpcList': [
{
'AccountId': 'string',
'CidrBlocks': [
'string',
],
'CreatedTime': datetime(2015, 1, 1),
'EnvironmentId': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'VpcId': 'string',
'VpcName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EnvironmentVpcList (list) --
The list of EnvironmentVpc objects.
(dict) --
Provides summary information for the EnvironmentVpc resource as a response to ListEnvironmentVpc .
AccountId (string) --
The Amazon Web Services account ID of the virtual private cloud (VPC) owner.
CidrBlocks (list) --
The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.
(string) --
CreatedTime (datetime) --
A timestamp that indicates when the VPC is first added to the environment.
EnvironmentId (string) --
The unique identifier of the environment.
LastUpdatedTime (datetime) --
A timestamp that indicates when the VPC was last updated by the environment.
VpcId (string) --
The ID of the VPC.
VpcName (string) --
The name of the VPC at the time it is added to the environment.
NextToken (string) --
The token for the next page of results.
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 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 uses the API Gateway Lambda integration.
A health check is performed on the service when the route is created. If the health check fails, the route transitions to FAILED , 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 public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails. For private URLs, a target group is created 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.
See also: AWS API Documentation
Request Syntax
client.create_route(
ApplicationIdentifier='string',
ClientToken='string',
EnvironmentIdentifier='string',
RouteType='DEFAULT'|'URI_PATH',
ServiceIdentifier='string',
Tags={
'string': 'string'
},
UriPathRoute={
'ActivationState': 'ACTIVE',
'IncludeChildPaths': True|False,
'Methods': [
'DELETE'|'GET'|'HEAD'|'OPTIONS'|'PATCH'|'POST'|'PUT',
],
'SourcePath': 'string'
}
)
string
[REQUIRED]
The ID of the application within which the route is being created.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the environment in which the route is created.
string
[REQUIRED]
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.
string
[REQUIRED]
The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.
dict
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..
(string) --
(string) --
dict
The configuration for the URI path route type.
ActivationState (string) -- [REQUIRED]
Indicates whether traffic is forwarded to this route’s service after the route is created.
IncludeChildPaths (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 (list) --
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.
(string) --
SourcePath (string) -- [REQUIRED]
The path to use to match traffic. Paths must start with / and are relative to the base of the application.
dict
Response Syntax
{
'ApplicationId': 'string',
'Arn': 'string',
'CreatedByAccountId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'OwnerAccountId': 'string',
'RouteId': 'string',
'RouteType': 'DEFAULT'|'URI_PATH',
'ServiceId': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'INACTIVE',
'Tags': {
'string': 'string'
},
'UriPathRoute': {
'ActivationState': 'ACTIVE',
'IncludeChildPaths': True|False,
'Methods': [
'DELETE'|'GET'|'HEAD'|'OPTIONS'|'PATCH'|'POST'|'PUT',
],
'SourcePath': 'string'
}
}
Response Structure
(dict) --
ApplicationId (string) --
The ID of the application in which the route is created.
Arn (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 (string) --
The Amazon Web Services account ID of the route creator.
CreatedTime (datetime) --
A timestamp that indicates when the route is created.
LastUpdatedTime (datetime) --
A timestamp that indicates when the route was last updated.
OwnerAccountId (string) --
The Amazon Web Services account ID of the route owner.
RouteId (string) --
The unique identifier of the route.
RouteType (string) --
The route type of the route.
ServiceId (string) --
The ID of service in which the rute iscreated. Traffic that matches this route is forwarded to this service.
State (string) --
he current state of the route.
Tags (dict) --
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.
(string) --
(string) --
UriPathRoute (dict) --
onfiguration for the URI path route type.
ActivationState (string) --
Indicates whether traffic is forwarded to this route’s service after the route is created.
IncludeChildPaths (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 (list) --
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.
(string) --
SourcePath (string) --
The path to use to match traffic. Paths must start with / and are relative to the base of the application.
Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and 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, Refactor Spaces provisions a transit gateway in your account.
See also: AWS API Documentation
Request Syntax
client.create_environment(
ClientToken='string',
Description='string',
Name='string',
NetworkFabricType='TRANSIT_GATEWAY',
Tags={
'string': 'string'
}
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
The description of the environment.
string
[REQUIRED]
The name of the environment.
string
[REQUIRED]
The network fabric type of the environment.
dict
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.
(string) --
(string) --
dict
Response Syntax
{
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Description': 'string',
'EnvironmentId': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'Name': 'string',
'NetworkFabricType': 'TRANSIT_GATEWAY',
'OwnerAccountId': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the environment.
CreatedTime (datetime) --
A timestamp that indicates when the environment is created.
Description (string) --
A description of the environment.
EnvironmentId (string) --
The unique identifier of the environment.
LastUpdatedTime (datetime) --
A timestamp that indicates when the environment was last updated.
Name (string) --
The name of the environment.
NetworkFabricType (string) --
The network fabric type of the environment.
OwnerAccountId (string) --
The Amazon Web Services account ID of environment owner.
State (string) --
The current state of the environment.
Tags (dict) --
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..
(string) --
(string) --
Gets an Amazon Web Services Migration Hub Refactor Spaces application.
See also: AWS API Documentation
Request Syntax
client.get_application(
ApplicationIdentifier='string',
EnvironmentIdentifier='string'
)
string
[REQUIRED]
The ID of the application.
string
[REQUIRED]
The ID of the environment.
dict
Response 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(2015, 1, 1),
'EnvironmentId': 'string',
'Error': {
'AccountId': 'string',
'AdditionalDetails': {
'string': '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(2015, 1, 1),
'Name': 'string',
'OwnerAccountId': 'string',
'ProxyType': 'API_GATEWAY',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
'Tags': {
'string': 'string'
},
'VpcId': 'string'
}
Response Structure
(dict) --
ApiGatewayProxy (dict) --
The endpoint URL of the API Gateway proxy.
ApiGatewayId (string) --
The resource ID of the API Gateway for the proxy.
EndpointType (string) --
The type of API Gateway endpoint created.
NlbArn (string) --
The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.
NlbName (string) --
The name of the Network Load Balancer that is configured by the API Gateway proxy.
ProxyUrl (string) --
The endpoint URL of the API Gateway proxy.
StageName (string) --
The name of the API Gateway stage. The name defaults to prod .
VpcLinkId (string) --
The VpcLink ID of the API Gateway proxy.
ApplicationId (string) --
The unique identifier of the application.
Arn (string) --
The Amazon Resource Name (ARN) of the application.
CreatedByAccountId (string) --
The Amazon Web Services account ID of the application creator.
CreatedTime (datetime) --
A timestamp that indicates when the application is created.
EnvironmentId (string) --
The unique identifier of the environment.
Error (dict) --
Any error associated with the application resource.
AccountId (string) --
The Amazon Web Services account ID of the resource owner.
AdditionalDetails (dict) --
Additional details about the error.
(string) --
(string) --
Code (string) --
The error code associated with the error.
Message (string) --
The message associated with the error.
ResourceIdentifier (string) --
The ID of the resource.
ResourceType (string) --
The type of resource.
LastUpdatedTime (datetime) --
A timestamp that indicates when the application was last updated.
Name (string) --
The name of the application.
OwnerAccountId (string) --
The Amazon Web Services account ID of the application owner.
ProxyType (string) --
The proxy type of the proxy created within the application.
State (string) --
The current state of the application.
Tags (dict) --
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.
(string) --
(string) --
VpcId (string) --
The ID of the virtual private cloud (VPC).
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.
Note
Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an environment’s transit gateway.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource
dict
[REQUIRED]
The new or modified tags for the resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.delete_application(
ApplicationIdentifier='string',
EnvironmentIdentifier='string'
)
string
[REQUIRED]
The ID of the application.
string
[REQUIRED]
The ID of the environment.
dict
Response Syntax
{
'ApplicationId': 'string',
'Arn': 'string',
'EnvironmentId': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'Name': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'
}
Response Structure
(dict) --
ApplicationId (string) --
The ID of the application.
Arn (string) --
The Amazon Resource Name (ARN) of the application.
EnvironmentId (string) --
The unique identifier of the application’s environment.
LastUpdatedTime (datetime) --
A timestamp that indicates when the environment was last updated.
Name (string) --
The name of the application.
State (string) --
The current state of the application.
Gets the resource-based permission policy that is set for the given environment.
See also: AWS API Documentation
Request Syntax
client.get_resource_policy(
Identifier='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource associated with the policy.
dict
Response Syntax
{
'Policy': 'string'
}
Response Structure
(dict) --
Policy (string) --
A JSON-formatted string for an Amazon Web Services resource-based policy.
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 the Amazon API Gateway and Network Load Balancer for the application proxy inside your account.
See also: AWS API Documentation
Request Syntax
client.create_application(
ApiGatewayProxy={
'EndpointType': 'REGIONAL'|'PRIVATE',
'StageName': 'string'
},
ClientToken='string',
EnvironmentIdentifier='string',
Name='string',
ProxyType='API_GATEWAY',
Tags={
'string': 'string'
},
VpcId='string'
)
dict
A wrapper object holding the API Gateway endpoint type and stage name for the proxy.
EndpointType (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 (string) --
The name of the API Gateway stage. The name defaults to prod .
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the environment.
string
[REQUIRED]
The name to use for the application.
string
[REQUIRED]
The proxy type of the proxy created within the application.
dict
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.
(string) --
(string) --
string
[REQUIRED]
The ID of the virtual private cloud (VPC).
dict
Response Syntax
{
'ApiGatewayProxy': {
'EndpointType': 'REGIONAL'|'PRIVATE',
'StageName': 'string'
},
'ApplicationId': 'string',
'Arn': 'string',
'CreatedByAccountId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'EnvironmentId': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'Name': 'string',
'OwnerAccountId': 'string',
'ProxyType': 'API_GATEWAY',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
'Tags': {
'string': 'string'
},
'VpcId': 'string'
}
Response Structure
(dict) --
ApiGatewayProxy (dict) --
A wrapper object holding the API Gateway endpoint type and stage name for the proxy.
EndpointType (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 (string) --
The name of the API Gateway stage. The name defaults to prod .
ApplicationId (string) --
The unique identifier of the application.
Arn (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 (string) --
The Amazon Web Services account ID of application creator.
CreatedTime (datetime) --
A timestamp that indicates when the application is created.
EnvironmentId (string) --
The ID of the environment in which the application is created.
LastUpdatedTime (datetime) --
A timestamp that indicates when the application was last updated.
Name (string) --
The name of the application.
OwnerAccountId (string) --
The Amazon Web Services account ID of the application owner.
ProxyType (string) --
The proxy type of the proxy created within the application.
State (string) --
The current state of the application.
Tags (dict) --
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.
(string) --
(string) --
VpcId (string) --
The ID of the Amazon VPC.
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.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
The list of tags assigned to the resource.
(string) --
(string) --
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.
See also: AWS API Documentation
Request Syntax
client.delete_environment(
EnvironmentIdentifier='string'
)
string
[REQUIRED]
The ID of the environment.
dict
Response Syntax
{
'Arn': 'string',
'EnvironmentId': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'Name': 'string',
'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the environment.
EnvironmentId (string) --
The unique identifier of the environment.
LastUpdatedTime (datetime) --
A timestamp that indicates when the environment was last updated.
Name (string) --
The name of the environment.
State (string) --
The current state of the environment.