2025/02/28 - AWS Database Migration Service - 7 updated api methods
Changes Add skipped status to the Result Statistics of an Assessment Run
{'ReplicationTaskAssessmentRun': {'ResultStatistic': {'Skipped': 'integer'}}}
Cancels a single premigration assessment run.
This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
See also: AWS API Documentation
Request Syntax
client.cancel_replication_task_assessment_run(
ReplicationTaskAssessmentRunArn='string'
)
string
[REQUIRED]
Amazon Resource Name (ARN) of the premigration assessment run to be canceled.
dict
Response Syntax
{
'ReplicationTaskAssessmentRun': {
'ReplicationTaskAssessmentRunArn': 'string',
'ReplicationTaskArn': 'string',
'Status': 'string',
'ReplicationTaskAssessmentRunCreationDate': datetime(2015, 1, 1),
'AssessmentProgress': {
'IndividualAssessmentCount': 123,
'IndividualAssessmentCompletedCount': 123
},
'LastFailureMessage': 'string',
'ServiceAccessRoleArn': 'string',
'ResultLocationBucket': 'string',
'ResultLocationFolder': 'string',
'ResultEncryptionMode': 'string',
'ResultKmsKeyArn': 'string',
'AssessmentRunName': 'string',
'IsLatestTaskAssessmentRun': True|False,
'ResultStatistic': {
'Passed': 123,
'Failed': 123,
'Error': 123,
'Warning': 123,
'Cancelled': 123,
'Skipped': 123
}
}
}
Response Structure
(dict) --
ReplicationTaskAssessmentRun (dict) --
The ReplicationTaskAssessmentRun object for the canceled assessment run.
ReplicationTaskAssessmentRunArn (string) --
Amazon Resource Name (ARN) of this assessment run.
ReplicationTaskArn (string) --
ARN of the migration task associated with this premigration assessment run.
Status (string) --
Assessment run status.
This status can have one of the following values:
"cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.
"deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.
"failed" – At least one individual assessment completed with a failed status.
"error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).
"error-executing" – An internal error occurred while individual assessments ran (during running status).
"invalid state" – The assessment run is in an unknown state.
"passed" – All individual assessments have completed, and none has a failed status.
"provisioning" – Resources required to run individual assessments are being provisioned.
"running" – Individual assessments are being run.
"starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.
"warning" – At least one individual assessment completed with a warning status or all individual assessments were skipped (completed with a skipped status).
ReplicationTaskAssessmentRunCreationDate (datetime) --
Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.
AssessmentProgress (dict) --
Indication of the completion progress for the individual assessments specified to run.
IndividualAssessmentCount (integer) --
The number of individual assessments that are specified to run.
IndividualAssessmentCompletedCount (integer) --
The number of individual assessments that have completed, successfully or not.
LastFailureMessage (string) --
Last message generated by an individual assessment failure.
ServiceAccessRoleArn (string) --
ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.
ResultLocationBucket (string) --
Amazon S3 bucket where DMS stores the results of this assessment run.
ResultLocationFolder (string) --
Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.
ResultEncryptionMode (string) --
Encryption mode used to encrypt the assessment run results.
ResultKmsKeyArn (string) --
ARN of the KMS encryption key used to encrypt the assessment run results.
AssessmentRunName (string) --
Unique name of the assessment run.
IsLatestTaskAssessmentRun (boolean) --
Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.
ResultStatistic (dict) --
Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.
Passed (integer) --
The number of individual assessments that successfully passed all checks in the assessment run.
Failed (integer) --
The number of individual assessments that failed to meet the criteria defined in the assessment run.
Error (integer) --
The number of individual assessments that encountered a critical error and could not complete properly.
Warning (integer) --
Indicates that the recent completed AssessmentRun triggered a warning.
Cancelled (integer) --
The number of individual assessments that were cancelled during the assessment run.
Skipped (integer) --
The number of individual assessments that were skipped during the assessment run.
{'ReplicationTaskAssessmentRun': {'ResultStatistic': {'Skipped': 'integer'}}}
Deletes the record of a single premigration assessment run.
This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.
See also: AWS API Documentation
Request Syntax
client.delete_replication_task_assessment_run(
ReplicationTaskAssessmentRunArn='string'
)
string
[REQUIRED]
Amazon Resource Name (ARN) of the premigration assessment run to be deleted.
dict
Response Syntax
{
'ReplicationTaskAssessmentRun': {
'ReplicationTaskAssessmentRunArn': 'string',
'ReplicationTaskArn': 'string',
'Status': 'string',
'ReplicationTaskAssessmentRunCreationDate': datetime(2015, 1, 1),
'AssessmentProgress': {
'IndividualAssessmentCount': 123,
'IndividualAssessmentCompletedCount': 123
},
'LastFailureMessage': 'string',
'ServiceAccessRoleArn': 'string',
'ResultLocationBucket': 'string',
'ResultLocationFolder': 'string',
'ResultEncryptionMode': 'string',
'ResultKmsKeyArn': 'string',
'AssessmentRunName': 'string',
'IsLatestTaskAssessmentRun': True|False,
'ResultStatistic': {
'Passed': 123,
'Failed': 123,
'Error': 123,
'Warning': 123,
'Cancelled': 123,
'Skipped': 123
}
}
}
Response Structure
(dict) --
ReplicationTaskAssessmentRun (dict) --
The ReplicationTaskAssessmentRun object for the deleted assessment run.
ReplicationTaskAssessmentRunArn (string) --
Amazon Resource Name (ARN) of this assessment run.
ReplicationTaskArn (string) --
ARN of the migration task associated with this premigration assessment run.
Status (string) --
Assessment run status.
This status can have one of the following values:
"cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.
"deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.
"failed" – At least one individual assessment completed with a failed status.
"error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).
"error-executing" – An internal error occurred while individual assessments ran (during running status).
"invalid state" – The assessment run is in an unknown state.
"passed" – All individual assessments have completed, and none has a failed status.
"provisioning" – Resources required to run individual assessments are being provisioned.
"running" – Individual assessments are being run.
"starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.
"warning" – At least one individual assessment completed with a warning status or all individual assessments were skipped (completed with a skipped status).
ReplicationTaskAssessmentRunCreationDate (datetime) --
Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.
AssessmentProgress (dict) --
Indication of the completion progress for the individual assessments specified to run.
IndividualAssessmentCount (integer) --
The number of individual assessments that are specified to run.
IndividualAssessmentCompletedCount (integer) --
The number of individual assessments that have completed, successfully or not.
LastFailureMessage (string) --
Last message generated by an individual assessment failure.
ServiceAccessRoleArn (string) --
ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.
ResultLocationBucket (string) --
Amazon S3 bucket where DMS stores the results of this assessment run.
ResultLocationFolder (string) --
Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.
ResultEncryptionMode (string) --
Encryption mode used to encrypt the assessment run results.
ResultKmsKeyArn (string) --
ARN of the KMS encryption key used to encrypt the assessment run results.
AssessmentRunName (string) --
Unique name of the assessment run.
IsLatestTaskAssessmentRun (boolean) --
Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.
ResultStatistic (dict) --
Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.
Passed (integer) --
The number of individual assessments that successfully passed all checks in the assessment run.
Failed (integer) --
The number of individual assessments that failed to meet the criteria defined in the assessment run.
Error (integer) --
The number of individual assessments that encountered a critical error and could not complete properly.
Warning (integer) --
Indicates that the recent completed AssessmentRun triggered a warning.
Cancelled (integer) --
The number of individual assessments that were cancelled during the assessment run.
Skipped (integer) --
The number of individual assessments that were skipped during the assessment run.
{'ReplicationTaskAssessmentRuns': {'ResultStatistic': {'Skipped': 'integer'}}}
Returns a paginated list of premigration assessment runs based on filter settings.
These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values.
See also: AWS API Documentation
Request Syntax
client.describe_replication_task_assessment_runs(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to the premigration assessment runs described in the form of key-value pairs.
Valid filter names: replication-task-assessment-run-arn, replication-task-arn, replication-instance-arn, status
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
integer
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.
string
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.
dict
Response Syntax
{
'Marker': 'string',
'ReplicationTaskAssessmentRuns': [
{
'ReplicationTaskAssessmentRunArn': 'string',
'ReplicationTaskArn': 'string',
'Status': 'string',
'ReplicationTaskAssessmentRunCreationDate': datetime(2015, 1, 1),
'AssessmentProgress': {
'IndividualAssessmentCount': 123,
'IndividualAssessmentCompletedCount': 123
},
'LastFailureMessage': 'string',
'ServiceAccessRoleArn': 'string',
'ResultLocationBucket': 'string',
'ResultLocationFolder': 'string',
'ResultEncryptionMode': 'string',
'ResultKmsKeyArn': 'string',
'AssessmentRunName': 'string',
'IsLatestTaskAssessmentRun': True|False,
'ResultStatistic': {
'Passed': 123,
'Failed': 123,
'Error': 123,
'Warning': 123,
'Cancelled': 123,
'Skipped': 123
}
},
]
}
Response Structure
(dict) --
Marker (string) --
A pagination token returned for you to pass to a subsequent request. If you pass this token as the Marker value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request by MaxRecords.
ReplicationTaskAssessmentRuns (list) --
One or more premigration assessment runs as specified by Filters.
(dict) --
Provides information that describes a premigration assessment run that you have started using the StartReplicationTaskAssessmentRun operation.
Some of the information appears based on other operations that can return the ReplicationTaskAssessmentRun object.
ReplicationTaskAssessmentRunArn (string) --
Amazon Resource Name (ARN) of this assessment run.
ReplicationTaskArn (string) --
ARN of the migration task associated with this premigration assessment run.
Status (string) --
Assessment run status.
This status can have one of the following values:
"cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.
"deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.
"failed" – At least one individual assessment completed with a failed status.
"error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).
"error-executing" – An internal error occurred while individual assessments ran (during running status).
"invalid state" – The assessment run is in an unknown state.
"passed" – All individual assessments have completed, and none has a failed status.
"provisioning" – Resources required to run individual assessments are being provisioned.
"running" – Individual assessments are being run.
"starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.
"warning" – At least one individual assessment completed with a warning status or all individual assessments were skipped (completed with a skipped status).
ReplicationTaskAssessmentRunCreationDate (datetime) --
Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.
AssessmentProgress (dict) --
Indication of the completion progress for the individual assessments specified to run.
IndividualAssessmentCount (integer) --
The number of individual assessments that are specified to run.
IndividualAssessmentCompletedCount (integer) --
The number of individual assessments that have completed, successfully or not.
LastFailureMessage (string) --
Last message generated by an individual assessment failure.
ServiceAccessRoleArn (string) --
ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.
ResultLocationBucket (string) --
Amazon S3 bucket where DMS stores the results of this assessment run.
ResultLocationFolder (string) --
Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.
ResultEncryptionMode (string) --
Encryption mode used to encrypt the assessment run results.
ResultKmsKeyArn (string) --
ARN of the KMS encryption key used to encrypt the assessment run results.
AssessmentRunName (string) --
Unique name of the assessment run.
IsLatestTaskAssessmentRun (boolean) --
Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.
ResultStatistic (dict) --
Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.
Passed (integer) --
The number of individual assessments that successfully passed all checks in the assessment run.
Failed (integer) --
The number of individual assessments that failed to meet the criteria defined in the assessment run.
Error (integer) --
The number of individual assessments that encountered a critical error and could not complete properly.
Warning (integer) --
Indicates that the recent completed AssessmentRun triggered a warning.
Cancelled (integer) --
The number of individual assessments that were cancelled during the assessment run.
Skipped (integer) --
The number of individual assessments that were skipped during the assessment run.
{'Replications': {'PremigrationAssessmentStatuses': {'ResultStatistic': {'Skipped': 'integer'}}}}
Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.
See also: AWS API Documentation
Request Syntax
client.describe_replications(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to the replications.
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
integer
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.
string
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.
dict
Response Syntax
{
'Marker': 'string',
'Replications': [
{
'ReplicationConfigIdentifier': 'string',
'ReplicationConfigArn': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationType': 'full-load'|'cdc'|'full-load-and-cdc',
'Status': 'string',
'ProvisionData': {
'ProvisionState': 'string',
'ProvisionedCapacityUnits': 123,
'DateProvisioned': datetime(2015, 1, 1),
'IsNewProvisioningAvailable': True|False,
'DateNewProvisioningDataAvailable': datetime(2015, 1, 1),
'ReasonForNewProvisioningData': 'string'
},
'PremigrationAssessmentStatuses': [
{
'PremigrationAssessmentRunArn': 'string',
'FailOnAssessmentFailure': True|False,
'Status': 'string',
'PremigrationAssessmentRunCreationDate': datetime(2015, 1, 1),
'AssessmentProgress': {
'IndividualAssessmentCount': 123,
'IndividualAssessmentCompletedCount': 123
},
'LastFailureMessage': 'string',
'ResultLocationBucket': 'string',
'ResultLocationFolder': 'string',
'ResultEncryptionMode': 'string',
'ResultKmsKeyArn': 'string',
'ResultStatistic': {
'Passed': 123,
'Failed': 123,
'Error': 123,
'Warning': 123,
'Cancelled': 123,
'Skipped': 123
}
},
],
'StopReason': 'string',
'FailureMessages': [
'string',
],
'ReplicationStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'StartReplicationType': 'string',
'CdcStartTime': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationCreateTime': datetime(2015, 1, 1),
'ReplicationUpdateTime': datetime(2015, 1, 1),
'ReplicationLastStopTime': datetime(2015, 1, 1),
'ReplicationDeprovisionTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Marker (string) --
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 (list) --
The replication descriptions.
(dict) --
Provides information that describes a serverless replication created by the CreateReplication operation.
ReplicationConfigIdentifier (string) --
The identifier for the ReplicationConfig associated with the replication.
ReplicationConfigArn (string) --
The Amazon Resource Name for the ReplicationConfig associated with the replication.
SourceEndpointArn (string) --
The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data source.
TargetEndpointArn (string) --
The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data target.
ReplicationType (string) --
The type of the serverless replication.
Status (string) --
The current status of the serverless replication.
ProvisionData (dict) --
Information about provisioning resources for an DMS serverless replication.
ProvisionState (string) --
The current provisioning state
ProvisionedCapacityUnits (integer) --
The number of capacity units the replication is using.
DateProvisioned (datetime) --
The timestamp when DMS provisioned replication resources.
IsNewProvisioningAvailable (boolean) --
Whether the new provisioning is available to the replication.
DateNewProvisioningDataAvailable (datetime) --
The timestamp when provisioning became available.
ReasonForNewProvisioningData (string) --
A message describing the reason that DMS provisioned new resources for the serverless replication.
PremigrationAssessmentStatuses (list) --
The status output of premigration assessment in describe-replications.
(dict) --
The results returned in describe-replications to display the results of the premigration assessment from the replication configuration.
PremigrationAssessmentRunArn (string) --
The Amazon Resource Name (ARN) of this assessment run.
FailOnAssessmentFailure (boolean) --
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 (string) --
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 status.
provisioning: The resources required to run individual assessments are being provisioned.
running: Individual assessments are being run.
starting: The assessment run is starting, but resources are not yet being provisioned for individual assessments.
warning: At least one individual assessment completed with a warning status.
PremigrationAssessmentRunCreationDate (datetime) --
The date which the assessment run was created.
AssessmentProgress (dict) --
The progress values reported by the AssessmentProgress response element.
IndividualAssessmentCount (integer) --
The number of individual assessments that are specified to run.
IndividualAssessmentCompletedCount (integer) --
The number of individual assessments that have completed, successfully or not.
LastFailureMessage (string) --
The last message generated by an individual assessment failure.
ResultLocationBucket (string) --
The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.
ResultLocationFolder (string) --
The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.
ResultEncryptionMode (string) --
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 (string) --
The ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to SSE_KMS.
ResultStatistic (dict) --
The object containing the result statistics for a completed assessment run.
Passed (integer) --
The number of individual assessments that successfully passed all checks in the assessment run.
Failed (integer) --
The number of individual assessments that failed to meet the criteria defined in the assessment run.
Error (integer) --
The number of individual assessments that encountered a critical error and could not complete properly.
Warning (integer) --
Indicates that the recent completed AssessmentRun triggered a warning.
Cancelled (integer) --
The number of individual assessments that were cancelled during the assessment run.
Skipped (integer) --
The number of individual assessments that were skipped during the assessment run.
StopReason (string) --
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_DUE_TO_LOW_DISK"
"Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task
"Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task
"Stop Reason RECONFIGURATION_RESTART"
"Stop Reason RECYCLE_TASK"
FailureMessages (list) --
Error and other information about why a serverless replication failed.
(string) --
ReplicationStats (dict) --
This object provides a collection of statistics about a serverless replication.
FullLoadProgressPercent (integer) --
The percent complete for the full load serverless replication.
ElapsedTimeMillis (integer) --
The elapsed time of the replication, in milliseconds.
TablesLoaded (integer) --
The number of tables loaded for this replication.
TablesLoading (integer) --
The number of tables currently loading for this replication.
TablesQueued (integer) --
The number of tables queued for this replication.
TablesErrored (integer) --
The number of errors that have occured for this replication.
FreshStartDate (datetime) --
The date the replication was started either with a fresh start or a target reload.
StartDate (datetime) --
The date the replication is scheduled to start.
StopDate (datetime) --
The date the replication was stopped.
FullLoadStartDate (datetime) --
The date the replication full load was started.
FullLoadFinishDate (datetime) --
The date the replication full load was finished.
StartReplicationType (string) --
The type of replication to start.
CdcStartTime (datetime) --
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 (string) --
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 (string) --
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
RecoveryCheckpoint (string) --
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 (datetime) --
The time the serverless replication was created.
ReplicationUpdateTime (datetime) --
The time the serverless replication was updated.
ReplicationLastStopTime (datetime) --
The timestamp when replication was last stopped.
ReplicationDeprovisionTime (datetime) --
The timestamp when DMS will deprovision the replication.
{'Replication': {'PremigrationAssessmentStatuses': {'ResultStatistic': {'Skipped': 'integer'}}}}
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.
See also: AWS API Documentation
Request Syntax
client.start_replication(
ReplicationConfigArn='string',
StartReplicationType='string',
PremigrationAssessmentSettings='string',
CdcStartTime=datetime(2015, 1, 1),
CdcStartPosition='string',
CdcStopPosition='string'
)
string
[REQUIRED]
The Amazon Resource Name of the replication for which to start replication.
string
[REQUIRED]
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. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.
string
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 list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that Database Migration Service supports for the associated migration.
Exclude: A space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that Database Migration Service supports for the associated migration.
FailOnAssessmentFailure: A configurable setting you can set to true (the default 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.
datetime
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.
string
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.
string
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
dict
Response Syntax
{
'Replication': {
'ReplicationConfigIdentifier': 'string',
'ReplicationConfigArn': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationType': 'full-load'|'cdc'|'full-load-and-cdc',
'Status': 'string',
'ProvisionData': {
'ProvisionState': 'string',
'ProvisionedCapacityUnits': 123,
'DateProvisioned': datetime(2015, 1, 1),
'IsNewProvisioningAvailable': True|False,
'DateNewProvisioningDataAvailable': datetime(2015, 1, 1),
'ReasonForNewProvisioningData': 'string'
},
'PremigrationAssessmentStatuses': [
{
'PremigrationAssessmentRunArn': 'string',
'FailOnAssessmentFailure': True|False,
'Status': 'string',
'PremigrationAssessmentRunCreationDate': datetime(2015, 1, 1),
'AssessmentProgress': {
'IndividualAssessmentCount': 123,
'IndividualAssessmentCompletedCount': 123
},
'LastFailureMessage': 'string',
'ResultLocationBucket': 'string',
'ResultLocationFolder': 'string',
'ResultEncryptionMode': 'string',
'ResultKmsKeyArn': 'string',
'ResultStatistic': {
'Passed': 123,
'Failed': 123,
'Error': 123,
'Warning': 123,
'Cancelled': 123,
'Skipped': 123
}
},
],
'StopReason': 'string',
'FailureMessages': [
'string',
],
'ReplicationStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'StartReplicationType': 'string',
'CdcStartTime': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationCreateTime': datetime(2015, 1, 1),
'ReplicationUpdateTime': datetime(2015, 1, 1),
'ReplicationLastStopTime': datetime(2015, 1, 1),
'ReplicationDeprovisionTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Replication (dict) --
The replication that DMS started.
ReplicationConfigIdentifier (string) --
The identifier for the ReplicationConfig associated with the replication.
ReplicationConfigArn (string) --
The Amazon Resource Name for the ReplicationConfig associated with the replication.
SourceEndpointArn (string) --
The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data source.
TargetEndpointArn (string) --
The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data target.
ReplicationType (string) --
The type of the serverless replication.
Status (string) --
The current status of the serverless replication.
ProvisionData (dict) --
Information about provisioning resources for an DMS serverless replication.
ProvisionState (string) --
The current provisioning state
ProvisionedCapacityUnits (integer) --
The number of capacity units the replication is using.
DateProvisioned (datetime) --
The timestamp when DMS provisioned replication resources.
IsNewProvisioningAvailable (boolean) --
Whether the new provisioning is available to the replication.
DateNewProvisioningDataAvailable (datetime) --
The timestamp when provisioning became available.
ReasonForNewProvisioningData (string) --
A message describing the reason that DMS provisioned new resources for the serverless replication.
PremigrationAssessmentStatuses (list) --
The status output of premigration assessment in describe-replications.
(dict) --
The results returned in describe-replications to display the results of the premigration assessment from the replication configuration.
PremigrationAssessmentRunArn (string) --
The Amazon Resource Name (ARN) of this assessment run.
FailOnAssessmentFailure (boolean) --
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 (string) --
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 status.
provisioning: The resources required to run individual assessments are being provisioned.
running: Individual assessments are being run.
starting: The assessment run is starting, but resources are not yet being provisioned for individual assessments.
warning: At least one individual assessment completed with a warning status.
PremigrationAssessmentRunCreationDate (datetime) --
The date which the assessment run was created.
AssessmentProgress (dict) --
The progress values reported by the AssessmentProgress response element.
IndividualAssessmentCount (integer) --
The number of individual assessments that are specified to run.
IndividualAssessmentCompletedCount (integer) --
The number of individual assessments that have completed, successfully or not.
LastFailureMessage (string) --
The last message generated by an individual assessment failure.
ResultLocationBucket (string) --
The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.
ResultLocationFolder (string) --
The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.
ResultEncryptionMode (string) --
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 (string) --
The ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to SSE_KMS.
ResultStatistic (dict) --
The object containing the result statistics for a completed assessment run.
Passed (integer) --
The number of individual assessments that successfully passed all checks in the assessment run.
Failed (integer) --
The number of individual assessments that failed to meet the criteria defined in the assessment run.
Error (integer) --
The number of individual assessments that encountered a critical error and could not complete properly.
Warning (integer) --
Indicates that the recent completed AssessmentRun triggered a warning.
Cancelled (integer) --
The number of individual assessments that were cancelled during the assessment run.
Skipped (integer) --
The number of individual assessments that were skipped during the assessment run.
StopReason (string) --
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_DUE_TO_LOW_DISK"
"Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task
"Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task
"Stop Reason RECONFIGURATION_RESTART"
"Stop Reason RECYCLE_TASK"
FailureMessages (list) --
Error and other information about why a serverless replication failed.
(string) --
ReplicationStats (dict) --
This object provides a collection of statistics about a serverless replication.
FullLoadProgressPercent (integer) --
The percent complete for the full load serverless replication.
ElapsedTimeMillis (integer) --
The elapsed time of the replication, in milliseconds.
TablesLoaded (integer) --
The number of tables loaded for this replication.
TablesLoading (integer) --
The number of tables currently loading for this replication.
TablesQueued (integer) --
The number of tables queued for this replication.
TablesErrored (integer) --
The number of errors that have occured for this replication.
FreshStartDate (datetime) --
The date the replication was started either with a fresh start or a target reload.
StartDate (datetime) --
The date the replication is scheduled to start.
StopDate (datetime) --
The date the replication was stopped.
FullLoadStartDate (datetime) --
The date the replication full load was started.
FullLoadFinishDate (datetime) --
The date the replication full load was finished.
StartReplicationType (string) --
The type of replication to start.
CdcStartTime (datetime) --
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 (string) --
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 (string) --
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
RecoveryCheckpoint (string) --
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 (datetime) --
The time the serverless replication was created.
ReplicationUpdateTime (datetime) --
The time the serverless replication was updated.
ReplicationLastStopTime (datetime) --
The timestamp when replication was last stopped.
ReplicationDeprovisionTime (datetime) --
The timestamp when DMS will deprovision the replication.
{'ReplicationTaskAssessmentRun': {'ResultStatistic': {'Skipped': 'integer'}}}
Starts a new premigration assessment run for one or more individual assessments of a migration task.
The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.
See also: AWS API Documentation
Request Syntax
client.start_replication_task_assessment_run(
ReplicationTaskArn='string',
ServiceAccessRoleArn='string',
ResultLocationBucket='string',
ResultLocationFolder='string',
ResultEncryptionMode='string',
ResultKmsKeyArn='string',
AssessmentRunName='string',
IncludeOnly=[
'string',
],
Exclude=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string',
'ResourceArn': 'string'
},
]
)
string
[REQUIRED]
Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.
string
[REQUIRED]
ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.
string
[REQUIRED]
Amazon S3 bucket where you want DMS to store the results of this assessment run.
string
Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.
string
Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:
"SSE_S3" – The server-side encryption provided as a default by Amazon S3.
"SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.
string
ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".
string
[REQUIRED]
Unique name to identify the assessment run.
list
Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.
(string) --
list
Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.
(string) --
list
One or more tags to be assigned to the premigration assessment run that you want to start.
(dict) --
A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:
AddTagsToResource
ListTagsForResource
RemoveTagsFromResource
Key (string) --
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 (string) --
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 (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
dict
Response Syntax
{
'ReplicationTaskAssessmentRun': {
'ReplicationTaskAssessmentRunArn': 'string',
'ReplicationTaskArn': 'string',
'Status': 'string',
'ReplicationTaskAssessmentRunCreationDate': datetime(2015, 1, 1),
'AssessmentProgress': {
'IndividualAssessmentCount': 123,
'IndividualAssessmentCompletedCount': 123
},
'LastFailureMessage': 'string',
'ServiceAccessRoleArn': 'string',
'ResultLocationBucket': 'string',
'ResultLocationFolder': 'string',
'ResultEncryptionMode': 'string',
'ResultKmsKeyArn': 'string',
'AssessmentRunName': 'string',
'IsLatestTaskAssessmentRun': True|False,
'ResultStatistic': {
'Passed': 123,
'Failed': 123,
'Error': 123,
'Warning': 123,
'Cancelled': 123,
'Skipped': 123
}
}
}
Response Structure
(dict) --
ReplicationTaskAssessmentRun (dict) --
The premigration assessment run that was started.
ReplicationTaskAssessmentRunArn (string) --
Amazon Resource Name (ARN) of this assessment run.
ReplicationTaskArn (string) --
ARN of the migration task associated with this premigration assessment run.
Status (string) --
Assessment run status.
This status can have one of the following values:
"cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.
"deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.
"failed" – At least one individual assessment completed with a failed status.
"error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).
"error-executing" – An internal error occurred while individual assessments ran (during running status).
"invalid state" – The assessment run is in an unknown state.
"passed" – All individual assessments have completed, and none has a failed status.
"provisioning" – Resources required to run individual assessments are being provisioned.
"running" – Individual assessments are being run.
"starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.
"warning" – At least one individual assessment completed with a warning status or all individual assessments were skipped (completed with a skipped status).
ReplicationTaskAssessmentRunCreationDate (datetime) --
Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.
AssessmentProgress (dict) --
Indication of the completion progress for the individual assessments specified to run.
IndividualAssessmentCount (integer) --
The number of individual assessments that are specified to run.
IndividualAssessmentCompletedCount (integer) --
The number of individual assessments that have completed, successfully or not.
LastFailureMessage (string) --
Last message generated by an individual assessment failure.
ServiceAccessRoleArn (string) --
ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.
ResultLocationBucket (string) --
Amazon S3 bucket where DMS stores the results of this assessment run.
ResultLocationFolder (string) --
Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.
ResultEncryptionMode (string) --
Encryption mode used to encrypt the assessment run results.
ResultKmsKeyArn (string) --
ARN of the KMS encryption key used to encrypt the assessment run results.
AssessmentRunName (string) --
Unique name of the assessment run.
IsLatestTaskAssessmentRun (boolean) --
Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.
ResultStatistic (dict) --
Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.
Passed (integer) --
The number of individual assessments that successfully passed all checks in the assessment run.
Failed (integer) --
The number of individual assessments that failed to meet the criteria defined in the assessment run.
Error (integer) --
The number of individual assessments that encountered a critical error and could not complete properly.
Warning (integer) --
Indicates that the recent completed AssessmentRun triggered a warning.
Cancelled (integer) --
The number of individual assessments that were cancelled during the assessment run.
Skipped (integer) --
The number of individual assessments that were skipped during the assessment run.
{'Replication': {'PremigrationAssessmentStatuses': {'ResultStatistic': {'Skipped': 'integer'}}}}
For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.
See also: AWS API Documentation
Request Syntax
client.stop_replication(
ReplicationConfigArn='string'
)
string
[REQUIRED]
The Amazon Resource Name of the replication to stop.
dict
Response Syntax
{
'Replication': {
'ReplicationConfigIdentifier': 'string',
'ReplicationConfigArn': 'string',
'SourceEndpointArn': 'string',
'TargetEndpointArn': 'string',
'ReplicationType': 'full-load'|'cdc'|'full-load-and-cdc',
'Status': 'string',
'ProvisionData': {
'ProvisionState': 'string',
'ProvisionedCapacityUnits': 123,
'DateProvisioned': datetime(2015, 1, 1),
'IsNewProvisioningAvailable': True|False,
'DateNewProvisioningDataAvailable': datetime(2015, 1, 1),
'ReasonForNewProvisioningData': 'string'
},
'PremigrationAssessmentStatuses': [
{
'PremigrationAssessmentRunArn': 'string',
'FailOnAssessmentFailure': True|False,
'Status': 'string',
'PremigrationAssessmentRunCreationDate': datetime(2015, 1, 1),
'AssessmentProgress': {
'IndividualAssessmentCount': 123,
'IndividualAssessmentCompletedCount': 123
},
'LastFailureMessage': 'string',
'ResultLocationBucket': 'string',
'ResultLocationFolder': 'string',
'ResultEncryptionMode': 'string',
'ResultKmsKeyArn': 'string',
'ResultStatistic': {
'Passed': 123,
'Failed': 123,
'Error': 123,
'Warning': 123,
'Cancelled': 123,
'Skipped': 123
}
},
],
'StopReason': 'string',
'FailureMessages': [
'string',
],
'ReplicationStats': {
'FullLoadProgressPercent': 123,
'ElapsedTimeMillis': 123,
'TablesLoaded': 123,
'TablesLoading': 123,
'TablesQueued': 123,
'TablesErrored': 123,
'FreshStartDate': datetime(2015, 1, 1),
'StartDate': datetime(2015, 1, 1),
'StopDate': datetime(2015, 1, 1),
'FullLoadStartDate': datetime(2015, 1, 1),
'FullLoadFinishDate': datetime(2015, 1, 1)
},
'StartReplicationType': 'string',
'CdcStartTime': datetime(2015, 1, 1),
'CdcStartPosition': 'string',
'CdcStopPosition': 'string',
'RecoveryCheckpoint': 'string',
'ReplicationCreateTime': datetime(2015, 1, 1),
'ReplicationUpdateTime': datetime(2015, 1, 1),
'ReplicationLastStopTime': datetime(2015, 1, 1),
'ReplicationDeprovisionTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Replication (dict) --
The replication that DMS stopped.
ReplicationConfigIdentifier (string) --
The identifier for the ReplicationConfig associated with the replication.
ReplicationConfigArn (string) --
The Amazon Resource Name for the ReplicationConfig associated with the replication.
SourceEndpointArn (string) --
The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data source.
TargetEndpointArn (string) --
The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data target.
ReplicationType (string) --
The type of the serverless replication.
Status (string) --
The current status of the serverless replication.
ProvisionData (dict) --
Information about provisioning resources for an DMS serverless replication.
ProvisionState (string) --
The current provisioning state
ProvisionedCapacityUnits (integer) --
The number of capacity units the replication is using.
DateProvisioned (datetime) --
The timestamp when DMS provisioned replication resources.
IsNewProvisioningAvailable (boolean) --
Whether the new provisioning is available to the replication.
DateNewProvisioningDataAvailable (datetime) --
The timestamp when provisioning became available.
ReasonForNewProvisioningData (string) --
A message describing the reason that DMS provisioned new resources for the serverless replication.
PremigrationAssessmentStatuses (list) --
The status output of premigration assessment in describe-replications.
(dict) --
The results returned in describe-replications to display the results of the premigration assessment from the replication configuration.
PremigrationAssessmentRunArn (string) --
The Amazon Resource Name (ARN) of this assessment run.
FailOnAssessmentFailure (boolean) --
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 (string) --
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 status.
provisioning: The resources required to run individual assessments are being provisioned.
running: Individual assessments are being run.
starting: The assessment run is starting, but resources are not yet being provisioned for individual assessments.
warning: At least one individual assessment completed with a warning status.
PremigrationAssessmentRunCreationDate (datetime) --
The date which the assessment run was created.
AssessmentProgress (dict) --
The progress values reported by the AssessmentProgress response element.
IndividualAssessmentCount (integer) --
The number of individual assessments that are specified to run.
IndividualAssessmentCompletedCount (integer) --
The number of individual assessments that have completed, successfully or not.
LastFailureMessage (string) --
The last message generated by an individual assessment failure.
ResultLocationBucket (string) --
The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.
ResultLocationFolder (string) --
The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.
ResultEncryptionMode (string) --
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 (string) --
The ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to SSE_KMS.
ResultStatistic (dict) --
The object containing the result statistics for a completed assessment run.
Passed (integer) --
The number of individual assessments that successfully passed all checks in the assessment run.
Failed (integer) --
The number of individual assessments that failed to meet the criteria defined in the assessment run.
Error (integer) --
The number of individual assessments that encountered a critical error and could not complete properly.
Warning (integer) --
Indicates that the recent completed AssessmentRun triggered a warning.
Cancelled (integer) --
The number of individual assessments that were cancelled during the assessment run.
Skipped (integer) --
The number of individual assessments that were skipped during the assessment run.
StopReason (string) --
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_DUE_TO_LOW_DISK"
"Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task
"Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task
"Stop Reason RECONFIGURATION_RESTART"
"Stop Reason RECYCLE_TASK"
FailureMessages (list) --
Error and other information about why a serverless replication failed.
(string) --
ReplicationStats (dict) --
This object provides a collection of statistics about a serverless replication.
FullLoadProgressPercent (integer) --
The percent complete for the full load serverless replication.
ElapsedTimeMillis (integer) --
The elapsed time of the replication, in milliseconds.
TablesLoaded (integer) --
The number of tables loaded for this replication.
TablesLoading (integer) --
The number of tables currently loading for this replication.
TablesQueued (integer) --
The number of tables queued for this replication.
TablesErrored (integer) --
The number of errors that have occured for this replication.
FreshStartDate (datetime) --
The date the replication was started either with a fresh start or a target reload.
StartDate (datetime) --
The date the replication is scheduled to start.
StopDate (datetime) --
The date the replication was stopped.
FullLoadStartDate (datetime) --
The date the replication full load was started.
FullLoadFinishDate (datetime) --
The date the replication full load was finished.
StartReplicationType (string) --
The type of replication to start.
CdcStartTime (datetime) --
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 (string) --
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 (string) --
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
RecoveryCheckpoint (string) --
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 (datetime) --
The time the serverless replication was created.
ReplicationUpdateTime (datetime) --
The time the serverless replication was updated.
ReplicationLastStopTime (datetime) --
The timestamp when replication was last stopped.
ReplicationDeprovisionTime (datetime) --
The timestamp when DMS will deprovision the replication.