Amazon Migration Hub Migration Hub Services API

openapi: 3.1.0
info:
  title: AWS Migration Hub Services API
  version: '2017-05-31'
  description: Generated from AWS's published Smithy model for AWS Migration Hub. 4 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}/services:
    post:
      operationId: CreateService
      summary: Create Service
      description: 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. 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateServiceResponse'
        '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/CreateServiceRequest'
      tags:
      - Services
    get:
      operationId: ListServices
      summary: List Services
      description: Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListServicesResponse'
        '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/ListServicesRequest'
      tags:
      - Services
  /environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/services/{ServiceIdentifier}:
    delete:
      operationId: DeleteService
      summary: Delete Service
      description: Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteServiceResponse'
        '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/DeleteServiceRequest'
      tags:
      - Services
    get:
      operationId: GetService
      summary: Get Service
      description: Gets an Amazon Web Services Migration Hub Refactor Spaces service.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetServiceResponse'
        '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/GetServiceRequest'
      tags:
      - Services
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
    CreateServiceRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the service.
        Description:
          type: string
          description: The description of the service.
        EnvironmentIdentifier:
          type: string
          description: The ID of the environment in which the service is created.
        ApplicationIdentifier:
          type: string
          description: The ID of the application which the service is created.
        VpcId:
          type: string
          description: The ID of the VPC.
        EndpointType:
          type: string
          description: The type of endpoint to use for the service. The type can be a URL in a VPC or an Lambda function.
        UrlEndpoint:
          $ref: '#/components/schemas/UrlEndpointInput'
        LambdaEndpoint:
          $ref: '#/components/schemas/LambdaEndpointInput'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 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..
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - Name
      - EnvironmentIdentifier
      - ApplicationIdentifier
      - EndpointType
    CreateServiceResponse:
      type: object
      properties:
        ServiceId:
          type: string
          description: The unique identifier of the service.
        Name:
          type: string
          description: The name of the service.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the service.
        OwnerAccountId:
          type: string
          description: The Amazon Web Services account ID of the service owner.
        CreatedByAccountId:
          type: string
          description: The Amazon Web Services account ID of the service creator.
        Description:
          type: string
          description: The description of the created service.
        EnvironmentId:
          type: string
          description: The unique identifier of the environment.
        ApplicationId:
          type: string
          description: The ID of the application that the created service belongs to.
        VpcId:
          type: string
          description: The ID of the VPC.
        EndpointType:
          type: string
          description: The endpoint type of the service.
        UrlEndpoint:
          $ref: '#/components/schemas/UrlEndpointInput'
        LambdaEndpoint:
          $ref: '#/components/schemas/LambdaEndpointInput'
        State:
          type: string
          description: The current state of the service.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 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..
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the service was last updated.
        CreatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the service is created.
    DeleteServiceRequest:
      type: object
      properties:
        EnvironmentIdentifier:
          type: string
          description: The ID of the environment that the service is in.
        ApplicationIdentifier:
          type: string
          description: Deletes a Refactor Spaces service. 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.
        ServiceIdentifier:
          type: string
          description: The ID of the service to delete.
      required:
      - EnvironmentIdentifier
      - ApplicationIdentifier
      - ServiceIdentifier
    DeleteServiceResponse:
      type: object
      properties:
        ServiceId:
          type: string
          description: The unique identifier of the service.
        Name:
          type: string
          description: The name of the service.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the service.
        EnvironmentId:
          type: string
          description: The unique identifier of the environment.
        ApplicationId:
          type: string
          description: The ID of the application that the service is in.
        State:
          type: string
          description: The current state of the service.
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the service 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.
    GetServiceRequest:
      type: object
      properties:
        EnvironmentIdentifier:
          type: string
          description: The ID of the environment.
        ApplicationIdentifier:
          type: string
          description: The ID of the application.
        ServiceIdentifier:
          type: string
          description: The ID of the service.
      required:
      - EnvironmentIdentifier
      - ApplicationIdentifier
      - ServiceIdentifier
    GetServiceResponse:
      type: object
      properties:
        ServiceId:
          type: string
          description: The unique identifier of the service.
        Name:
          type: string
          description: The name of the service.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the service.
        OwnerAccountId:
          type: string
          description: The Amazon Web Services account ID of the service owner.
        CreatedByAccountId:
          type: string
          description: The Amazon Web Services account ID of the service creator.
        Description:
          type: string
          description: The description of the service.
        EnvironmentId:
          type: string
          description: The unique identifier of the environment.
        ApplicationId:
          type: string
          description: The ID of the application.
        VpcId:
          type: string
          description: The ID of the virtual private cloud (VPC).
        EndpointType:
          type: string
          description: The endpoint type of the service.
        UrlEndpoint:
          $ref: '#/components/schemas/UrlEndpointConfig'
        LambdaEndpoint:
          $ref: '#/components/schemas/LambdaEndpointConfig'
        State:
          type: string
          description: The current state of the service.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 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.
        Error:
          $ref: '#/components/schemas/ErrorResponse'
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the service was last updated.
        CreatedTime:
          type: string
          format: date-time
          description: The timestamp of when the service is created.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    LambdaEndpointConfig:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Lambda endpoint.
    LambdaEndpointInput:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Lambda function or alias.
      required:
      - Arn
    LambdaEndpointSummary:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Lambda endpoint.
    ListServicesRequest:
      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
    ListServicesResponse:
      type: object
      properties:
        ServiceSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/ServiceSummary'
          description: The list of ServiceSummary 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
    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
    ServiceSummary:
      type: object
      properties:
        ServiceId:
          type: string
          description: The unique identifier of the service.
        Name:
          type: string
          description: The name of the service.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the service.
        OwnerAccountId:
          type: string
          description: The Amazon Web Services account ID of the service owner.
        CreatedByAccountId:
          type: string
          description: The Amazon Web Services account ID of the service creator.
        Description:
          type: string
          description: A description of the service.
        EnvironmentId:
          type: string
          description: The unique identifier of the environment.
        ApplicationId:
          type: string
          description: The unique identifier of the application.
        VpcId:
          type: string
          description: The ID of the virtual private cloud (VPC).
        EndpointType:
          type: string
          description: The endpoint type of the service.
        UrlEndpoint:
          $ref: '#/components/schemas/UrlEndpointSummary'
        LambdaEndpoint:
          $ref: '#/components/schemas/LambdaEndpointSummary'
        State:
          type: string
          description: The current state of the service.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags assigned to the service.
        Error:
          $ref: '#/components/schemas/ErrorResponse'
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the service was last updated.
        CreatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the service is created.
    UrlEndpointConfig:
      type: object
      properties:
        Url:
          type: string
          description: The HTTP URL endpoint.
        HealthUrl:
          type: string
          description: The health check URL of the URL endpoint type.
    UrlEndpointInput:
      type: object
      properties:
        Url:
          type: string
          description: 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.
        HealthUrl:
          type: string
          description: 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.
      required:
      - Url
    UrlEndpointSummary:
      type: object
      properties:
        Url:
          type: string
          description: 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.
        HealthUrl:
          type: string
          description: 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.
    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)