Skip to content

RouteSummary

Source code in docs_src/capo_migration_hub_refactor_spaces/types/route_summary.py
class RouteSummary(TypedDict, closed=True):
    route_id: NotRequired["capo_migration_hub_refactor_spaces.types.route_id.RouteId"]
    """<p>The unique identifier of the route. </p>"""
    arn: NotRequired[
        "capo_migration_hub_refactor_spaces.types.resource_arn.ResourceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the route. </p>"""
    owner_account_id: NotRequired[
        "capo_migration_hub_refactor_spaces.types.account_id.AccountId"
    ]
    """<p>The Amazon Web Services account ID of the route owner.</p>"""
    created_by_account_id: NotRequired[
        "capo_migration_hub_refactor_spaces.types.account_id.AccountId"
    ]
    """<p>The Amazon Web Services account ID of the route creator. </p>"""
    route_type: NotRequired[
        "capo_migration_hub_refactor_spaces.types.route_type.RouteType"
    ]
    """<p>The route type of the route. </p>"""
    service_id: NotRequired[
        "capo_migration_hub_refactor_spaces.types.service_id.ServiceId"
    ]
    """<p>The unique identifier of the service. </p>"""
    application_id: NotRequired[
        "capo_migration_hub_refactor_spaces.types.application_id.ApplicationId"
    ]
    """<p>The unique identifier of the application. </p>"""
    environment_id: NotRequired[
        "capo_migration_hub_refactor_spaces.types.environment_id.EnvironmentId"
    ]
    """<p>The unique identifier of the environment. </p>"""
    source_path: NotRequired[
        "capo_migration_hub_refactor_spaces.types.uri_path.UriPath"
    ]
    """<p>This is the path that Refactor Spaces uses to match traffic. Paths must start with <code>/</code> and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.</p>"""
    methods: NotRequired[
        "capo_migration_hub_refactor_spaces.types.http_methods.HttpMethods"
    ]
    """<p>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. </p>"""
    include_child_paths: NotRequired[
        "capo_migration_hub_refactor_spaces.types.boolean.Boolean"
    ]
    """<p>Indicates whether to match all subpaths of the given source path. If this value is <code>false</code>, requests must match the source path exactly before they are forwarded to this route's service.</p>"""
    path_resource_to_id: NotRequired[
        "capo_migration_hub_refactor_spaces.types.path_resource_to_id.PathResourceToId"
    ]
    """<p>A mapping of Amazon API Gateway path resources to resource IDs. </p>"""
    state: NotRequired[
        "capo_migration_hub_refactor_spaces.types.route_state.RouteState"
    ]
    """<p>The current state of the route. </p>"""
    tags: NotRequired["capo_migration_hub_refactor_spaces.types.tag_map.TagMap"]
    """<p>The tags assigned to the route. </p>"""
    error: NotRequired[
        "capo_migration_hub_refactor_spaces.types.error_response.ErrorResponse"
    ]
    """<p>Any error associated with the route resource. </p>"""
    last_updated_time: NotRequired[
        "capo_migration_hub_refactor_spaces.types.timestamp.Timestamp"
    ]
    """<p>A timestamp that indicates when the route was last updated. </p>"""
    created_time: NotRequired[
        "capo_migration_hub_refactor_spaces.types.timestamp.Timestamp"
    ]
    """<p>A timestamp that indicates when the route is created. </p>"""
    append_source_path: NotRequired[
        "capo_migration_hub_refactor_spaces.types.boolean.Boolean"
    ]
    """<p>If set to <code>true</code>, this option appends the source path to the service URL endpoint.</p>"""

append_source_path instance-attribute

append_source_path: NotRequired[Boolean]

If set to true, this option appends the source path to the service URL endpoint.

application_id instance-attribute

application_id: NotRequired[ApplicationId]

The unique identifier of the application.

arn instance-attribute

arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the route.

created_by_account_id instance-attribute

created_by_account_id: NotRequired[AccountId]

The Amazon Web Services account ID of the route creator.

created_time instance-attribute

created_time: NotRequired[Timestamp]

A timestamp that indicates when the route is created.

environment_id instance-attribute

environment_id: NotRequired[EnvironmentId]

The unique identifier of the environment.

error instance-attribute

error: NotRequired[ErrorResponse]

Any error associated with the route resource.

include_child_paths instance-attribute

include_child_paths: NotRequired[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.

last_updated_time instance-attribute

last_updated_time: NotRequired[Timestamp]

A timestamp that indicates when the route was last updated.

methods instance-attribute

methods: NotRequired[HttpMethods]

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.

owner_account_id instance-attribute

owner_account_id: NotRequired[AccountId]

The Amazon Web Services account ID of the route owner.

path_resource_to_id instance-attribute

path_resource_to_id: NotRequired[PathResourceToId]

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

route_id instance-attribute

route_id: NotRequired[RouteId]

The unique identifier of the route.

route_type instance-attribute

route_type: NotRequired[RouteType]

The route type of the route.

service_id instance-attribute

service_id: NotRequired[ServiceId]

The unique identifier of the service.

source_path instance-attribute

source_path: NotRequired[UriPath]

This is the path that Refactor Spaces uses to match traffic. Paths must start with / and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.

state instance-attribute

state: NotRequired[RouteState]

The current state of the route.

tags instance-attribute

tags: NotRequired[TagMap]

The tags assigned to the route.