Amazon Migration Hub Migration Hub Routes API

openapi: 3.1.0
info:
  title: AWS Migration Hub Routes API
  version: '2017-05-31'
  description: Generated from AWS's published Smithy model for AWS Migration Hub. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://refactor-spaces.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes:
    post:
      operationId: CreateRoute
      summary: Create Route
      description: '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: URL Endpoints 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 a service endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet. Services
        can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed certificates are supported. Private Certificate
        Authorities'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRouteResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefactorSpacesAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefactorSpacesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRouteRequest'
      tags:
      - Routes
    get:
      operationId: ListRoutes
      summary: List Routes
      description: Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRoutesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefactorSpacesAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefactorSpacesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListRoutesRequest'
      tags:
      - Routes
  /environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes/{RouteIdentifier}:
    delete:
      operationId: DeleteRoute
      summary: Delete Route
      description: Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRouteResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefactorSpacesAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefactorSpacesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteRouteRequest'
      tags:
      - Routes
    get:
      operationId: GetRoute
      summary: Get Route
      description: Gets an Amazon Web Services Migration Hub Refactor Spaces route.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRouteResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefactorSpacesAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefactorSpacesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetRouteRequest'
      tags:
      - Routes
    patch:
      operationId: UpdateRoute
      summary: Update Route
      description: Updates an Amazon Web Services Migration Hub Refactor Spaces route.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRouteResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefactorSpacesAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefactorSpacesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRouteRequest'
      tags:
      - Routes
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: refactor-spaces
  schemas:
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The ID of the resource.
        ResourceType:
          type: string
          description: The type of resource.
      required:
      - Message
      - ResourceId
      - ResourceType
    CreateRouteRequest:
      type: object
      properties:
        EnvironmentIdentifier:
          type: string
          description: The ID of the environment in which the route is created.
        ApplicationIdentifier:
          type: string
          description: The ID of the application within which the route is being created.
        ServiceIdentifier:
          type: string
          description: The ID of the service in which the route is created. Traffic that matches this route is forwarded to
            this service.
        RouteType:
          type: string
          description: 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.
        DefaultRoute:
          $ref: '#/components/schemas/DefaultRouteInput'
        UriPathRoute:
          $ref: '#/components/schemas/UriPathRouteInput'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 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..
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - EnvironmentIdentifier
      - ApplicationIdentifier
      - ServiceIdentifier
      - RouteType
    CreateRouteResponse:
      type: object
      properties:
        RouteId:
          type: string
          description: The unique identifier of the route.
        Arn:
          type: string
          description: 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.
        OwnerAccountId:
          type: string
          description: The Amazon Web Services account ID of the route owner.
        CreatedByAccountId:
          type: string
          description: The Amazon Web Services account ID of the route creator.
        RouteType:
          type: string
          description: The route type of the route.
        ServiceId:
          type: string
          description: The ID of service in which the route is created. Traffic that matches this route is forwarded to this
            service.
        ApplicationId:
          type: string
          description: The ID of the application in which the route is created.
        UriPathRoute:
          $ref: '#/components/schemas/UriPathRouteInput'
        State:
          type: string
          description: The current state of the route. Activation state only allows ACTIVE or INACTIVE as user inputs. FAILED
            is a route state that is system generated.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 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.
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the route was last updated.
        CreatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the route is created.
    DefaultRouteInput:
      type: object
      properties:
        ActivationState:
          type: string
          description: If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.
    DeleteRouteRequest:
      type: object
      properties:
        EnvironmentIdentifier:
          type: string
          description: The ID of the environment to delete the route from.
        ApplicationIdentifier:
          type: string
          description: The ID of the application to delete the route from.
        RouteIdentifier:
          type: string
          description: The ID of the route to delete.
      required:
      - EnvironmentIdentifier
      - ApplicationIdentifier
      - RouteIdentifier
    DeleteRouteResponse:
      type: object
      properties:
        RouteId:
          type: string
          description: The ID of the route to delete.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the route.
        ServiceId:
          type: string
          description: The ID of the service that the route belongs to.
        ApplicationId:
          type: string
          description: The ID of the application that the route belongs to.
        State:
          type: string
          description: The current state of the route.
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the route was last updated.
    ErrorResponse:
      type: object
      properties:
        Code:
          type: string
          description: The error code associated with the error.
        Message:
          type: string
          description: The message associated with the error.
        AccountId:
          type: string
          description: The Amazon Web Services account ID of the resource owner.
        ResourceIdentifier:
          type: string
          description: The ID of the resource.
        ResourceType:
          type: string
          description: The type of resource.
        AdditionalDetails:
          type: object
          additionalProperties:
            type: string
          description: Additional details about the error.
    GetRouteRequest:
      type: object
      properties:
        EnvironmentIdentifier:
          type: string
          description: The ID of the environment.
        ApplicationIdentifier:
          type: string
          description: The ID of the application.
        RouteIdentifier:
          type: string
          description: The ID of the route.
      required:
      - EnvironmentIdentifier
      - ApplicationIdentifier
      - RouteIdentifier
    GetRouteResponse:
      type: object
      properties:
        RouteId:
          type: string
          description: '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.'
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the route.
        OwnerAccountId:
          type: string
          description: The Amazon Web Services account ID of the route owner.
        CreatedByAccountId:
          type: string
          description: The Amazon Web Services account ID of the route creator.
        RouteType:
          type: string
          description: The type of route.
        ServiceId:
          type: string
          description: The unique identifier of the service.
        ApplicationId:
          type: string
          description: The ID of the application that the route belongs to.
        EnvironmentId:
          type: string
          description: Unique identifier of the environment.
        SourcePath:
          type: string
          description: 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'.
        Methods:
          type: array
          items:
            type: string
          description: 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.
        IncludeChildPaths:
          type: boolean
          description: 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.
        PathResourceToId:
          type: object
          additionalProperties:
            type: string
          description: A mapping of Amazon API Gateway path resources to resource IDs.
        State:
          type: string
          description: The current state of the route.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 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.
        Error:
          $ref: '#/components/schemas/ErrorResponse'
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the route was last updated.
        CreatedTime:
          type: string
          format: date-time
          description: The timestamp of when the route is created.
        AppendSourcePath:
          type: boolean
          description: If set to true, this option appends the source path to the service URL endpoint.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListRoutesRequest:
      type: object
      properties:
        EnvironmentIdentifier:
          type: string
          description: The ID of the environment.
        ApplicationIdentifier:
          type: string
          description: The ID of the application.
        NextToken:
          type: string
          description: The token for the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return with a single call. To retrieve the remaining results, make
            another call with the returned nextToken value.
      required:
      - EnvironmentIdentifier
      - ApplicationIdentifier
    ListRoutesResponse:
      type: object
      properties:
        RouteSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/RouteSummary'
          description: The list of RouteSummary objects.
        NextToken:
          type: string
          description: The token for the next page of results.
    RefactorSpacesAccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    RefactorSpacesThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
          description: Service quota requirement to identify originating quota. Reached throttling quota exception.
        ServiceCode:
          type: string
          description: Service quota requirement to identify originating service. Reached throttling quota exception service
            code.
        RetryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying.
      required:
      - Message
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The ID of the resource.
        ResourceType:
          type: string
          description: The type of resource.
      required:
      - Message
      - ResourceId
      - ResourceType
    RouteSummary:
      type: object
      properties:
        RouteId:
          type: string
          description: The unique identifier of the route.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the route.
        OwnerAccountId:
          type: string
          description: The Amazon Web Services account ID of the route owner.
        CreatedByAccountId:
          type: string
          description: The Amazon Web Services account ID of the route creator.
        RouteType:
          type: string
          description: The route type of the route.
        ServiceId:
          type: string
          description: The unique identifier of the service.
        ApplicationId:
          type: string
          description: The unique identifier of the application.
        EnvironmentId:
          type: string
          description: The unique identifier of the environment.
        SourcePath:
          type: string
          description: 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'.
        Methods:
          type: array
          items:
            type: string
          description: 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.
        IncludeChildPaths:
          type: boolean
          description: 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.
        PathResourceToId:
          type: object
          additionalProperties:
            type: string
          description: A mapping of Amazon API Gateway path resources to resource IDs.
        State:
          type: string
          description: The current state of the route.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags assigned to the route.
        Error:
          $ref: '#/components/schemas/ErrorResponse'
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the route was last updated.
        CreatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the route is created.
        AppendSourcePath:
          type: boolean
          description: If set to true, this option appends the source path to the service URL endpoint.
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The ID of the resource.
        ResourceType:
          type: string
          description: The type of resource.
        QuotaCode:
          type: string
          description: Service quota requirement to identify originating quota. Reached throttling quota exception.
        ServiceCode:
          type: string
          description: Service quota requirement to identify originating service. Reached throttling quota exception service
            code.
      required:
      - Message
      - ResourceId
      - ResourceType
      - ServiceCode
    UpdateRouteRequest:
      type: object
      properties:
        EnvironmentIdentifier:
          type: string
          description: The ID of the environment in which the route is being updated.
        ApplicationIdentifier:
          type: string
          description: The ID of the application within which the route is being updated.
        RouteIdentifier:
          type: string
          description: The unique identifier of the route to update.
        ActivationState:
          type: string
          description: If set to ACTIVE, traffic is forwarded to this route’s service after the route is updated.
      required:
      - EnvironmentIdentifier
      - ApplicationIdentifier
      - RouteIdentifier
      - ActivationState
    UpdateRouteResponse:
      type: object
      properties:
        RouteId:
          type: string
          description: The unique identifier of the route.
        Arn:
          type: string
          description: 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.
        ServiceId:
          type: string
          description: The ID of service in which the route was created. Traffic that matches this route is forwarded to this
            service.
        ApplicationId:
          type: string
          description: The ID of the application in which the route is being updated.
        State:
          type: string
          description: The current state of the route.
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the route was last updated.
    UriPathRouteInput:
      type: object
      properties:
        SourcePath:
          type: string
          description: 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'.
        ActivationState:
          type: string
          description: If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.
        Methods:
          type: array
          items:
            type: string
          description: 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.
        IncludeChildPaths:
          type: boolean
          description: 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.
        AppendSourcePath:
          type: boolean
          description: If set to true, this option appends the source path to the service URL endpoint.
      required:
      - SourcePath
      - ActivationState
    ValidationException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/migration-hub-refactor-spaces/service/2021-10-26/migration-hub-refactor-spaces-2021-10-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)