Amazon Application Discovery Service Imports API

openapi: 3.1.0
info:
  title: AWS Application Discovery Service Imports API
  version: '2015-11-01'
  description: Generated from AWS's published Smithy model for AWS Application Discovery Service. 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://discovery.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#BatchDeleteImportData:
    post:
      operationId: BatchDeleteImportData
      summary: Batch Delete Import Data
      description: Deletes one or more import tasks, each identified by their import ID. Each import task has a number of
        records that can identify servers or applications. Amazon Web Services Application Discovery Service has built-in
        matching logic that will identify when discovered servers match existing entries that you've previously discovered,
        the information for the already-existing discovered server is updated. When you delete an import task that contains
        records that were used to match, the information in those matched records that comes from the deleted records will
        also be deleted.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BatchDeleteImportDataResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '400':
          description: HomeRegionNotSetException; InvalidParameterException; InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.BatchDeleteImportData
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/BatchDeleteImportDataRequest'
      tags:
      - Imports
  /#DescribeImportTasks:
    post:
      operationId: DescribeImportTasks
      summary: Describe Import Tasks
      description: Returns an array of import tasks for your account, including status information, times, IDs, the Amazon
        S3 Object URL for the import file, and more.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeImportTasksResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '400':
          description: HomeRegionNotSetException; InvalidParameterException; InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.DescribeImportTasks
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeImportTasksRequest'
      tags:
      - Imports
  /#StartImportTask:
    post:
      operationId: StartImportTask
      summary: Start Import Task
      description: 'Starts an import task, which allows you to import details of your on-premises environment directly into
        Amazon Web Services Migration Hub without having to use the Amazon Web Services Application Discovery Service (Application
        Discovery Service) tools such as the Amazon Web Services Application Discovery Service Agentless Collector or Application
        Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported
        data, including the ability to group your devices as applications and track their migration status. To start an import
        request, do this: Download the specially formatted comma separated value (CSV) import template, which you can find
        here: https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv. Fill
        out the template with your server and application data. Upload your import file to an Amazon S3 bucket, and make a
        note of it''s Object URL. Your import file must be in the CSV format. Use the console or the StartImportTask command
        with the Amazon Web Services CLI or one of the Amazon Web Services SDKs to import the records from your file. For
        more information, including step-by-step p'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartImportTaskResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '400':
          description: HomeRegionNotSetException; InvalidParameterException; InvalidParameterValueException; ResourceInUseException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.StartImportTask
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartImportTaskRequest'
      tags:
      - Imports
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: discovery
  schemas:
    AuthorizationErrorException:
      type: object
      properties:
        message:
          type: string
    BatchDeleteImportDataError:
      type: object
      properties:
        importTaskId:
          type: string
          description: The unique import ID associated with the error that occurred.
        errorCode:
          type: string
          enum:
          - NOT_FOUND
          - INTERNAL_SERVER_ERROR
          - OVER_LIMIT
          description: The type of error that occurred for a specific import task.
        errorDescription:
          type: string
          description: The description of the error that occurred for a specific import task.
    BatchDeleteImportDataRequest:
      type: object
      properties:
        importTaskIds:
          type: array
          items:
            type: string
          description: The IDs for the import tasks that you want to delete.
        deleteHistory:
          type: boolean
          description: Set to true to remove the deleted import task from DescribeImportTasks.
      required:
      - importTaskIds
    BatchDeleteImportDataResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/BatchDeleteImportDataError'
          description: Error messages returned for each import task that you deleted as a response for this command.
    DescribeImportTasksRequest:
      type: object
      properties:
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ImportTaskFilter'
          description: An array of name-value pairs that you provide to filter the results for the DescribeImportTask request
            to a specific subset of results. Currently, wildcard values aren't supported for filters.
        maxResults:
          type: integer
          description: The maximum number of results that you want this request to return, up to 100.
        nextToken:
          type: string
          description: The token to request a specific page of results.
    DescribeImportTasksResponse:
      type: object
      properties:
        nextToken:
          type: string
          description: The token to request the next page of results.
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/ImportTask'
          description: A returned array of import tasks that match any applied filters, up to the specified number of maximum
            results.
    HomeRegionNotSetException:
      type: object
      properties:
        message:
          type: string
    ImportTask:
      type: object
      properties:
        importTaskId:
          type: string
          description: The unique ID for a specific import task. These IDs aren't globally unique, but they are unique within
            an Amazon Web Services account.
        clientRequestToken:
          type: string
          description: A unique token used to prevent the same import request from occurring more than once. If you didn't
            provide a token, a token was automatically generated when the import task request was sent.
        name:
          type: string
          description: A descriptive name for an import task. You can use this name to filter future requests related to this
            import task, such as identifying applications and servers that were included in this import task. We recommend
            that you use a meaningful name for each import task.
        importUrl:
          type: string
          description: The URL for your import file that you've uploaded to Amazon S3.
        status:
          type: string
          enum:
          - IMPORT_IN_PROGRESS
          - IMPORT_COMPLETE
          - IMPORT_COMPLETE_WITH_ERRORS
          - IMPORT_FAILED
          - IMPORT_FAILED_SERVER_LIMIT_EXCEEDED
          - IMPORT_FAILED_RECORD_LIMIT_EXCEEDED
          - IMPORT_FAILED_UNSUPPORTED_FILE_TYPE
          - DELETE_IN_PROGRESS
          - DELETE_COMPLETE
          - DELETE_FAILED
          - DELETE_FAILED_LIMIT_EXCEEDED
          - INTERNAL_ERROR
          description: The status of the import task. An import can have the status of IMPORT_COMPLETE and still have some
            records fail to import from the overall request. More information can be found in the downloadable archive defined
            in the errorsAndFailedEntriesZip field, or in the Migration Hub management console.
        importRequestTime:
          type: string
          format: date-time
          description: The time that the import task request was made, presented in the Unix time stamp format.
        importCompletionTime:
          type: string
          format: date-time
          description: The time that the import task request finished, presented in the Unix time stamp format.
        importDeletedTime:
          type: string
          format: date-time
          description: The time that the import task request was deleted, presented in the Unix time stamp format.
        fileClassification:
          type: string
          enum:
          - MODELIZEIT_EXPORT
          - RVTOOLS_EXPORT
          - VMWARE_NSX_EXPORT
          - IMPORT_TEMPLATE
          description: The type of file detected by the import task.
        serverImportSuccess:
          type: integer
          description: The total number of server records in the import file that were successfully imported.
        serverImportFailure:
          type: integer
          description: The total number of server records in the import file that failed to be imported.
        applicationImportSuccess:
          type: integer
          description: The total number of application records in the import file that were successfully imported.
        applicationImportFailure:
          type: integer
          description: The total number of application records in the import file that failed to be imported.
        errorsAndFailedEntriesZip:
          type: string
          description: A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of
            failed records. You can use these two files to quickly identify records that failed, why they failed, and correct
            those records. Afterward, you can upload the corrected file to your Amazon S3 bucket and create another import
            task request. This field also includes authorization information so you can confirm the authenticity of the compressed
            archive before you download it. If some records failed to be imported we recommend that you correct the records
            in the failed entries file and then imports t
    ImportTaskFilter:
      type: object
      properties:
        name:
          type: string
          enum:
          - IMPORT_TASK_ID
          - STATUS
          - NAME
          - FILE_CLASSIFICATION
          description: The name, status, or import task ID for a specific import task.
        values:
          type: array
          items:
            type: string
          description: An array of strings that you can provide to match against a specific name, status, or import task ID
            to filter the results for your import task queries.
    ServerInternalErrorException:
      type: object
      properties:
        message:
          type: string
    StartImportTaskRequest:
      type: object
      properties:
        clientRequestToken:
          type: string
          description: Optional. A unique token that you can provide to prevent the same import request from occurring more
            than once. If you don't provide a token, a token is automatically generated. Sending more than one StartImportTask
            request with the same client request token will return information about the original import task with that client
            request token.
        name:
          type: string
          description: A descriptive name for this request. You can use this name to filter future requests related to this
            import task, such as identifying applications and servers that were included in this import task. We recommend
            that you use a meaningful name for each import task.
        importUrl:
          type: string
          description: 'The URL for your import file that you''ve uploaded to Amazon S3. If you''re using the Amazon Web Services
            CLI, this URL is structured as follows: s3://BucketName/ImportFileName.CSV'
      required:
      - name
      - importUrl
    StartImportTaskResponse:
      type: object
      properties:
        task:
          $ref: '#/components/schemas/ImportTask'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/application-discovery-service/service/2015-11-01/application-discovery-service-2015-11-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)