Amazon DMS Dms Metadata Model Creation API

openapi: 3.2.0
info:
  title: AWS Database Migration Service Metadata Model Creation 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 Creation
paths:
  /#CancelMetadataModelCreation:
    post:
      operationId: CancelMetadataModelCreation
      summary: Cancel Metadata Model Creation
      description: 'Cancels a single metadata model creation operation that was started with StartMetadataModelCreation. Required permissions: dms:CancelMetadataModelCreation. 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/CancelMetadataModelCreationResponse'
              example:
                Request:
                  Status: CANCELING
                  RequestIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                  MigrationProjectArn: arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS
        '400':
          description: AccessDeniedFault; InvalidResourceStateFault; ResourceNotFoundFault
          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.CancelMetadataModelCreation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CancelMetadataModelCreationMessage'
            example:
              MigrationProjectIdentifier: arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS
              RequestIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
      tags:
      - Metadata Model Creation
  /#DescribeMetadataModelCreations:
    post:
      operationId: DescribeMetadataModelCreations
      summary: Describe Metadata Model Creations
      description: 'Returns a paginated list of metadata model creation requests for a migration project, initiated by StartMetadataModelCreation. To cancel a queued or in-progress request, call CancelMetadataModelCreation. Required permissions: dms:DescribeMetadataModelCreations. 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/DescribeMetadataModelCreationsResponse'
              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
                - 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: AccessDeniedFault; ResourceNotFoundFault
          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.DescribeMetadataModelCreations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeMetadataModelCreationsMessage'
            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 Creation
  /#StartMetadataModelCreation:
    post:
      operationId: StartMetadataModelCreation
      summary: Start Metadata Model Creation
      description: 'Queues the creation of a metadata model in the source metadata tree. If other requests created by Start* operations are already in the migration project''s queue, the creation begins after they complete. This operation supports only Microsoft SQL Server to Aurora PostgreSQL and Microsoft SQL Server to Amazon RDS for PostgreSQL conversion paths. To check the status of the creation request, call DescribeMetadataModelCreations using the returned RequestIdentifier as a filter. To cancel a queued or in-progress request, call CancelMetadataModelCreation with the returned RequestIdentifier. Calling StartMetadataModelImport with Refresh deletes metadata models created by this operation. After the creation completes successfully: To evaluate conversion complexity, call StartMetadataModelAssessment. To convert to the target database format, call StartMetadataModelConversion. Required permissions: dms:StartMetadataModelCreation. 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/StartMetadataModelCreationResponse'
              example:
                RequestIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
        '400':
          description: AccessDeniedFault; ResourceAlreadyExistsFault; ResourceNotFoundFault; ResourceQuotaExceededFault
          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.StartMetadataModelCreation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartMetadataModelCreationMessage'
            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", "database-name": "ExampleDatabase", "schema-name": "ExampleSchema"}, "rule-action": "explicit"}]}'
              MetadataModelName: ExampleStatement
              Properties:
                StatementProperties:
                  Definition: SELECT * FROM ExampleTable;
      tags:
      - Metadata Model Creation
components:
  schemas:
    StartMetadataModelCreationMessage:
      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 source schema for the metadata model. 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. Exactly one rule is allowed.'
        MetadataModelName:
          type: string
          description: The name for the metadata model to use in subsequent operations.
        Properties:
          $ref: '#/components/schemas/MetadataModelProperties'
      required:
      - MigrationProjectIdentifier
      - SelectionRules
      - MetadataModelName
      - Properties
    CancelMetadataModelCreationMessage:
      type: object
      properties:
        MigrationProjectIdentifier:
          type: string
          description: The migration project name or Amazon Resource Name (ARN).
        RequestIdentifier:
          type: string
          description: The identifier for the metadata model creation operation to cancel. This operation was initiated by StartMetadataModelCreation.
      required:
      - MigrationProjectIdentifier
      - RequestIdentifier
    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".'
    StartMetadataModelCreationResponse:
      type: object
      properties:
        RequestIdentifier:
          type: string
          description: The identifier for the creation request.
    CancelMetadataModelCreationResponse:
      type: object
      properties:
        Request:
          $ref: '#/components/schemas/SchemaConversionRequest'
    AccessDeniedFault:
      type: object
      properties:
        message:
          type: string
    MetadataModelProperties:
      type: object
      properties:
        StatementProperties:
          $ref: '#/components/schemas/StatementProperties'
      description: Exactly one member is set.
    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
    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'
    StatementProperties:
      type: object
      properties:
        Definition:
          type: string
          description: The SQL text of the statement.
      required:
      - Definition
    DescribeMetadataModelCreationsResponse:
      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 creation requests. DMS never populates the ExportSqlDetails field for this operation.
    ErrorDetails:
      type: object
      properties:
        defaultErrorDetails:
          $ref: '#/components/schemas/DefaultErrorDetails'
      description: Exactly one member is set.
    DefaultErrorDetails:
      type: object
      properties:
        Message:
          type: string
          description: The error message.
    DescribeMetadataModelCreationsMessage:
      type: object
      properties:
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'The filters to apply to the metadata model creation requests. The following filter names are supported: request-id – The request identifier. status – The request status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED, CANCELING, CANCELED.'
        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.
        MigrationProjectIdentifier:
          type: string
          description: The migration project name or Amazon Resource Name (ARN).
      required:
      - MigrationProjectIdentifier
  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)