Amazon DMS Dms Metadata Model Assessment API

openapi: 3.2.0
info:
  title: AWS Database Migration Service Metadata Model Assessment API
  version: '2016-01-01'
  description: Generated from AWS's published Smithy model for AWS Database Migration 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://dms.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Metadata Model Assessment
paths:
  /#DescribeMetadataModelAssessments:
    post:
      operationId: DescribeMetadataModelAssessments
      summary: Describe Metadata Model Assessments
      description: 'Returns a paginated list of metadata model assessment requests for a migration project, initiated by StartMetadataModelAssessment. Required permissions: dms:ListMetadataModelAssessments. For more information, see Actions, resources, and condition keys for Database Migration Service.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeMetadataModelAssessmentsResponse'
              example:
                Requests:
                - Status: SUCCESS
                  RequestIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                  MigrationProjectArn: arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS
                - Status: IN_PROGRESS
                  RequestIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE22222
                  MigrationProjectArn: arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS
                  Progress:
                    ProgressPercent: 50.0
                    TotalObjects: 100
                    ProgressStep: ANALYZING
                    ProcessedObject:
                      Name: ExampleTable
                      Type: table
                      EndpointType: SOURCE
                - Status: FAILED
                  RequestIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
                  MigrationProjectArn: arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS
                  Error:
                    defaultErrorDetails:
                      Message: No objects were found according to the specified selection rules. Please review your selection rules and try again.
        '400':
          description: ResourceNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.DescribeMetadataModelAssessments
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeMetadataModelAssessmentsMessage'
            example:
              MigrationProjectIdentifier: arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS
              Filters:
              - Name: request-id
                Values:
                - a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                - a1b2c3d4-5678-90ab-cdef-EXAMPLE22222
                - a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
      tags:
      - Metadata Model Assessment
  /#ExportMetadataModelAssessment:
    post:
      operationId: ExportMetadataModelAssessment
      summary: Export Metadata Model Assessment
      description: 'Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file. Required permissions: dms:ExportMetadataModelAssessment. For more information, see Actions, resources, and condition keys for Database Migration Service.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ExportMetadataModelAssessmentResponse'
              example:
                PdfReport:
                  S3ObjectKey: example-migration-project/example-assessment-report.pdf
                  ObjectURL: https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.pdf
                CsvReport:
                  S3ObjectKey: example-migration-project/example-assessment-report.zip
                  ObjectURL: https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.zip
        '400':
          description: ResourceNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.ExportMetadataModelAssessment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ExportMetadataModelAssessmentMessage'
            example:
              MigrationProjectIdentifier: arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS
              SelectionRules: '{"rules": [{"rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema"}, "rule-action": "explicit"}]}'
              FileName: example-assessment-report
              AssessmentReportTypes:
              - pdf
              - csv
      tags:
      - Metadata Model Assessment
  /#StartMetadataModelAssessment:
    post:
      operationId: StartMetadataModelAssessment
      summary: Start Metadata Model Assessment
      description: 'Queues an assessment of the selected source metadata models (database objects such as tables, views, and procedures) to evaluate conversion complexity to the target database format. If other requests created by Start* operations are already in the migration project''s queue, the assessment begins after they complete. The assessment request loads metadata models that are not yet in the metadata tree, but does not reload metadata models that are already present. If your source database has changed since the metadata was loaded, refresh the affected metadata models with StartMetadataModelImport before calling this operation. To check the status of the assessment request, call DescribeMetadataModelAssessments using the returned RequestIdentifier as a filter. To export the conversion assessment report after the request completes successfully, call ExportMetadataModelAssessment. Required permissions: dms:StartMetadataModelAssessment. For more information, see Actions, resources, and condition keys for Database Migration Service.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartMetadataModelAssessmentResponse'
              example:
                RequestIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
        '400':
          description: AccessDeniedFault; InvalidResourceStateFault; KMSKeyNotAccessibleFault; ResourceAlreadyExistsFault; ResourceNotFoundFault; ResourceQuotaExceededFault; S3AccessDeniedFault; S3ResourceNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.StartMetadataModelAssessment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartMetadataModelAssessmentMessage'
            example:
              MigrationProjectIdentifier: arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS
              SelectionRules: '{"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema"},"rule-action": "explicit"}]}'
      tags:
      - Metadata Model Assessment
