MigrationHubRefactorSpaces

Client

class MigrationHubRefactorSpaces.Client

A low-level client representing AWS Migration Hub Refactor Spaces

<p>This API reference provides descriptions, syntax, and other details about each of the actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>To share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations and their OUs, use Resource Access Manager's <code>CreateResourceShare</code> API. See <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html">CreateResourceShare</a> in the <i>Amazon Web Services RAM API Reference</i>.</p>

client = session.create_client('migration-hub-refactor-spaces')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_application(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_application(
    ApiGatewayProxy={
        'EndpointType': 'REGIONAL'|'PRIVATE',
        'StageName': 'string'
    },
    ClientToken='string',
    EnvironmentIdentifier='string',
    Name='string',
    ProxyType='API_GATEWAY',
    Tags={
        'string': 'string'
    },
    VpcId='string'
)
Parameters
  • 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 .

  • ClientToken (string) --

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

    This field is autopopulated if not provided.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The unique identifier of the environment.

  • Name (string) --

    [REQUIRED]

    The name to use for the application.

  • ProxyType (string) --

    [REQUIRED]

    The proxy type of the proxy created within the application.

  • Tags (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) --
  • VpcId (string) --

    [REQUIRED]

    The ID of the virtual private cloud (VPC).

Return type

dict

Returns

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 (which is always the same as the environment owner account ID).

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

Exceptions

create_environment(**kwargs)

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, Refactor Spaces provisions a transit gateway in your account.

See also: AWS API Documentation

Request Syntax

response = client.create_environment(
    ClientToken='string',
    Description='string',
    Name='string',
    NetworkFabricType='TRANSIT_GATEWAY',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ClientToken (string) --

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

    This field is autopopulated if not provided.

  • Description (string) -- The description of the environment.
  • Name (string) --

    [REQUIRED]

    The name of the environment.

  • NetworkFabricType (string) --

    [REQUIRED]

    The network fabric type 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) --
Return type

dict

Returns

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

Exceptions

create_route(**kwargs)

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.

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.

See also: AWS API Documentation

Request Syntax

response = client.create_route(
    ApplicationIdentifier='string',
    ClientToken='string',
    DefaultRoute={
        'ActivationState': 'ACTIVE'|'INACTIVE'
    },
    EnvironmentIdentifier='string',
    RouteType='DEFAULT'|'URI_PATH',
    ServiceIdentifier='string',
    Tags={
        'string': 'string'
    },
    UriPathRoute={
        'ActivationState': 'ACTIVE'|'INACTIVE',
        'IncludeChildPaths': True|False,
        'Methods': [
            'DELETE'|'GET'|'HEAD'|'OPTIONS'|'PATCH'|'POST'|'PUT',
        ],
        'SourcePath': 'string'
    }
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

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

  • ClientToken (string) --

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

    This field is autopopulated if not provided.

  • DefaultRoute (dict) --

    Configuration for the default route type.

    • ActivationState (string) --

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

  • EnvironmentIdentifier (string) --

    [REQUIRED]

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

  • RouteType (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.

  • ServiceIdentifier (string) --

    [REQUIRED]

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

  • Tags (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) --
  • UriPathRoute (dict) --

    The configuration for the URI path route type.

    • ActivationState (string) -- [REQUIRED]

      If set to ACTIVE , 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.

Return type

dict

Returns

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'|'INACTIVE',
        '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 route is created. Traffic that matches this route is forwarded to this service.

    • State (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 (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) --

      Configuration for the URI path route type.

      • ActivationState (string) --

        If set to ACTIVE , 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.

Exceptions

create_service(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = 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'
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

    The ID of the application which the service is created.

  • ClientToken (string) --

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

    This field is autopopulated if not provided.

  • Description (string) -- The description of the service.
  • EndpointType (string) --

    [REQUIRED]

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

  • EnvironmentIdentifier (string) --

    [REQUIRED]

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

  • LambdaEndpoint (dict) --

    The configuration for the Lambda endpoint type.

    • Arn (string) -- [REQUIRED]

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

  • Name (string) --

    [REQUIRED]

    The name of the service.

  • Tags (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) --
  • 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) -- [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 .

  • VpcId (string) -- The ID of the VPC.
Return type

dict

Returns

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.

Exceptions

delete_application(**kwargs)

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

response = client.delete_application(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string'
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

    The ID of the application.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

Return type

dict

Returns

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.

Exceptions

delete_environment(**kwargs)

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

response = client.delete_environment(
    EnvironmentIdentifier='string'
)
Parameters
EnvironmentIdentifier (string) --

[REQUIRED]

The ID of the environment.

Return type
dict
Returns
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.

Exceptions

delete_resource_policy(**kwargs)

Deletes the resource policy set for the environment.

See also: AWS API Documentation

Request Syntax

response = client.delete_resource_policy(
    Identifier='string'
)
Parameters
Identifier (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_route(**kwargs)

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

See also: AWS API Documentation

Request Syntax

response = client.delete_route(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    RouteIdentifier='string'
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

    The ID of the application to delete the route from.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment to delete the route from.

  • RouteIdentifier (string) --

    [REQUIRED]

    The ID of the route to delete.

Return type

dict

Returns

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

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

Exceptions

delete_service(**kwargs)

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

See also: AWS API Documentation

Request Syntax

response = client.delete_service(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    ServiceIdentifier='string'
)
Parameters
  • ApplicationIdentifier (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.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment that the service is in.

  • ServiceIdentifier (string) --

    [REQUIRED]

    The ID of the service to delete.

Return type

dict

Returns

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.

Exceptions

get_application(**kwargs)

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

See also: AWS API Documentation

Request Syntax

response = client.get_application(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string'
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

    The ID of the application.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

Return type

dict

Returns

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 (which is always the same as the environment owner account ID).

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

Exceptions

get_environment(**kwargs)

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

See also: AWS API Documentation

Request Syntax

response = client.get_environment(
    EnvironmentIdentifier='string'
)
Parameters
EnvironmentIdentifier (string) --

[REQUIRED]

The ID of the environment.

Return type
dict
Returns
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.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_resource_policy(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_resource_policy(
    Identifier='string'
)
Parameters
Identifier (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'Policy': 'string'
}

Response Structure

  • (dict) --
    • Policy (string) --

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

Exceptions

get_route(**kwargs)

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

See also: AWS API Documentation

Request Syntax

response = client.get_route(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    RouteIdentifier='string'
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

    The ID of the application.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

  • RouteIdentifier (string) --

    [REQUIRED]

    The ID of the route.

Return type

dict

Returns

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

Exceptions

get_service(**kwargs)

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

See also: AWS API Documentation

Request Syntax

response = client.get_service(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    ServiceIdentifier='string'
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

    The ID of the application.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

  • ServiceIdentifier (string) --

    [REQUIRED]

    The ID of the service.

Return type

dict

Returns

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

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_applications(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_applications(
    EnvironmentIdentifier='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

  • MaxResults (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.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

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

          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 (which is always the same as the environment owner account ID).

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

Exceptions

list_environment_vpcs(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_environment_vpcs(
    EnvironmentIdentifier='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

  • MaxResults (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.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

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.

Exceptions

list_environments(**kwargs)

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

response = client.list_environments(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (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.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

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.

Exceptions

list_routes(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_routes(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

    The ID of the application.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

  • MaxResults (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.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

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

Exceptions

list_services(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_services(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

    The ID of the application.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

  • MaxResults (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.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

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

Exceptions

list_tags_for_resource(**kwargs)

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

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      The list of tags assigned to the resource.

      • (string) --
        • (string) --

Exceptions

put_resource_policy(**kwargs)

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

response = client.put_resource_policy(
    Policy='string',
    ResourceArn='string'
)
Parameters
  • Policy (string) --

    [REQUIRED]

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

  • ResourceArn (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

tag_resource(**kwargs)

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

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • Tags (dict) --

    [REQUIRED]

    The new or modified tags for the resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

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

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • TagKeys (list) --

    [REQUIRED]

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

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_route(**kwargs)

Updates an Amazon Web Services Migration Hub Refactor Spaces route.

See also: AWS API Documentation

Request Syntax

response = client.update_route(
    ActivationState='ACTIVE'|'INACTIVE',
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    RouteIdentifier='string'
)
Parameters
  • ActivationState (string) --

    [REQUIRED]

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

  • ApplicationIdentifier (string) --

    [REQUIRED]

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

  • EnvironmentIdentifier (string) --

    [REQUIRED]

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

  • RouteIdentifier (string) --

    [REQUIRED]

    The unique identifier of the route to update.

Return type

dict

Returns

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

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

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

    • LastUpdatedTime (datetime) --

      A timestamp that indicates when the route was last updated.

    • RouteId (string) --

      The unique identifier of the route.

    • ServiceId (string) --

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

    • State (string) --

      The current state of the route.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class MigrationHubRefactorSpaces.Client.exceptions.AccessDeniedException

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

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MigrationHubRefactorSpaces.Client.exceptions.ConflictException

Updating or deleting a resource can cause an inconsistent state.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Updating or deleting a resource can cause an inconsistent state.

    • Message (string) --

    • ResourceId (string) --

      The ID of the resource.

    • ResourceType (string) --

      The type of resource.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MigrationHubRefactorSpaces.Client.exceptions.InternalServerException

An unexpected error occurred while processing the request.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An unexpected error occurred while processing the request.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MigrationHubRefactorSpaces.Client.exceptions.InvalidResourcePolicyException

The resource policy is not valid.

Example

try:
  ...
except client.exceptions.InvalidResourcePolicyException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource policy is not valid.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MigrationHubRefactorSpaces.Client.exceptions.ResourceNotFoundException

The request references a resource that does not exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request references a resource that does not exist.

    • Message (string) --

    • ResourceId (string) --

      The ID of the resource.

    • ResourceType (string) --

      The type of resource.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MigrationHubRefactorSpaces.Client.exceptions.ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'QuotaCode': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'ServiceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request would cause a service quota to be exceeded.

    • Message (string) --

    • QuotaCode (string) --

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

    • ResourceId (string) --

      The ID of the resource.

    • ResourceType (string) --

      The type of resource.

    • ServiceCode (string) --

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

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MigrationHubRefactorSpaces.Client.exceptions.ThrottlingException

Request was denied because the request was throttled.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'QuotaCode': 'string',
    'RetryAfterSeconds': 123,
    'ServiceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Request was denied because the request was throttled.

    • Message (string) --

    • QuotaCode (string) --

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

    • RetryAfterSeconds (integer) --

      The number of seconds to wait before retrying.

    • ServiceCode (string) --

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

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MigrationHubRefactorSpaces.Client.exceptions.ValidationException

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

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class MigrationHubRefactorSpaces.Paginator.ListApplications
paginator = client.get_paginator('list_applications')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MigrationHubRefactorSpaces.Client.list_applications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    EnvironmentIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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'
        },
    ],

}

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

          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 (which is always the same as the environment owner account ID).

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

class MigrationHubRefactorSpaces.Paginator.ListEnvironmentVpcs
paginator = client.get_paginator('list_environment_vpcs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MigrationHubRefactorSpaces.Client.list_environment_vpcs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    EnvironmentIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'EnvironmentVpcList': [
        {
            'AccountId': 'string',
            'CidrBlocks': [
                'string',
            ],
            'CreatedTime': datetime(2015, 1, 1),
            'EnvironmentId': 'string',
            'LastUpdatedTime': datetime(2015, 1, 1),
            'VpcId': 'string',
            'VpcName': '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.

class MigrationHubRefactorSpaces.Paginator.ListEnvironments
paginator = client.get_paginator('list_environments')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MigrationHubRefactorSpaces.Client.list_environments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
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'
        },
    ],

}

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.

class MigrationHubRefactorSpaces.Paginator.ListRoutes
paginator = client.get_paginator('list_routes')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MigrationHubRefactorSpaces.Client.list_routes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

    The ID of the application.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    '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) --

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

class MigrationHubRefactorSpaces.Paginator.ListServices
paginator = client.get_paginator('list_services')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MigrationHubRefactorSpaces.Client.list_services().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

    The ID of the application.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    '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) --

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