Amazon DMS Dms Replication API

openapi: 3.2.0
info:
  title: AWS Database Migration Service Replication 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: Replication
paths:
  /#DescribeReplications:
    post:
      operationId: DescribeReplications
      summary: Describe Replications
      description: Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeReplicationsResponse'
        '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.DescribeReplications
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeReplicationsMessage'
      tags:
      - Replication
  /#StartReplication:
    post:
      operationId: StartReplication
      summary: Start Replication
      description: For a given DMS Serverless replication configuration, DMS connects to the source endpoint and collects the metadata to analyze the replication workload. Using this metadata, DMS then computes and provisions the required capacity and starts replicating to the target endpoint using the server resources that DMS has provisioned for the DMS Serverless replication.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartReplicationResponse'
        '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.StartReplication
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartReplicationMessage'
      tags:
      - Replication
  /#StopReplication:
    post:
      operationId: StopReplication
      summary: Stop Replication
      description: For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopReplicationResponse'
        '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.StopReplication
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopReplicationMessage'
      tags:
      - Replication
components:
  schemas:
    ProvisionData:
      type: object
      properties:
        ProvisionState:
          type: string
          description: The current provisioning state
        ProvisionedCapacityUnits:
          type: integer
          description: The number of capacity units the replication is using.
        DateProvisioned:
          type: string
          format: date-time
          description: The timestamp when DMS provisioned replication resources.
        IsNewProvisioningAvailable:
          type: boolean
          description: Whether the new provisioning is available to the replication.
        DateNewProvisioningDataAvailable:
          type: string
          format: date-time
          description: The timestamp when provisioning became available.
        ReasonForNewProvisioningData:
          type: string
          description: A message describing the reason that DMS provisioned new resources for the serverless replication.
    StartReplicationResponse:
      type: object
      properties:
        Replication:
          $ref: '#/components/schemas/Replication'
    DescribeReplicationsResponse:
      type: object
      properties:
        Marker:
          type: string
          description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        Replications:
          type: array
          items:
            $ref: '#/components/schemas/Replication'
          description: The replication descriptions.
    PremigrationAssessmentStatus:
      type: object
      properties:
        PremigrationAssessmentRunArn:
          type: string
          description: The Amazon Resource Name (ARN) of this assessment run.
        FailOnAssessmentFailure:
          type: boolean
          description: A configurable setting you can set to true (the defualt setting) or false. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.
        Status:
          type: string
          description: 'This describes the assessment run status. The status can be one of the following values: cancelling: The assessment run was canceled. deleting: The assessment run was deleted. failed: At least one individual assessment completed with a failed status. error-provisioning: An internal error occurred while resources were provisioned (during the provisioning status). error-executing An internal error occurred while individual assessments ran (during the running status). invalid state: The assessment run is in an unknown state. passed: All individual assessments have completed and none have a failed'
        PremigrationAssessmentRunCreationDate:
          type: string
          format: date-time
          description: The date which the assessment run was created.
        AssessmentProgress:
          $ref: '#/components/schemas/ReplicationTaskAssessmentRunProgress'
        LastFailureMessage:
          type: string
          description: The last message generated by an individual assessment failure.
        ResultLocationBucket:
          type: string
          description: The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.
        ResultLocationFolder:
          type: string
          description: The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.
        ResultEncryptionMode:
          type: string
          description: The supported values are SSE_KMS and SSE_S3. If these values are not provided, then the files are not encrypted at rest. For more information, see Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects.
        ResultKmsKeyArn:
          type: string
          description: The ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to SSE_KMS.
        ResultStatistic:
          $ref: '#/components/schemas/ReplicationTaskAssessmentRunResultStatistic'
    AccessDeniedFault:
      type: object
      properties:
        message:
          type: string
    Replication:
      type: object
      properties:
        ReplicationConfigIdentifier:
          type: string
          description: The identifier for the ReplicationConfig associated with the replication.
        ReplicationConfigArn:
          type: string
          description: The Amazon Resource Name for the ReplicationConfig associated with the replication.
        SourceEndpointArn:
          type: string
          description: The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data source.
        TargetEndpointArn:
          type: string
          description: The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data target.
        ReplicationType:
          type: string
          enum:
          - full-load
          - cdc
          - full-load-and-cdc
          description: The type of the serverless replication.
        Status:
          type: string
          description: The current status of the serverless replication.
        ProvisionData:
          $ref: '#/components/schemas/ProvisionData'
        PremigrationAssessmentStatuses:
          type: array
          items:
            $ref: '#/components/schemas/PremigrationAssessmentStatus'
          description: The status output of premigration assessment in describe-replications.
        StopReason:
          type: string
          description: 'The reason the replication task was stopped. This response parameter can return one of the following values: "Stop Reason NORMAL" "Stop Reason RECOVERABLE_ERROR" "Stop Reason FATAL_ERROR" "Stop Reason FULL_LOAD_ONLY_FINISHED" "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached changes not applied "Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes applied "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED" "Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied "Stop Reason STOPPED_DUE_TO_LOW_MEMORY" "Stop Reason STOPPED_D'
        FailureMessages:
          type: array
          items:
            type: string
          description: Error and other information about why a serverless replication failed.
        ReplicationStats:
          $ref: '#/components/schemas/ReplicationStats'
        StartReplicationType:
          type: string
          description: The type of replication to start.
        CdcStartTime:
          type: string
          format: date-time
          description: Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
        CdcStartPosition:
          type: string
          description: Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
        CdcStopPosition:
          type: string
          description: Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
        RecoveryCheckpoint:
          type: string
          description: Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
        ReplicationCreateTime:
          type: string
          format: date-time
          description: The time the serverless replication was created.
        ReplicationUpdateTime:
          type: string
          format: date-time
          description: The time the serverless replication was updated.
        ReplicationLastStopTime:
          type: string
          format: date-time
          description: The timestamp when replication was last stopped.
        ReplicationDeprovisionTime:
          type: string
          format: date-time
          description: The timestamp when DMS will deprovision the replication.
        IsReadOnly:
          type: boolean
          description: Indicates whether the serverless replication is read-only. When set to true, this replication is managed by DMS as part of a zero-ETL integration and cannot be modified or deleted directly. You can only modify or delete read-only replications through their associated zero-ETL integration.
    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
    ReplicationStats:
      type: object
      properties:
        FullLoadProgressPercent:
          type: integer
          description: The percent complete for the full load serverless replication.
        ElapsedTimeMillis:
          type: integer
          description: The elapsed time of the replication, in milliseconds.
        TablesLoaded:
          type: integer
          description: The number of tables loaded for this replication.
        TablesLoading:
          type: integer
          description: The number of tables currently loading for this replication.
        TablesQueued:
          type: integer
          description: The number of tables queued for this replication.
        TablesErrored:
          type: integer
          description: The number of errors that have occured for this replication.
        FreshStartDate:
          type: string
          format: date-time
          description: The date the replication was started either with a fresh start or a target reload.
        StartDate:
          type: string
          format: date-time
          description: The date the replication is scheduled to start.
        StopDate:
          type: string
          format: date-time
          description: The date the replication was stopped.
        FullLoadStartDate:
          type: string
          format: date-time
          description: The date the replication full load was started.
        FullLoadFinishDate:
          type: string
          format: date-time
          description: The date the replication full load was finished.
    StopReplicationResponse:
      type: object
      properties:
        Replication:
          $ref: '#/components/schemas/Replication'
    StartReplicationMessage:
      type: object
      properties:
        ReplicationConfigArn:
          type: string
          description: The Amazon Resource Name of the replication for which to start replication.
        StartReplicationType:
          type: string
          description: The replication type. When the replication type is full-load or full-load-and-cdc, the only valid value for the first run of the replication is start-replication. This option will start the replication. You can also use ReloadTables to reload specific tables that failed during replication instead of restarting the replication. The resume-processing option isn't applicable for a full-load replication, because you can't resume partially loaded tables during the full load phase. For a full-load-and-cdc replication, DMS migrates table data, and then applies data changes that occur on the source. T
        PremigrationAssessmentSettings:
          type: string
          description: 'User-defined settings for the premigration assessment. The possible values are: ResultLocationFolder: The folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run. ResultEncryptionMode: The supported values are SSE_KMS and SSE_S3. If these values are not provided, then the files are not encrypted at rest. For more information, see Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects. ResultKmsKeyArn: The ARN of a customer KMS encryption key that you specify when you set ResultEncryptionMode to SSE_KMS. IncludeOnly: A space-separated '
        CdcStartTime:
          type: string
          format: date-time
          description: Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
        CdcStartPosition:
          type: string
          description: Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format.
        CdcStopPosition:
          type: string
          description: Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
      required:
      - ReplicationConfigArn
      - StartReplicationType
    StopReplicationMessage:
      type: object
      properties:
        ReplicationConfigArn:
          type: string
          description: The Amazon Resource Name of the replication to stop.
      required:
      - ReplicationConfigArn
    ReplicationTaskAssessmentRunProgress:
      type: object
      properties:
        IndividualAssessmentCount:
          type: integer
          description: The number of individual assessments that are specified to run.
        IndividualAssessmentCompletedCount:
          type: integer
          description: The number of individual assessments that have completed, successfully or not.
    DescribeReplicationsMessage:
      type: object
      properties:
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'Filters applied to the replications. Valid filter names: replication-config-arn | replication-config-id'
        MaxRecords:
          type: integer
          description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
        Marker:
          type: string
          description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    ReplicationTaskAssessmentRunResultStatistic:
      type: object
      properties:
        Passed:
          type: integer
          description: The number of individual assessments that successfully passed all checks in the assessment run.
        Failed:
          type: integer
          description: The number of individual assessments that failed to meet the criteria defined in the assessment run.
        Error:
          type: integer
          description: The number of individual assessments that encountered a critical error and could not complete properly.
        Warning:
          type: integer
          description: Indicates that the recent completed AssessmentRun triggered a warning.
        Cancelled:
          type: integer
          description: The number of individual assessments that were cancelled during the assessment run.
        Skipped:
          type: integer
          description: The number of individual assessments that were skipped during the assessment run.
  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)