Amazon DMS #X Amz Target=AmazonDMSv20160101.CreateReplicationTask API
The #X Amz Target=AmazonDMSv20160101.CreateReplicationTask API from Amazon DMS — 1 operation(s) for #x amz target=amazondmsv20160101.createreplicationtask.
The #X Amz Target=AmazonDMSv20160101.CreateReplicationTask API from Amazon DMS — 1 operation(s) for #x amz target=amazondmsv20160101.createreplicationtask.
openapi: 3.0.0
info:
version: 2016-01-01
x-release: v4
title: 'AWS Database Migration Service Endpoints #X Amz Target=AmazonDMSv20160101.CreateReplicationTask API'
description: <fullname>Database Migration Service</fullname> <p>Database Migration Service (DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.</p> <p>For more information about DMS, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html">What Is Database Migration Service?</a> in the <i>Database Migration Service User Guide.</i> </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: dms
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/dms-2016-01-01.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://dms.{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 Database Migration Service multi-region endpoint
- url: https://dms.{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 Database Migration Service multi-region endpoint
- url: http://dms.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Database Migration Service endpoint for China (Beijing) and China (Ningxia)
- url: https://dms.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Database Migration Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AmazonDMSv20160101.CreateReplicationTask'
paths:
/#X-Amz-Target=AmazonDMSv20160101.CreateReplicationTask:
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: CreateReplicationTask
description: Creates a replication task using the specified parameters.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateReplicationTaskResponse'
'480':
description: AccessDeniedFault
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedFault'
'481':
description: InvalidResourceStateFault
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateFault'
'482':
description: ResourceAlreadyExistsFault
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsFault'
'483':
description: ResourceNotFoundFault
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundFault'
'484':
description: KMSKeyNotAccessibleFault
content:
application/json:
schema:
$ref: '#/components/schemas/KMSKeyNotAccessibleFault'
'485':
description: ResourceQuotaExceededFault
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceQuotaExceededFault'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateReplicationTaskMessage'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonDMSv20160101.CreateReplicationTask
tags:
- '#X Amz Target=AmazonDMSv20160101.CreateReplicationTask'
components:
schemas:
Tag:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can''t be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
Value:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can''t be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
ResourceArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
description: <p>A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:</p> <ul> <li> <p> <code>AddTagsToResource</code> </p> </li> <li> <p> <code>ListTagsForResource</code> </p> </li> <li> <p> <code>RemoveTagsFromResource</code> </p> </li> </ul>
KMSKeyNotAccessibleFault: {}
CreateReplicationTaskResponse:
type: object
example:
ReplicationTask:
MigrationType: full-load
ReplicationInstanceArn: arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ
ReplicationTaskArn: arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM
ReplicationTaskCreationDate: 2016-12-14 18:25:43+00:00
ReplicationTaskIdentifier: task1
ReplicationTaskSettings: '{"TargetMetadata":{"TargetSchema":"","SupportLobs":true,"FullLobMode":true,"LobChunkSize":64,"LimitedSizeLobMode":false,"LobMaxSize":0},"FullLoadSettings":{"FullLoadEnabled":true,"ApplyChangesEnabled":false,"TargetTablePrepMode":"DROP_AND_CREATE","CreatePkAfterFullLoad":false,"StopTaskCachedChangesApplied":false,"StopTaskCachedChangesNotApplied":false,"ResumeEnabled":false,"ResumeMinTableSize":100000,"ResumeOnlyClusteredPKTables":true,"MaxFullLoadSubTasks":8,"TransactionConsistencyTimeout":600,"CommitRate":10000},"Logging":{"EnableLogging":false}}'
SourceEndpointArn: arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE
Status: creating
TableMappings: file://mappingfile.json
TargetEndpointArn: arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E
properties:
ReplicationTask:
allOf:
- $ref: '#/components/schemas/ReplicationTask'
- description: The replication task that was created.
description: <p/>
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
TStamp:
type: string
format: date-time
ReplicationTask:
type: object
properties:
ReplicationTaskIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The user-assigned replication task identifier or name.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>
SourceEndpointArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
TargetEndpointArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN that uniquely identifies the endpoint.
ReplicationInstanceArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN of the replication instance.
MigrationType:
allOf:
- $ref: '#/components/schemas/MigrationTypeValue'
- description: The type of migration.
TableMappings:
allOf:
- $ref: '#/components/schemas/String'
- description: Table mappings specified in the task.
ReplicationTaskSettings:
allOf:
- $ref: '#/components/schemas/String'
- description: The settings for the replication task.
Status:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The status of the replication task. This response parameter can return one of the following values:</p> <ul> <li> <p> <code>"moving"</code> – The task is being moved in response to running the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html"> <code>MoveReplicationTask</code> </a> operation.</p> </li> <li> <p> <code>"creating"</code> – The task is being created in response to running the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html"> <code>CreateReplicationTask</code> </a> operation.</p> </li> <li> <p> <code>"deleting"</code> – The task is being deleted in response to running the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html"> <code>DeleteReplicationTask</code> </a> operation.</p> </li> <li> <p> <code>"failed"</code> – The task failed to successfully complete the database migration in response to running the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html"> <code>StartReplicationTask</code> </a> operation.</p> </li> <li> <p> <code>"failed-move"</code> – The task failed to move in response to running the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html"> <code>MoveReplicationTask</code> </a> operation.</p> </li> <li> <p> <code>"modifying"</code> – The task definition is being modified in response to running the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html"> <code>ModifyReplicationTask</code> </a> operation.</p> </li> <li> <p> <code>"ready"</code> – The task is in a <code>ready</code> state where it can respond to other task operations, such as <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html"> <code>StartReplicationTask</code> </a> or <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html"> <code>DeleteReplicationTask</code> </a>. </p> </li> <li> <p> <code>"running"</code> – The task is performing a database migration in response to running the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html"> <code>StartReplicationTask</code> </a> operation.</p> </li> <li> <p> <code>"starting"</code> – The task is preparing to perform a database migration in response to running the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html"> <code>StartReplicationTask</code> </a> operation.</p> </li> <li> <p> <code>"stopped"</code> – The task has stopped in response to running the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html"> <code>StopReplicationTask</code> </a> operation.</p> </li> <li> <p> <code>"stopping"</code> – The task is preparing to stop in response to running the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html"> <code>StopReplicationTask</code> </a> operation.</p> </li> <li> <p> <code>"testing"</code> – The database migration specified for this task is being tested in response to running either the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html"> <code>StartReplicationTaskAssessmentRun</code> </a> or the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html"> <code>StartReplicationTaskAssessment</code> </a> operation.</p> <note> <p> <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html"> <code>StartReplicationTaskAssessmentRun</code> </a> is an improved premigration task assessment operation. The <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html"> <code>StartReplicationTaskAssessment</code> </a> operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html"> <code>StartReplicationTaskAssessmentRun</code> </a> enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.</p> </note> </li> </ul>
LastFailureMessage:
allOf:
- $ref: '#/components/schemas/String'
- description: The last error (failure) message generated for the replication task.
StopReason:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The reason the replication task was stopped. This response parameter can return one of the following values:</p> <ul> <li> <p> <code>"Stop Reason NORMAL"</code> </p> </li> <li> <p> <code>"Stop Reason RECOVERABLE_ERROR"</code> </p> </li> <li> <p> <code>"Stop Reason FATAL_ERROR"</code> </p> </li> <li> <p> <code>"Stop Reason FULL_LOAD_ONLY_FINISHED"</code> </p> </li> <li> <p> <code>"Stop Reason STOPPED_AFTER_FULL_LOAD"</code> – Full load completed, with cached changes not applied</p> </li> <li> <p> <code>"Stop Reason STOPPED_AFTER_CACHED_EVENTS"</code> – Full load completed, with cached changes applied</p> </li> <li> <p> <code>"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"</code> </p> </li> <li> <p> <code>"Stop Reason STOPPED_AFTER_DDL_APPLY"</code> – User-defined stop task after DDL applied</p> </li> <li> <p> <code>"Stop Reason STOPPED_DUE_TO_LOW_MEMORY"</code> </p> </li> <li> <p> <code>"Stop Reason STOPPED_DUE_TO_LOW_DISK"</code> </p> </li> <li> <p> <code>"Stop Reason STOPPED_AT_SERVER_TIME"</code> – User-defined server time for stopping task</p> </li> <li> <p> <code>"Stop Reason STOPPED_AT_COMMIT_TIME"</code> – User-defined commit time for stopping task</p> </li> <li> <p> <code>"Stop Reason RECONFIGURATION_RESTART"</code> </p> </li> <li> <p> <code>"Stop Reason RECYCLE_TASK"</code> </p> </li> </ul>
ReplicationTaskCreationDate:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The date the replication task was created.
ReplicationTaskStartDate:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The date the replication task is scheduled to start.
CdcStartPosition:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>Indicates when you want a change data capture (CDC) operation to start. Use either <code>CdcStartPosition</code> or <code>CdcStartTime</code> to specify when you want the CDC operation to start. Specifying both values results in an error.</p> <p>The value can be in date, checkpoint, or LSN/SCN format.</p> <p>Date Example: --cdc-start-position “2018-03-08T12:12:12”</p> <p>Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"</p> <p>LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”</p>'
CdcStopPosition:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.</p> <p>Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”</p> <p>Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“</p>'
RecoveryCheckpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the <code>CdcStartPosition</code> parameter to start a CDC operation that begins at that checkpoint.
ReplicationTaskArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskStats:
allOf:
- $ref: '#/components/schemas/ReplicationTaskStats'
- description: The statistics for the task, including elapsed time, tables loaded, and table errors.
TaskData:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html">Specifying Supplemental Data for Task Settings</a> in the <i>Database Migration Service User Guide.</i> '
TargetReplicationInstanceArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN of the replication instance to which this task is moved in response to running the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html"> <code>MoveReplicationTask</code> </a> operation. Otherwise, this response parameter isn't a member of the <code>ReplicationTask</code> object.
description: Provides information that describes a replication task created by the <code>CreateReplicationTask</code> operation.
CreateReplicationTaskMessage:
type: object
required:
- ReplicationTaskIdentifier
- SourceEndpointArn
- TargetEndpointArn
- ReplicationInstanceArn
- MigrationType
- TableMappings
title: CreateReplicationTaskMessage
properties:
ReplicationTaskIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>An identifier for the replication task.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>
SourceEndpointArn:
allOf:
- $ref: '#/components/schemas/String'
- description: An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
TargetEndpointArn:
allOf:
- $ref: '#/components/schemas/String'
- description: An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
ReplicationInstanceArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) of a replication instance.
MigrationType:
allOf:
- $ref: '#/components/schemas/MigrationTypeValue'
- description: 'The migration type. Valid values: <code>full-load</code> | <code>cdc</code> | <code>full-load-and-cdc</code> '
TableMappings:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The table mappings for the task, in JSON format. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html">Using Table Mapping to Specify Task Settings</a> in the <i>Database Migration Service User Guide.</i> '
ReplicationTaskSettings:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Overall settings for the task, in JSON format. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html">Specifying Task Settings for Database Migration Service Tasks</a> in the <i>Database Migration Service User Guide.</i> '
CdcStartTime:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: '<p>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.</p> <p>Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”</p>'
CdcStartPosition:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>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.</p> <p> The value can be in date, checkpoint, or LSN/SCN format.</p> <p>Date Example: --cdc-start-position “2018-03-08T12:12:12”</p> <p>Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"</p> <p>LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”</p> <note> <p>When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the <code>slotName</code> extra connection attribute to the name of this logical replication slot. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib">Extra Connection Attributes When Using PostgreSQL as a Source for DMS</a>.</p> </note>'
CdcStopPosition:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.</p> <p>Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”</p> <p>Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“</p>'
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: One or more tags to be assigned to the replication task.
TaskData:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html">Specifying Supplemental Data for Task Settings</a> in the <i>Database Migration Service User Guide.</i> '
ResourceIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: A friendly name for the resource identifier at the end of the <code>EndpointArn</code> response parameter that is returned in the created <code>Endpoint</code> object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as <code>Example-App-ARN1</code>. For example, this value might result in the <code>EndpointArn</code> value <code>arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1</code>. If you don't specify a <code>ResourceIdentifier</code> value, DMS generates a default identifier value for the end of <code>EndpointArn</code>.
description: <p/>
Integer:
type: integer
InvalidResourceStateFault: {}
MigrationTypeValue:
type: string
enum:
- full-load
- cdc
- full-load-and-cdc
ResourceQuotaExceededFault: {}
ReplicationTaskStats:
type: object
properties:
FullLoadProgressPercent:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The percent complete for the full load migration task.
ElapsedTimeMillis:
allOf:
- $ref: '#/components/schemas/Long'
- description: The elapsed time of the task, in milliseconds.
TablesLoaded:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of tables loaded for this task.
TablesLoading:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of tables currently loading for this task.
TablesQueued:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of tables queued for this task.
TablesErrored:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of errors that have occurred during this task.
FreshStartDate:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The date the replication task was started either with a fresh start or a target reload.
StartDate:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The date the replication task was started either with a fresh start or a resume. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html#DMS-StartReplicationTask-request-StartReplicationTaskType">StartReplicationTaskType</a>.
StopDate:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The date the replication task was stopped.
FullLoadStartDate:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The date the replication task full load was started.
FullLoadFinishDate:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The date the replication task full load was completed.
description: In response to a request by the <code>DescribeReplicationTasks</code> operation, this object provides a collection of statistics about a replication task.
AccessDeniedFault: {}
String:
type: string
Long:
type: integer
ResourceNotFoundFault: {}
ResourceAlreadyExistsFault: {}
parameters:
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-Credential:
name: X-Amz-Credential
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-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
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/dms/
x-hasEquivalentPaths: true