Amazon Migration Hub Migration Hub Source Resource API

openapi: 3.2.0
info:
  title: AWS Migration Hub Source Resource API
  version: '2017-05-31'
  description: Generated from AWS's published Smithy model for AWS Migration Hub. 3 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://mgh.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Source Resource
paths:
  /#AssociateSourceResource:
    post:
      operationId: AssociateSourceResource
      summary: Associate Source Resource
      description: Associates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AssociateSourceResourceResult'
        '400':
          description: AccessDeniedException; DryRunOperation; InvalidInputException; ResourceNotFoundException; UnauthorizedOperation
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ServiceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSMigrationHub.AssociateSourceResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/AssociateSourceResourceRequest'
      tags:
      - Source Resource
  /#DisassociateSourceResource:
    post:
      operationId: DisassociateSourceResource
      summary: Disassociate Source Resource
      description: Removes the association between a source resource and a migration task.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DisassociateSourceResourceResult'
        '400':
          description: AccessDeniedException; DryRunOperation; InvalidInputException; ResourceNotFoundException; UnauthorizedOperation
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ServiceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSMigrationHub.DisassociateSourceResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DisassociateSourceResourceRequest'
      tags:
      - Source Resource
  /#ListSourceResources:
    post:
      operationId: ListSourceResources
      summary: List Source Resources
      description: Lists all the source resource that are associated with the specified MigrationTaskName and ProgressUpdateStream.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListSourceResourcesResult'
        '400':
          description: AccessDeniedException; InvalidInputException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ServiceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSMigrationHub.ListSourceResources
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListSourceResourcesRequest'
      tags:
      - Source Resource
components:
  schemas:
    SourceResource:
      type: object
      properties:
        Name:
          type: string
          description: This is the name that you want to use to identify the resource. If the resource is an AWS resource, we recommend that you set this parameter to the ARN of the resource.
        Description:
          type: string
          description: A description that can be free-form text to record additional detail about the resource for clarity or later reference.
        StatusDetail:
          type: string
          description: A free-form description of the status of the resource.
      required:
      - Name
    DisassociateSourceResourceRequest:
      type: object
      properties:
        ProgressUpdateStream:
          type: string
          description: The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.
        MigrationTaskName:
          type: string
          description: A unique identifier that references the migration task. Do not include sensitive data in this field.
        SourceResourceName:
          type: string
          description: The name that was specified for the source resource.
        DryRun:
          type: boolean
          description: This is an optional parameter that you can use to test whether the call will succeed. Set this parameter to true to verify that you have the permissions that are required to make the call, and that you have specified the other parameters in the call correctly.
      required:
      - ProgressUpdateStream
      - MigrationTaskName
      - SourceResourceName
    AssociateSourceResourceRequest:
      type: object
      properties:
        ProgressUpdateStream:
          type: string
          description: The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.
        MigrationTaskName:
          type: string
          description: A unique identifier that references the migration task. Do not include sensitive data in this field.
        SourceResource:
          $ref: '#/components/schemas/SourceResource'
        DryRun:
          type: boolean
          description: This is an optional parameter that you can use to test whether the call will succeed. Set this parameter to true to verify that you have the permissions that are required to make the call, and that you have specified the other parameters in the call correctly.
      required:
      - ProgressUpdateStream
      - MigrationTaskName
      - SourceResource
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
          description: A message that provides information about the exception.
        RetryAfterSeconds:
          type: integer
          description: The number of seconds the caller should wait before retrying.
      required:
      - Message
    ListSourceResourcesRequest:
      type: object
      properties:
        ProgressUpdateStream:
          type: string
          description: The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.
        MigrationTaskName:
          type: string
          description: A unique identifier that references the migration task. Do not store confidential data in this field.
        NextToken:
          type: string
          description: If NextToken was returned by a previous call, there are more results available. The value of NextToken is a unique pagination token for each page. To retrieve the next page of results, specify the NextToken value that the previous call returned. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
        MaxResults:
          type: integer
          description: The maximum number of results to include in the response. If more results exist than the value that you specify here for MaxResults, the response will include a token that you can use to retrieve the next set of results.
      required:
      - ProgressUpdateStream
      - MigrationTaskName
    DisassociateSourceResourceResult:
      type: object
      properties: {}
    ListSourceResourcesResult:
      type: object
      properties:
        NextToken:
          type: string
          description: If the response includes a NextToken value, that means that there are more results available. The value of NextToken is a unique pagination token for each page. To retrieve the next page of results, call this API again and specify this NextToken value in the request. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
        SourceResourceList:
          type: array
          items:
            $ref: '#/components/schemas/SourceResource'
          description: The list of source resources.
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    AssociateSourceResourceResult:
      type: object
      properties: {}
  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: mgh
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/migration-hub/service/2017-05-31/migration-hub-2017-05-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)