find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-migration-hub:amazon-migration-hub-environments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: AWS Migration Hub Environments 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:
    post:
      operationId: CreateEnvironment
      summary: Create Environment
      description: 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
        with a CreateEnvironment:NetworkFabricType of TRANSIT_GATEWAY, Refactor Spaces provisions a transit gateway to enable
        services in VPCs to communicate directly across accounts. If CreateEnvironment:NetworkFabricType is NONE, Refactor
        Spaces does not create a transit gateway and you must use your network infrastructure to route traffic to services
        with private URL endpoints.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEnvironmentResponse'
        '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/CreateEnvironmentRequest'
      tags:
      - Environments
    get:
      operationId: ListEnvironments
      summary: List Environments
      description: Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared
        with the caller account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEnvironmentsResponse'
        '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/ListEnvironmentsRequest'
      tags:
      - Environments
  /environments/{EnvironmentIdentifier}:
    delete:
      operationId: DeleteEnvironment
      summary: Delete Environment
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteEnvironmentResponse'
        '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/DeleteEnvironmentRequest'
      tags:
      - Environments
    get:
      operationId: GetEnvironment
      summary: Get Environment
      description: Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentResponse'
        '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/GetEnvironmentRequest'
      tags:
      - Environments
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
    CreateEnvironmentRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the environment.
        Description:
          type: string
          description: The description of the environment.
        NetworkFabricType:
          type: string
          description: The network fabric type of the environment.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 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.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - Name
      - NetworkFabricType
    CreateEnvironmentResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the environment.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the environment.
        Description:
          type: string
          description: A description of the environment.
        EnvironmentId:
          type: string
          description: The unique identifier of the environment.
        NetworkFabricType:
          type: string
          description: The network fabric type of the environment.
        OwnerAccountId:
          type: string
          description: The Amazon Web Services account ID of environment owner.
        State:
          type: string
          description: The current state of the environment.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 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..
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the environment was last updated.
        CreatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the environment is created.
    DeleteEnvironmentRequest:
      type: object
      properties:
        EnvironmentIdentifier:
          type: string
          description: The ID of the environment.
      required:
      - EnvironmentIdentifier
    DeleteEnvironmentResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the environment.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the environment.
        EnvironmentId:
          type: string
          description: The unique identifier of the environment.
        State:
          type: string
          description: The current state of the environment.
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the environment was last updated.
    EnvironmentSummary:
      type: object
      properties:
        Name:
          type: string
          description: The name of the environment.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the environment.
        Description:
          type: string
          description: A description of the environment.
        EnvironmentId:
          type: string
          description: The unique identifier of the environment.
        NetworkFabricType:
          type: string
          description: The network fabric type of the environment.
        OwnerAccountId:
          type: string
          description: The Amazon Web Services account ID of the environment owner.
        TransitGatewayId:
          type: string
          description: The ID of the Transit Gateway set up by the environment.
        State:
          type: string
          description: The current state of the environment.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags assigned to the environment.
        Error:
          $ref: '#/components/schemas/ErrorResponse'
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the environment was last updated.
        CreatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the environment is created.
    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.
    GetEnvironmentRequest:
      type: object
      properties:
        EnvironmentIdentifier:
          type: string
          description: The ID of the environment.
      required:
      - EnvironmentIdentifier
    GetEnvironmentResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the environment.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the environment.
        Description:
          type: string
          description: The description of the environment.
        EnvironmentId:
          type: string
          description: The unique identifier of the environment.
        NetworkFabricType:
          type: string
          description: The network fabric type of the environment.
        OwnerAccountId:
          type: string
          description: The Amazon Web Services account ID of the environment owner.
        TransitGatewayId:
          type: string
          description: The ID of the Transit Gateway set up by the environment, if applicable.
        State:
          type: string
          description: The current state of the environment.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 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.
        Error:
          $ref: '#/components/schemas/ErrorResponse'
        LastUpdatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the environment was last updated.
        CreatedTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the environment is created.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListEnvironmentsRequest:
      type: object
      properties:
        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.
    ListEnvironmentsResponse:
      type: object
      properties:
        EnvironmentSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentSummary'
          description: The list of EnvironmentSummary 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
    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)