Amazon Migration Hub Migration Hub Operations API

openapi: 3.2.0
info:
  title: AWS Migration Hub Operations 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: Operations
paths:
  /#ListMigrationTaskUpdates:
    post:
      operationId: ListMigrationTaskUpdates
      summary: List Migration Task Updates
      description: This is a paginated API that returns all the migration-task states for the specified MigrationTaskName and ProgressUpdateStream.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListMigrationTaskUpdatesResult'
        '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.ListMigrationTaskUpdates
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListMigrationTaskUpdatesRequest'
      tags:
      - Operations
components:
  schemas:
    MigrationTaskUpdate:
      type: object
      properties:
        UpdateDateTime:
          type: string
          format: date-time
          description: The timestamp for the update.
        UpdateType:
          type: string
          enum:
          - MIGRATION_TASK_STATE_UPDATED
          description: The type of the update.
        MigrationTaskState:
          $ref: '#/components/schemas/Task'
    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
    ListMigrationTaskUpdatesResult:
      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.
        MigrationTaskUpdateList:
          type: array
          items:
            $ref: '#/components/schemas/MigrationTaskUpdate'
          description: The list of migration-task updates.
    ListMigrationTaskUpdatesRequest:
      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.
        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
    Task:
      type: object
      properties:
        Status:
          type: string
          enum:
          - NOT_STARTED
          - IN_PROGRESS
          - FAILED
          - COMPLETED
          description: Status of the task - Not Started, In-Progress, Complete.
        StatusDetail:
          type: string
          description: Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.
        ProgressPercent:
          type: integer
          description: Indication of the percentage completion of the task.
      required:
      - Status
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
  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)