components:
  schemas:
    StartMetadataModelAssessmentResponse:
      type: object
      properties:
        RequestIdentifier:
          type: string
          description: The identifier for the assessment request.
    ExportMetadataModelAssessmentMessage:
      type: object
      properties:
        MigrationProjectIdentifier:
          type: string
          description: The migration project name or Amazon Resource Name (ARN).
        SelectionRules:
          type: string
          description: 'A JSON string that identifies the metadata models to export a conversion assessment report for. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts only source selection rules, where server-name in the object locator matches the source data provider. Supports only explicit rule actions.'
        FileName:
          type: string
          description: The name of the assessment file to create in your Amazon S3 bucket.
        AssessmentReportTypes:
          type: array
          items:
            type: string
            enum:
            - pdf
            - csv
          description: The file format of the assessment file.
      required:
      - MigrationProjectIdentifier
      - SelectionRules
    Progress:
      type: object
      properties:
        ProgressPercent:
          type: number
          description: The percent complete for the current step of the schema conversion operation.
        TotalObjects:
          type: integer
          description: The number of objects in this schema conversion operation.
        ProgressStep:
          type: string
          description: 'The step of the schema conversion operation. This parameter can store one of the following values: IN_PROGRESS – The operation is running. LOADING_METADATA – Loads metadata from the source database. COUNTING_OBJECTS – Determines the number of objects involved in the operation. ANALYZING – Analyzes the source database objects. CONVERTING – Converts the source database objects to a format compatible with the target database. APPLYING – Applies the converted code to the target database. FINISHED – The operation completed successfully.'
        ProcessedObject:
          $ref: '#/components/schemas/ProcessedObject'
    ProcessedObject:
      type: object
      properties:
        Name:
          type: string
          description: The name of the database object.
        Type:
          type: string
          description: The type of the database object. For example, a table, view, procedure, and so on.
        EndpointType:
          type: string
          description: 'The type of the data provider. This parameter can store one of the following values: "SOURCE" or "TARGET".'
    ExportMetadataModelAssessmentResultEntry:
      type: object
      properties:
        S3ObjectKey:
          type: string
          description: The object key for the object containing the exported metadata model assessment.
        ObjectURL:
          type: string
          description: The URL for the object containing the exported metadata model assessment.
    AccessDeniedFault:
      type: object
      properties:
        message:
          type: string
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter as specified for a Describe* or similar operation.
        Values:
          type: array
          items:
            type: string
          description: The filter value, which can specify one or more values used to narrow the returned results.
      required:
      - Name
      - Values
    ResourceNotFoundFault:
      type: object
      properties:
        message:
          type: string
    ExportSqlDetails:
      type: object
      properties:
        S3ObjectKey:
          type: string
          description: The Amazon S3 URI of the object that contains the ZIP archive with exported DDL scripts.
        ObjectURL:
          type: string
          description: The URL of the Amazon S3 object that contains the ZIP archive with exported DDL scripts.
    SchemaConversionRequest:
      type: object
      properties:
        Status:
          type: string
          description: 'The schema conversion operation status. Possible values: RECEIVED – The operation is received but not yet queued for processing. IN_PROGRESS – The operation is queued or actively running. SUCCESS – The operation completed successfully. FAILED – The operation did not complete. CANCELING – The operation is being canceled. The operation might still succeed or fail before cancellation takes effect. CANCELED – The operation was canceled before completion.'
        RequestIdentifier:
          type: string
          description: The identifier for the schema conversion action.
        MigrationProjectArn:
          type: string
          description: The migration project ARN.
        Error:
          $ref: '#/components/schemas/ErrorDetails'
        ExportSqlDetails:
          $ref: '#/components/schemas/ExportSqlDetails'
        Progress:
          $ref: '#/components/schemas/Progress'
    ExportMetadataModelAssessmentResponse:
      type: object
      properties:
        PdfReport:
          $ref: '#/components/schemas/ExportMetadataModelAssessmentResultEntry'
        CsvReport:
          $ref: '#/components/schemas/ExportMetadataModelAssessmentResultEntry'
    ErrorDetails:
      type: object
      properties:
        defaultErrorDetails:
          $ref: '#/components/schemas/DefaultErrorDetails'
      description: Exactly one member is set.
    DescribeMetadataModelAssessmentsMessage:
      type: object
      properties:
        MigrationProjectIdentifier:
          type: string
          description: The migration project name or Amazon Resource Name (ARN).
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'The filters to apply to the metadata model assessment requests. The following filter names are supported: request-id – The request identifier. status – The request status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED.'
        Marker:
          type: string
          description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
        MaxRecords:
          type: integer
          description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
      required:
      - MigrationProjectIdentifier
    DefaultErrorDetails:
      type: object
      properties:
        Message:
          type: string
          description: The error message.
    DescribeMetadataModelAssessmentsResponse:
      type: object
      properties:
        Marker:
          type: string
          description: Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
        Requests:
          type: array
          items:
            $ref: '#/components/schemas/SchemaConversionRequest'
          description: A paginated list of metadata model assessment requests. DMS never populates the ExportSqlDetails field for this operation.
    StartMetadataModelAssessmentMessage:
      type: object
      properties:
        MigrationProjectIdentifier:
          type: string
          description: The migration project name or Amazon Resource Name (ARN).
        SelectionRules:
          type: string
          description: 'A JSON string that identifies the metadata models to assess. For the selection rule format and examples, see Selection rules in DMS Schema Conversion. Usage: Accepts only source selection rules, where server-name in the object locator matches the source data provider. Supports explicit, include, and exclude rule actions.'
      required:
      - MigrationProjectIdentifier
      - SelectionRules
  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: dms
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/database-migration-service/service/2016-01-01/database-migration-service-2016-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)