GetRouteResponse ¶

class GetRouteResponse(TypedDict, closed=True):
    route_id: NotRequired["capo_migration_hub_refactor_spaces.types.route_id.RouteId"]
    """<p>The unique identifier of the route.</p> <p> <b>DEFAULT</b>: 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.</p> <p> <b>URI_PATH</b>: A route that is based on a URI path.</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 type of 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 ID of the application that the route belongs to. </p>"""
    environment_id: NotRequired[
        "capo_migration_hub_refactor_spaces.types.environment_id.EnvironmentId"
    ]
    """<p>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. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair. </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>The timestamp of 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>"""