Amazon Migration Hub #X Amz Target=AWSMigrationHub.ListCreatedArtifacts API

openapi: 3.0.0
info:
  version: 2017-05-31
  x-release: v4
  title: 'AWS Migration Hub #X Amz Target=AWSMigrationHub.AssociateCreatedArtifact #X Amz Target=AWSMigrationHub.AssociateCreatedArtifact #X Amz Target=AWSMigrationHub.ListCreatedArtifacts API'
  description: <p>The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to Migration Hub.</p> <p>Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a <code>HomeRegionNotSetException</code> error will be returned. Also, you must make the API calls while in your home region.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: AWSMigrationHub
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/AWSMigrationHub-2017-05-31.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://mgh.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Migration Hub multi-region endpoint
- url: https://mgh.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Migration Hub multi-region endpoint
- url: http://mgh.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Migration Hub endpoint for China (Beijing) and China (Ningxia)
- url: https://mgh.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Migration Hub endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSMigrationHub.ListCreatedArtifacts'
paths:
  /#X-Amz-Target=AWSMigrationHub.ListCreatedArtifacts:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: ListCreatedArtifacts
      description: <p>Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:</p> <ul> <li> <p>Gets the list of the created artifacts while migration is taking place.</p> </li> <li> <p>Shows the artifacts created by the migration tool that was associated by the <code>AssociateCreatedArtifact</code> API. </p> </li> <li> <p>Lists created artifacts in a paginated interface. </p> </li> </ul>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCreatedArtifactsResult'
              examples:
                ListCreatedArtifacts200Example:
                  summary: Default ListCreatedArtifacts 200 response
                  x-microcks-default: true
                  value:
                    NextToken: example-value
                    CreatedArtifactList: example-value
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                ListCreatedArtifacts480Example:
                  summary: Default ListCreatedArtifacts 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                ListCreatedArtifacts481Example:
                  summary: Default ListCreatedArtifacts 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: InternalServerError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
              examples:
                ListCreatedArtifacts482Example:
                  summary: Default ListCreatedArtifacts 482 response
                  x-microcks-default: true
                  value: {}
        '483':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
              examples:
                ListCreatedArtifacts483Example:
                  summary: Default ListCreatedArtifacts 483 response
                  x-microcks-default: true
                  value: {}
        '484':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                ListCreatedArtifacts484Example:
                  summary: Default ListCreatedArtifacts 484 response
                  x-microcks-default: true
                  value: {}
        '485':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                ListCreatedArtifacts485Example:
                  summary: Default ListCreatedArtifacts 485 response
                  x-microcks-default: true
                  value: {}
        '486':
          description: HomeRegionNotSetException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
              examples:
                ListCreatedArtifacts486Example:
                  summary: Default ListCreatedArtifacts 486 response
                  x-microcks-default: true
                  value: {}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListCreatedArtifactsRequest'
      parameters:
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSMigrationHub.ListCreatedArtifacts
      summary: Amazon Migration Hub List Created Artifacts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSMigrationHub.ListCreatedArtifacts'
components:
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
  schemas:
    MigrationTaskName:
      type: string
      pattern: '[^:|]+'
      minLength: 1
      maxLength: 256
    InvalidInputException: {}
    AccessDeniedException: {}
    CreatedArtifactName:
      type: string
      pattern: arn:[a-z-]+:[a-z0-9-]+:(?:[a-z0-9-]+|):(?:[0-9]{12}|):.*
      minLength: 1
      maxLength: 1600
    ServiceUnavailableException: {}
    ListCreatedArtifactsResult:
      type: object
      properties:
        NextToken:
          allOf:
          - $ref: '#/components/schemas/Token'
          - description: If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from.
        CreatedArtifactList:
          allOf:
          - $ref: '#/components/schemas/CreatedArtifactList'
          - description: List of created artifacts up to the maximum number of results specified in the request.
    MaxResultsCreatedArtifacts:
      type: integer
      minimum: 1
      maximum: 10
    InternalServerError: {}
    ThrottlingException: {}
    ProgressUpdateStream:
      type: string
      pattern: '[^/:|\000-\037]+'
      minLength: 1
      maxLength: 50
    HomeRegionNotSetException: {}
    CreatedArtifact:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/CreatedArtifactName'
          - description: An ARN that uniquely identifies the result of a migration task.
        Description:
          allOf:
          - $ref: '#/components/schemas/CreatedArtifactDescription'
          - description: A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.
      description: An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 instance, RDS instance, etc.).
    CreatedArtifactList:
      type: array
      items:
        $ref: '#/components/schemas/CreatedArtifact'
    Token:
      type: string
      pattern: ^[a-zA-Z0-9\/\+\=]{0,2048}$
      minLength: 0
      maxLength: 2048
    ResourceNotFoundException: {}
    ListCreatedArtifactsRequest:
      type: object
      required:
      - ProgressUpdateStream
      - MigrationTaskName
      title: ListCreatedArtifactsRequest
      properties:
        ProgressUpdateStream:
          allOf:
          - $ref: '#/components/schemas/ProgressUpdateStream'
          - description: 'The name of the ProgressUpdateStream. '
        MigrationTaskName:
          allOf:
          - $ref: '#/components/schemas/MigrationTaskName'
          - description: 'Unique identifier that references the migration task. <i>Do not store personal data in this field.</i> '
        NextToken:
          allOf:
          - $ref: '#/components/schemas/Token'
          - description: If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>.
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/MaxResultsCreatedArtifacts'
          - description: Maximum number of results to be returned per page.
    CreatedArtifactDescription:
      type: string
      pattern: ^.{0,500}$
      minLength: 0
      maxLength: 500
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/mgh/
x-hasEquivalentPaths: true