amazonaws_dms

@datafire/amazonaws_dms

Client library for AWS Database Migration Service

Installation and Usage

npm install --save @datafire/amazonaws_dms

let amazonaws_dms = require('@datafire/amazonaws_dms').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

AWS Database Migration Service

AWS Database Migration Service (AWS 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.

For more information about AWS DMS, see What Is AWS Database Migration Service? in the AWS Database Migration User Guide.

Actions

AddTagsToResource

amazonaws_dms.AddTagsToResource({
  "ResourceArn": null,
  "Tags": null
}, context)

Input

• input object
  • ResourceArn required
  • Tags required
    • items Tag

Output

• output AddTagsToResourceResponse

ApplyPendingMaintenanceAction

amazonaws_dms.ApplyPendingMaintenanceAction({
  "ReplicationInstanceArn": null,
  "ApplyAction": null,
  "OptInType": null
}, context)

Input

• input object
  • ApplyAction required
  • OptInType required
  • ReplicationInstanceArn required

Output

• output ApplyPendingMaintenanceActionResponse

CancelReplicationTaskAssessmentRun

amazonaws_dms.CancelReplicationTaskAssessmentRun({
  "ReplicationTaskAssessmentRunArn": null
}, context)

Input

• input object
  • ReplicationTaskAssessmentRunArn required

Output

• output CancelReplicationTaskAssessmentRunResponse

CreateEndpoint

amazonaws_dms.CreateEndpoint({
  "EndpointIdentifier": null,
  "EndpointType": null,
  "EngineName": null
}, context)

Input

• input object
  • CertificateArn
  • DatabaseName
  • DmsTransferSettings
    • BucketName
    • ServiceAccessRoleArn
  • DocDbSettings DocDbSettings
  • DynamoDbSettings
    • ServiceAccessRoleArn required
  • ElasticsearchSettings
    • EndpointUri required
    • ErrorRetryDuration
    • FullLoadErrorPercentage
    • ServiceAccessRoleArn required
  • EndpointIdentifier required
  • EndpointType required
  • EngineName required
  • ExternalTableDefinition
  • ExtraConnectionAttributes
  • IBMDb2Settings
    • CurrentLsn
    • DatabaseName
    • MaxKBytesPerRead
    • Password
    • Port
    • ServerName
    • SetDataCaptureChanges
    • Username
  • KafkaSettings
    • Broker
    • IncludeControlDetails
    • IncludeNullAndEmpty
    • IncludePartitionValue
    • IncludeTableAlterOperations
    • IncludeTransactionDetails
    • MessageFormat
    • MessageMaxBytes
    • PartitionIncludeSchemaTable
    • Topic
  • KinesisSettings
    • IncludeControlDetails
    • IncludeNullAndEmpty
    • IncludePartitionValue
    • IncludeTableAlterOperations
    • IncludeTransactionDetails
    • MessageFormat
    • PartitionIncludeSchemaTable
    • ServiceAccessRoleArn
    • StreamArn
  • KmsKeyId
  • MicrosoftSQLServerSettings
    • BcpPacketSize
    • ControlTablesFileGroup
    • DatabaseName
    • Password
    • Port
    • ReadBackupOnly
    • SafeguardPolicy
    • ServerName
    • UseBcpFullLoad
    • Username
  • MongoDbSettings
    • AuthMechanism
    • AuthSource
    • AuthType
    • DatabaseName
    • DocsToInvestigate
    • ExtractDocId
    • KmsKeyId
    • NestingLevel
    • Password
    • Port
    • ServerName
    • Username
  • MySQLSettings
    • AfterConnectScript
    • DatabaseName
    • EventsPollInterval
    • MaxFileSize
    • ParallelLoadThreads
    • Password
    • Port
    • ServerName
    • ServerTimezone
    • TargetDbType
    • Username
  • NeptuneSettings
    • ErrorRetryDuration
    • IamAuthEnabled
    • MaxFileSize
    • MaxRetryCount
    • S3BucketFolder required
    • S3BucketName required
    • ServiceAccessRoleArn
  • OracleSettings
    • AccessAlternateDirectly
    • AddSupplementalLogging
    • AdditionalArchivedLogDestId
    • AllowSelectNestedTables
    • ArchivedLogDestId
    • ArchivedLogsOnly
    • AsmPassword
    • AsmServer
    • AsmUser
    • CharLengthSemantics
    • DatabaseName
    • DirectPathNoLog
    • DirectPathParallelLoad
    • EnableHomogenousTablespace
    • FailTasksOnLobTruncation
    • NumberDatatypeScale
    • OraclePathPrefix
    • ParallelAsmReadThreads
    • Password
    • Port
    • ReadAheadBlocks
    • ReadTableSpaceName
    • ReplacePathPrefix
    • RetryInterval
    • SecurityDbEncryption
    • SecurityDbEncryptionName
    • ServerName
    • UseAlternateFolderForOnline
    • UsePathPrefix
    • Username
  • Password
  • Port
  • PostgreSQLSettings
    • AfterConnectScript
    • CaptureDdls
    • DatabaseName
    • DdlArtifactsSchema
    • ExecuteTimeout
    • FailTasksOnLobTruncation
    • MaxFileSize
    • Password
    • Port
    • ServerName
    • SlotName
    • Username
  • RedshiftSettings RedshiftSettings
  • ResourceIdentifier
  • S3Settings
    • BucketFolder
    • BucketName
    • CdcInsertsAndUpdates
    • CdcInsertsOnly
    • CdcPath
    • CompressionType
    • CsvDelimiter
    • CsvNoSupValue
    • CsvRowDelimiter
    • DataFormat
    • DataPageSize
    • DatePartitionDelimiter
    • DatePartitionEnabled
    • DatePartitionSequence
    • DictPageSizeLimit
    • EnableStatistics
    • EncodingType
    • EncryptionMode
    • ExternalTableDefinition
    • IncludeOpForFullLoad
    • ParquetTimestampInMillisecond
    • ParquetVersion
    • PreserveTransactions
    • RowGroupLength
    • ServerSideEncryptionKmsKeyId
    • ServiceAccessRoleArn
    • TimestampColumnName
    • UseCsvNoSupValue
  • ServerName
  • ServiceAccessRoleArn
  • SslMode
  • SybaseSettings
    • DatabaseName
    • Password
    • Port
    • ServerName
    • Username
  • Tags
    • items Tag
  • Username

Output

• output CreateEndpointResponse

CreateEventSubscription

amazonaws_dms.CreateEventSubscription({
  "SubscriptionName": null,
  "SnsTopicArn": null
}, context)

Input

• input object
  • Enabled
  • EventCategories
    • items String
  • SnsTopicArn required
  • SourceIds
    • items String
  • SourceType
  • SubscriptionName required
  • Tags
    • items Tag

Output

• output CreateEventSubscriptionResponse

CreateReplicationInstance

amazonaws_dms.CreateReplicationInstance({
  "ReplicationInstanceIdentifier": null,
  "ReplicationInstanceClass": null
}, context)

Input

• input object
  • AllocatedStorage
  • AutoMinorVersionUpgrade
  • AvailabilityZone
  • DnsNameServers
  • EngineVersion
  • KmsKeyId
  • MultiAZ
  • PreferredMaintenanceWindow
  • PubliclyAccessible
  • ReplicationInstanceClass required
  • ReplicationInstanceIdentifier required
  • ReplicationSubnetGroupIdentifier
  • ResourceIdentifier
  • Tags
    • items Tag
  • VpcSecurityGroupIds
    • items String

Output

• output CreateReplicationInstanceResponse

CreateReplicationSubnetGroup

amazonaws_dms.CreateReplicationSubnetGroup({
  "ReplicationSubnetGroupIdentifier": null,
  "ReplicationSubnetGroupDescription": null,
  "SubnetIds": null
}, context)

Input

• input object
  • ReplicationSubnetGroupDescription required
  • ReplicationSubnetGroupIdentifier required
  • SubnetIds required
    • items String
  • Tags
    • items Tag

Output

• output CreateReplicationSubnetGroupResponse

CreateReplicationTask

amazonaws_dms.CreateReplicationTask({
  "ReplicationTaskIdentifier": null,
  "SourceEndpointArn": null,
  "TargetEndpointArn": null,
  "ReplicationInstanceArn": null,
  "MigrationType": null,
  "TableMappings": null
}, context)

Input

• input object
  • CdcStartPosition
  • CdcStartTime
  • CdcStopPosition
  • MigrationType required
  • ReplicationInstanceArn required
  • ReplicationTaskIdentifier required
  • ReplicationTaskSettings
  • ResourceIdentifier
  • SourceEndpointArn required
  • TableMappings required
  • Tags
    • items Tag
  • TargetEndpointArn required
  • TaskData

Output

• output CreateReplicationTaskResponse

DeleteCertificate

amazonaws_dms.DeleteCertificate({
  "CertificateArn": null
}, context)

Input

• input object
  • CertificateArn required

Output

• output DeleteCertificateResponse

DeleteConnection

amazonaws_dms.DeleteConnection({
  "EndpointArn": null,
  "ReplicationInstanceArn": null
}, context)

Input

• input object
  • EndpointArn required
  • ReplicationInstanceArn required

Output

• output DeleteConnectionResponse

DeleteEndpoint

amazonaws_dms.DeleteEndpoint({
  "EndpointArn": null
}, context)

Input

• input object
  • EndpointArn required

Output

• output DeleteEndpointResponse

DeleteEventSubscription

amazonaws_dms.DeleteEventSubscription({
  "SubscriptionName": null
}, context)

Input

• input object
  • SubscriptionName required

Output

• output DeleteEventSubscriptionResponse

DeleteReplicationInstance

amazonaws_dms.DeleteReplicationInstance({
  "ReplicationInstanceArn": null
}, context)

Input

• input object
  • ReplicationInstanceArn required

Output

• output DeleteReplicationInstanceResponse

DeleteReplicationSubnetGroup

amazonaws_dms.DeleteReplicationSubnetGroup({
  "ReplicationSubnetGroupIdentifier": null
}, context)

Input

• input object
  • ReplicationSubnetGroupIdentifier required

Output

• output DeleteReplicationSubnetGroupResponse

DeleteReplicationTask

amazonaws_dms.DeleteReplicationTask({
  "ReplicationTaskArn": null
}, context)

Input

• input object
  • ReplicationTaskArn required

Output

• output DeleteReplicationTaskResponse

DeleteReplicationTaskAssessmentRun

amazonaws_dms.DeleteReplicationTaskAssessmentRun({
  "ReplicationTaskAssessmentRunArn": null
}, context)

Input

• input object
  • ReplicationTaskAssessmentRunArn required

Output

• output DeleteReplicationTaskAssessmentRunResponse

DescribeAccountAttributes

amazonaws_dms.DescribeAccountAttributes({}, context)

Input

• input object

Output

• output DescribeAccountAttributesResponse

DescribeApplicableIndividualAssessments

amazonaws_dms.DescribeApplicableIndividualAssessments({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Marker
  • MaxRecords
  • MigrationType
  • ReplicationInstanceArn
  • ReplicationTaskArn
  • SourceEngineName
  • TargetEngineName

Output

• output DescribeApplicableIndividualAssessmentsResponse

DescribeCertificates

amazonaws_dms.DescribeCertificates({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords

Output

• output DescribeCertificatesResponse

DescribeConnections

amazonaws_dms.DescribeConnections({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords

Output

• output DescribeConnectionsResponse

DescribeEndpointTypes

amazonaws_dms.DescribeEndpointTypes({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords

Output

• output DescribeEndpointTypesResponse

DescribeEndpoints

amazonaws_dms.DescribeEndpoints({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords

Output

• output DescribeEndpointsResponse

DescribeEventCategories

amazonaws_dms.DescribeEventCategories({}, context)

Input

• input object
  • Filters
    • items Filter
  • SourceType

Output

• output DescribeEventCategoriesResponse

DescribeEventSubscriptions

amazonaws_dms.DescribeEventSubscriptions({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords
  • SubscriptionName

Output

• output DescribeEventSubscriptionsResponse

DescribeEvents

amazonaws_dms.DescribeEvents({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Duration
  • EndTime
  • EventCategories
    • items String
  • Filters
    • items Filter
  • Marker
  • MaxRecords
  • SourceIdentifier
  • SourceType
  • StartTime

Output

• output DescribeEventsResponse

DescribeOrderableReplicationInstances

amazonaws_dms.DescribeOrderableReplicationInstances({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Marker
  • MaxRecords

Output

• output DescribeOrderableReplicationInstancesResponse

DescribePendingMaintenanceActions

amazonaws_dms.DescribePendingMaintenanceActions({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords
  • ReplicationInstanceArn

Output

• output DescribePendingMaintenanceActionsResponse

DescribeRefreshSchemasStatus

amazonaws_dms.DescribeRefreshSchemasStatus({
  "EndpointArn": null
}, context)

Input

• input object
  • EndpointArn required

Output

• output DescribeRefreshSchemasStatusResponse

DescribeReplicationInstanceTaskLogs

amazonaws_dms.DescribeReplicationInstanceTaskLogs({
  "ReplicationInstanceArn": null
}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Marker
  • MaxRecords
  • ReplicationInstanceArn required

Output

• output DescribeReplicationInstanceTaskLogsResponse

DescribeReplicationInstances

amazonaws_dms.DescribeReplicationInstances({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords

Output

• output DescribeReplicationInstancesResponse

DescribeReplicationSubnetGroups

amazonaws_dms.DescribeReplicationSubnetGroups({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords

Output

• output DescribeReplicationSubnetGroupsResponse

DescribeReplicationTaskAssessmentResults

amazonaws_dms.DescribeReplicationTaskAssessmentResults({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Marker
  • MaxRecords
  • ReplicationTaskArn

Output

• output DescribeReplicationTaskAssessmentResultsResponse

DescribeReplicationTaskAssessmentRuns

amazonaws_dms.DescribeReplicationTaskAssessmentRuns({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords

Output

• output DescribeReplicationTaskAssessmentRunsResponse

DescribeReplicationTaskIndividualAssessments

amazonaws_dms.DescribeReplicationTaskIndividualAssessments({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords

Output

• output DescribeReplicationTaskIndividualAssessmentsResponse

DescribeReplicationTasks

amazonaws_dms.DescribeReplicationTasks({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords
  • WithoutSettings

Output

• output DescribeReplicationTasksResponse

DescribeSchemas

amazonaws_dms.DescribeSchemas({
  "EndpointArn": null
}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • EndpointArn required
  • Marker
  • MaxRecords

Output

• output DescribeSchemasResponse

DescribeTableStatistics

amazonaws_dms.DescribeTableStatistics({
  "ReplicationTaskArn": null
}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters
    • items Filter
  • Marker
  • MaxRecords
  • ReplicationTaskArn required

Output

• output DescribeTableStatisticsResponse

ImportCertificate

amazonaws_dms.ImportCertificate({
  "CertificateIdentifier": null
}, context)

Input

• input object
  • CertificateIdentifier required
  • CertificatePem
  • CertificateWallet
  • Tags
    • items Tag

Output

• output ImportCertificateResponse

ListTagsForResource

amazonaws_dms.ListTagsForResource({
  "ResourceArn": null
}, context)

Input

• input object
  • ResourceArn required

Output

• output ListTagsForResourceResponse

ModifyEndpoint

amazonaws_dms.ModifyEndpoint({
  "EndpointArn": null
}, context)

Input

• input object
  • CertificateArn
  • DatabaseName
  • DmsTransferSettings
    • BucketName
    • ServiceAccessRoleArn
  • DocDbSettings
    • DatabaseName
    • DocsToInvestigate
    • ExtractDocId
    • KmsKeyId
    • NestingLevel
    • Password
    • Port
    • ServerName
    • Username
  • DynamoDbSettings
    • ServiceAccessRoleArn required
  • ElasticsearchSettings
    • EndpointUri required
    • ErrorRetryDuration
    • FullLoadErrorPercentage
    • ServiceAccessRoleArn required
  • EndpointArn required
  • EndpointIdentifier
  • EndpointType
  • EngineName
  • ExternalTableDefinition
  • ExtraConnectionAttributes
  • IBMDb2Settings
    • CurrentLsn
    • DatabaseName
    • MaxKBytesPerRead
    • Password
    • Port
    • ServerName
    • SetDataCaptureChanges
    • Username
  • KafkaSettings
    • Broker
    • IncludeControlDetails
    • IncludeNullAndEmpty
    • IncludePartitionValue
    • IncludeTableAlterOperations
    • IncludeTransactionDetails
    • MessageFormat
    • MessageMaxBytes
    • PartitionIncludeSchemaTable
    • Topic
  • KinesisSettings
    • IncludeControlDetails
    • IncludeNullAndEmpty
    • IncludePartitionValue
    • IncludeTableAlterOperations
    • IncludeTransactionDetails
    • MessageFormat
    • PartitionIncludeSchemaTable
    • ServiceAccessRoleArn
    • StreamArn
  • MicrosoftSQLServerSettings
    • BcpPacketSize
    • ControlTablesFileGroup
    • DatabaseName
    • Password
    • Port
    • ReadBackupOnly
    • SafeguardPolicy
    • ServerName
    • UseBcpFullLoad
    • Username
  • MongoDbSettings
    • AuthMechanism
    • AuthSource
    • AuthType
    • DatabaseName
    • DocsToInvestigate
    • ExtractDocId
    • KmsKeyId
    • NestingLevel
    • Password
    • Port
    • ServerName
    • Username
  • MySQLSettings
    • AfterConnectScript
    • DatabaseName
    • EventsPollInterval
    • MaxFileSize
    • ParallelLoadThreads
    • Password
    • Port
    • ServerName
    • ServerTimezone
    • TargetDbType
    • Username
  • NeptuneSettings
    • ErrorRetryDuration
    • IamAuthEnabled
    • MaxFileSize
    • MaxRetryCount
    • S3BucketFolder required
    • S3BucketName required
    • ServiceAccessRoleArn
  • OracleSettings
    • AccessAlternateDirectly
    • AddSupplementalLogging
    • AdditionalArchivedLogDestId
    • AllowSelectNestedTables
    • ArchivedLogDestId
    • ArchivedLogsOnly
    • AsmPassword
    • AsmServer
    • AsmUser
    • CharLengthSemantics
    • DatabaseName
    • DirectPathNoLog
    • DirectPathParallelLoad
    • EnableHomogenousTablespace
    • FailTasksOnLobTruncation
    • NumberDatatypeScale
    • OraclePathPrefix
    • ParallelAsmReadThreads
    • Password
    • Port
    • ReadAheadBlocks
    • ReadTableSpaceName
    • ReplacePathPrefix
    • RetryInterval
    • SecurityDbEncryption
    • SecurityDbEncryptionName
    • ServerName
    • UseAlternateFolderForOnline
    • UsePathPrefix
    • Username
  • Password
  • Port
  • PostgreSQLSettings
    • AfterConnectScript
    • CaptureDdls
    • DatabaseName
    • DdlArtifactsSchema
    • ExecuteTimeout
    • FailTasksOnLobTruncation
    • MaxFileSize
    • Password
    • Port
    • ServerName
    • SlotName
    • Username
  • RedshiftSettings RedshiftSettings
  • S3Settings
    • BucketFolder
    • BucketName
    • CdcInsertsAndUpdates
    • CdcInsertsOnly
    • CdcPath
    • CompressionType
    • CsvDelimiter
    • CsvNoSupValue
    • CsvRowDelimiter
    • DataFormat
    • DataPageSize
    • DatePartitionDelimiter
    • DatePartitionEnabled
    • DatePartitionSequence
    • DictPageSizeLimit
    • EnableStatistics
    • EncodingType
    • EncryptionMode
    • ExternalTableDefinition
    • IncludeOpForFullLoad
    • ParquetTimestampInMillisecond
    • ParquetVersion
    • PreserveTransactions
    • RowGroupLength
    • ServerSideEncryptionKmsKeyId
    • ServiceAccessRoleArn
    • TimestampColumnName
    • UseCsvNoSupValue
  • ServerName
  • ServiceAccessRoleArn
  • SslMode
  • SybaseSettings
    • DatabaseName
    • Password
    • Port
    • ServerName
    • Username
  • Username

Output

• output ModifyEndpointResponse

ModifyEventSubscription

amazonaws_dms.ModifyEventSubscription({
  "SubscriptionName": null
}, context)

Input

• input object
  • Enabled
  • EventCategories
    • items String
  • SnsTopicArn
  • SourceType
  • SubscriptionName required

Output

• output ModifyEventSubscriptionResponse

ModifyReplicationInstance

amazonaws_dms.ModifyReplicationInstance({
  "ReplicationInstanceArn": null
}, context)

Input

• input object
  • AllocatedStorage
  • AllowMajorVersionUpgrade
  • ApplyImmediately
  • AutoMinorVersionUpgrade
  • EngineVersion
  • MultiAZ
  • PreferredMaintenanceWindow
  • ReplicationInstanceArn required
  • ReplicationInstanceClass
  • ReplicationInstanceIdentifier
  • VpcSecurityGroupIds
    • items String

Output

• output ModifyReplicationInstanceResponse

ModifyReplicationSubnetGroup

amazonaws_dms.ModifyReplicationSubnetGroup({
  "ReplicationSubnetGroupIdentifier": null,
  "SubnetIds": null
}, context)

Input

• input object
  • ReplicationSubnetGroupDescription
  • ReplicationSubnetGroupIdentifier required
  • SubnetIds required
    • items String

Output

• output ModifyReplicationSubnetGroupResponse

ModifyReplicationTask

amazonaws_dms.ModifyReplicationTask({
  "ReplicationTaskArn": null
}, context)

Input

• input object
  • CdcStartPosition
  • CdcStartTime
  • CdcStopPosition
  • MigrationType
  • ReplicationTaskArn required
  • ReplicationTaskIdentifier
  • ReplicationTaskSettings
  • TableMappings
  • TaskData

Output

• output ModifyReplicationTaskResponse

MoveReplicationTask

amazonaws_dms.MoveReplicationTask({
  "ReplicationTaskArn": null,
  "TargetReplicationInstanceArn": null
}, context)

Input

• input object
  • ReplicationTaskArn required
  • TargetReplicationInstanceArn required

Output

• output MoveReplicationTaskResponse

RebootReplicationInstance

amazonaws_dms.RebootReplicationInstance({
  "ReplicationInstanceArn": null
}, context)

Input

• input object
  • ForceFailover
  • ReplicationInstanceArn required

Output

• output RebootReplicationInstanceResponse

RefreshSchemas

amazonaws_dms.RefreshSchemas({
  "EndpointArn": null,
  "ReplicationInstanceArn": null
}, context)

Input

• input object
  • EndpointArn required
  • ReplicationInstanceArn required

Output

• output RefreshSchemasResponse

ReloadTables

amazonaws_dms.ReloadTables({
  "ReplicationTaskArn": null,
  "TablesToReload": null
}, context)

Input

• input object
  • ReloadOption
  • ReplicationTaskArn required
  • TablesToReload required
    • items TableToReload

Output

• output ReloadTablesResponse

RemoveTagsFromResource

amazonaws_dms.RemoveTagsFromResource({
  "ResourceArn": null,
  "TagKeys": null
}, context)

Input

• input object
  • ResourceArn required
  • TagKeys required
    • items String

Output

• output RemoveTagsFromResourceResponse

StartReplicationTask

amazonaws_dms.StartReplicationTask({
  "ReplicationTaskArn": null,
  "StartReplicationTaskType": null
}, context)

Input

• input object
  • CdcStartPosition
  • CdcStartTime
  • CdcStopPosition
  • ReplicationTaskArn required
  • StartReplicationTaskType required

Output

• output StartReplicationTaskResponse

StartReplicationTaskAssessment

amazonaws_dms.StartReplicationTaskAssessment({
  "ReplicationTaskArn": null
}, context)

Input

• input object
  • ReplicationTaskArn required

Output

• output StartReplicationTaskAssessmentResponse

StartReplicationTaskAssessmentRun

amazonaws_dms.StartReplicationTaskAssessmentRun({
  "ReplicationTaskArn": null,
  "ServiceAccessRoleArn": null,
  "ResultLocationBucket": null,
  "AssessmentRunName": null
}, context)

Input

• input object
  • AssessmentRunName required
  • Exclude
    • items String
  • IncludeOnly
    • items String
  • ReplicationTaskArn required
  • ResultEncryptionMode
  • ResultKmsKeyArn
  • ResultLocationBucket required
  • ResultLocationFolder
  • ServiceAccessRoleArn required

Output

• output StartReplicationTaskAssessmentRunResponse

StopReplicationTask

amazonaws_dms.StopReplicationTask({
  "ReplicationTaskArn": null
}, context)

Input

• input object
  • ReplicationTaskArn required

Output

• output StopReplicationTaskResponse

TestConnection

amazonaws_dms.TestConnection({
  "ReplicationInstanceArn": null,
  "EndpointArn": null
}, context)

Input

• input object
  • EndpointArn required
  • ReplicationInstanceArn required

Output

• output TestConnectionResponse

Definitions

AccessDeniedFault

AccountQuota

• AccountQuota object: Describes a quota for an AWS account, for example, the number of replication instances allowed.
  • AccountQuotaName
  • Max
  • Used

AccountQuotaList

• AccountQuotaList array
  • items AccountQuota

AddTagsToResourceMessage

• AddTagsToResourceMessage object: Associates a set of tags with an AWS DMS resource.
  • ResourceArn required
  • Tags required
    • items Tag

AddTagsToResourceResponse

• AddTagsToResourceResponse object:

ApplyPendingMaintenanceActionMessage

• ApplyPendingMaintenanceActionMessage object:
  • ApplyAction required
  • OptInType required
  • ReplicationInstanceArn required

ApplyPendingMaintenanceActionResponse

• ApplyPendingMaintenanceActionResponse object:
  • ResourcePendingMaintenanceActions
    • PendingMaintenanceActionDetails
      • items PendingMaintenanceAction
    • ResourceIdentifier

AuthMechanismValue

• AuthMechanismValue string (values: default, mongodb_cr, scram_sha_1)

AuthTypeValue

• AuthTypeValue string (values: no, password)

AvailabilityZone

• AvailabilityZone object: The name of an Availability Zone for use during database migration. AvailabilityZone is an optional parameter to the CreateReplicationInstance operation, and it’s value relates to the AWS Region of an endpoint. For example, the availability zone of an endpoint in the us-east-1 region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d.
  • Name

AvailabilityZonesList

• AvailabilityZonesList array
  • items String

Boolean

• Boolean boolean

BooleanOptional

• BooleanOptional boolean

CancelReplicationTaskAssessmentRunMessage

• CancelReplicationTaskAssessmentRunMessage object:
  • ReplicationTaskAssessmentRunArn required

CancelReplicationTaskAssessmentRunResponse

• CancelReplicationTaskAssessmentRunResponse object:
  • ReplicationTaskAssessmentRun
    • AssessmentProgress
      • IndividualAssessmentCompletedCount
      • IndividualAssessmentCount
    • AssessmentRunName
    • LastFailureMessage
    • ReplicationTaskArn
    • ReplicationTaskAssessmentRunArn
    • ReplicationTaskAssessmentRunCreationDate
    • ResultEncryptionMode
    • ResultKmsKeyArn
    • ResultLocationBucket
    • ResultLocationFolder
    • ServiceAccessRoleArn
    • Status

Certificate

• Certificate object: The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.
  • CertificateArn
  • CertificateCreationDate
  • CertificateIdentifier
  • CertificateOwner
  • CertificatePem
  • CertificateWallet
  • KeyLength
  • SigningAlgorithm
  • ValidFromDate
  • ValidToDate

CertificateList

• CertificateList array
  • items Certificate

CertificateWallet

• CertificateWallet string

CharLengthSemantics

• CharLengthSemantics string (values: default, char, byte)

CompressionTypeValue

• CompressionTypeValue string (values: none, gzip)

Connection

• Connection object: Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.
  • EndpointArn
  • EndpointIdentifier
  • LastFailureMessage
  • ReplicationInstanceArn
  • ReplicationInstanceIdentifier
  • Status

ConnectionList

• ConnectionList array
  • items Connection

CreateEndpointMessage

• CreateEndpointMessage object:
  • CertificateArn
  • DatabaseName
  • DmsTransferSettings
    • BucketName
    • ServiceAccessRoleArn
  • DocDbSettings DocDbSettings
  • DynamoDbSettings
    • ServiceAccessRoleArn required
  • ElasticsearchSettings
    • EndpointUri required
    • ErrorRetryDuration
    • FullLoadErrorPercentage
    • ServiceAccessRoleArn required
  • EndpointIdentifier required
  • EndpointType required
  • EngineName required
  • ExternalTableDefinition
  • ExtraConnectionAttributes
  • IBMDb2Settings
    • CurrentLsn
    • DatabaseName
    • MaxKBytesPerRead
    • Password
    • Port
    • ServerName
    • SetDataCaptureChanges
    • Username
  • KafkaSettings
    • Broker
    • IncludeControlDetails
    • IncludeNullAndEmpty
    • IncludePartitionValue
    • IncludeTableAlterOperations
    • IncludeTransactionDetails
    • MessageFormat
    • MessageMaxBytes
    • PartitionIncludeSchemaTable
    • Topic
  • KinesisSettings
    • IncludeControlDetails
    • IncludeNullAndEmpty
    • IncludePartitionValue
    • IncludeTableAlterOperations
    • IncludeTransactionDetails
    • MessageFormat
    • PartitionIncludeSchemaTable
    • ServiceAccessRoleArn
    • StreamArn
  • KmsKeyId
  • MicrosoftSQLServerSettings
    • BcpPacketSize
    • ControlTablesFileGroup
    • DatabaseName
    • Password
    • Port
    • ReadBackupOnly
    • SafeguardPolicy
    • ServerName
    • UseBcpFullLoad
    • Username
  • MongoDbSettings
    • AuthMechanism
    • AuthSource
    • AuthType
    • DatabaseName
    • DocsToInvestigate
    • ExtractDocId
    • KmsKeyId
    • NestingLevel
    • Password
    • Port
    • ServerName
    • Username
  • MySQLSettings
    • AfterConnectScript
    • DatabaseName
    • EventsPollInterval
    • MaxFileSize
    • ParallelLoadThreads
    • Password
    • Port
    • ServerName
    • ServerTimezone
    • TargetDbType
    • Username
  • NeptuneSettings
    • ErrorRetryDuration
    • IamAuthEnabled
    • MaxFileSize
    • MaxRetryCount
    • S3BucketFolder required
    • S3BucketName required
    • ServiceAccessRoleArn
  • OracleSettings
    • AccessAlternateDirectly
    • AddSupplementalLogging
    • AdditionalArchivedLogDestId
    • AllowSelectNestedTables
    • ArchivedLogDestId
    • ArchivedLogsOnly
    • AsmPassword
    • AsmServer
    • AsmUser
    • CharLengthSemantics
    • DatabaseName
    • DirectPathNoLog
    • DirectPathParallelLoad
    • EnableHomogenousTablespace
    • FailTasksOnLobTruncation
    • NumberDatatypeScale
    • OraclePathPrefix
    • ParallelAsmReadThreads
    • Password
    • Port
    • ReadAheadBlocks
    • ReadTableSpaceName
    • ReplacePathPrefix
    • RetryInterval
    • SecurityDbEncryption
    • SecurityDbEncryptionName
    • ServerName
    • UseAlternateFolderForOnline
    • UsePathPrefix
    • Username
  • Password
  • Port
  • PostgreSQLSettings
    • AfterConnectScript
    • CaptureDdls
    • DatabaseName
    • DdlArtifactsSchema
    • ExecuteTimeout
    • FailTasksOnLobTruncation
    • MaxFileSize
    • Password
    • Port
    • ServerName
    • SlotName
    • Username
  • RedshiftSettings RedshiftSettings
  • ResourceIdentifier
  • S3Settings
    • BucketFolder
    • BucketName
    • CdcInsertsAndUpdates
    • CdcInsertsOnly
    • CdcPath
    • CompressionType
    • CsvDelimiter
    • CsvNoSupValue
    • CsvRowDelimiter
    • DataFormat
    • DataPageSize
    • DatePartitionDelimiter
    • DatePartitionEnabled
    • DatePartitionSequence
    • DictPageSizeLimit
    • EnableStatistics
    • EncodingType
    • EncryptionMode
    • ExternalTableDefinition
    • IncludeOpForFullLoad
    • ParquetTimestampInMillisecond
    • ParquetVersion
    • PreserveTransactions
    • RowGroupLength
    • ServerSideEncryptionKmsKeyId
    • ServiceAccessRoleArn
    • TimestampColumnName
    • UseCsvNoSupValue
  • ServerName
  • ServiceAccessRoleArn
  • SslMode
  • SybaseSettings
    • DatabaseName
    • Password
    • Port
    • ServerName
    • Username
  • Tags
    • items Tag
  • Username

CreateEndpointResponse

• CreateEndpointResponse object:
  • Endpoint
    • CertificateArn
    • DatabaseName
    • DmsTransferSettings
      • BucketName
      • ServiceAccessRoleArn
    • DocDbSettings DocDbSettings
    • DynamoDbSettings
      • ServiceAccessRoleArn required
    • ElasticsearchSettings
      • EndpointUri required
      • ErrorRetryDuration
      • FullLoadErrorPercentage
      • ServiceAccessRoleArn required
    • EndpointArn
    • EndpointIdentifier
    • EndpointType
    • EngineDisplayName
    • EngineName
    • ExternalId
    • ExternalTableDefinition
    • ExtraConnectionAttributes
    • IBMDb2Settings
      • CurrentLsn
      • DatabaseName
      • MaxKBytesPerRead
      • Password
      • Port
      • ServerName
      • SetDataCaptureChanges
      • Username
    • KafkaSettings
      • Broker
      • IncludeControlDetails
      • IncludeNullAndEmpty
      • IncludePartitionValue
      • IncludeTableAlterOperations
      • IncludeTransactionDetails
      • MessageFormat
      • MessageMaxBytes
      • PartitionIncludeSchemaTable
      • Topic
    • KinesisSettings
      • IncludeControlDetails
      • IncludeNullAndEmpty
      • IncludePartitionValue
      • IncludeTableAlterOperations
      • IncludeTransactionDetails
      • MessageFormat
      • PartitionIncludeSchemaTable
      • ServiceAccessRoleArn
      • StreamArn
    • KmsKeyId
    • MicrosoftSQLServerSettings
      • BcpPacketSize
      • ControlTablesFileGroup
      • DatabaseName
      • Password
      • Port
      • ReadBackupOnly
      • SafeguardPolicy
      • ServerName
      • UseBcpFullLoad
      • Username
    • MongoDbSettings
      • AuthMechanism
      • AuthSource
      • AuthType
      • DatabaseName
      • DocsToInvestigate
      • ExtractDocId
      • KmsKeyId
      • NestingLevel
      • Password
      • Port
      • ServerName
      • Username
    • MySQLSettings
      • AfterConnectScript
      • DatabaseName
      • EventsPollInterval
      • MaxFileSize
      • ParallelLoadThreads
      • Password
      • Port
      • ServerName
      • ServerTimezone
      • TargetDbType
      • Username
    • NeptuneSettings
      • ErrorRetryDuration
      • IamAuthEnabled
      • MaxFileSize
      • MaxRetryCount
      • S3BucketFolder required
      • S3BucketName required
      • ServiceAccessRoleArn
    • OracleSettings
      • AccessAlternateDirectly
      • AddSupplementalLogging
      • AdditionalArchivedLogDestId
      • AllowSelectNestedTables
      • ArchivedLogDestId
      • ArchivedLogsOnly
      • AsmPassword
      • AsmServer
      • AsmUser
      • CharLengthSemantics
      • DatabaseName
      • DirectPathNoLog
      • DirectPathParallelLoad
      • EnableHomogenousTablespace
      • FailTasksOnLobTruncation
      • NumberDatatypeScale
      • OraclePathPrefix
      • ParallelAsmReadThreads
      • Password
      • Port
      • ReadAheadBlocks
      • ReadTableSpaceName
      • ReplacePathPrefix
      • RetryInterval
      • SecurityDbEncryption
      • SecurityDbEncryptionName
      • ServerName
      • UseAlternateFolderForOnline
      • UsePathPrefix
      • Username
    • Port
    • PostgreSQLSettings
      • AfterConnectScript
      • CaptureDdls
      • DatabaseName
      • DdlArtifactsSchema
      • ExecuteTimeout
      • FailTasksOnLobTruncation
      • MaxFileSize
      • Password
      • Port
      • ServerName
      • SlotName
      • Username
    • RedshiftSettings
      • AcceptAnyDate
      • AfterConnectScript
      • BucketFolder
      • BucketName
      • CaseSensitiveNames
      • CompUpdate
      • ConnectionTimeout
      • DatabaseName
      • DateFormat
      • EmptyAsNull
      • EncryptionMode
      • ExplicitIds
      • FileTransferUploadStreams
      • LoadTimeout
      • MaxFileSize
      • Password
      • Port
      • RemoveQuotes
      • ReplaceChars
      • ReplaceInvalidChars
      • ServerName
      • ServerSideEncryptionKmsKeyId
      • ServiceAccessRoleArn
      • TimeFormat
      • TrimBlanks
      • TruncateColumns
      • Username
      • WriteBufferSize
    • S3Settings
      • BucketFolder
      • BucketName
      • CdcInsertsAndUpdates
      • CdcInsertsOnly
      • CdcPath
      • CompressionType
      • CsvDelimiter
      • CsvNoSupValue
      • CsvRowDelimiter
      • DataFormat
      • DataPageSize
      • DatePartitionDelimiter
      • DatePartitionEnabled
      • DatePartitionSequence
      • DictPageSizeLimit
      • EnableStatistics
      • EncodingType
      • EncryptionMode
      • ExternalTableDefinition
      • IncludeOpForFullLoad
      • ParquetTimestampInMillisecond
      • ParquetVersion
      • PreserveTransactions
      • RowGroupLength
      • ServerSideEncryptionKmsKeyId
      • ServiceAccessRoleArn
      • TimestampColumnName
      • UseCsvNoSupValue
    • ServerName
    • ServiceAccessRoleArn
    • SslMode
    • Status
    • SybaseSettings
      • DatabaseName
      • Password
      • Port
      • ServerName
      • Username
    • Username

CreateEventSubscriptionMessage

• CreateEventSubscriptionMessage object:
  • Enabled
  • EventCategories
    • items String
  • SnsTopicArn required
  • SourceIds
    • items String
  • SourceType
  • SubscriptionName required
  • Tags
    • items Tag

CreateEventSubscriptionResponse

• CreateEventSubscriptionResponse object:
  • EventSubscription
    • CustSubscriptionId
    • CustomerAwsId
    • Enabled
    • EventCategoriesList
      • items String
    • SnsTopicArn
    • SourceIdsList
      • items String
    • SourceType
    • Status
    • SubscriptionCreationTime

CreateReplicationInstanceMessage

• CreateReplicationInstanceMessage object:
  • AllocatedStorage
  • AutoMinorVersionUpgrade
  • AvailabilityZone
  • DnsNameServers
  • EngineVersion
  • KmsKeyId
  • MultiAZ
  • PreferredMaintenanceWindow
  • PubliclyAccessible
  • ReplicationInstanceClass required
  • ReplicationInstanceIdentifier required
  • ReplicationSubnetGroupIdentifier
  • ResourceIdentifier
  • Tags
    • items Tag
  • VpcSecurityGroupIds
    • items String

CreateReplicationInstanceResponse

• CreateReplicationInstanceResponse object:
  • ReplicationInstance
    • AllocatedStorage
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • DnsNameServers
    • EngineVersion
    • FreeUntil
    • InstanceCreateTime
    • KmsKeyId
    • MultiAZ
    • PendingModifiedValues
      • AllocatedStorage
      • EngineVersion
      • MultiAZ
      • ReplicationInstanceClass
    • PreferredMaintenanceWindow
    • PubliclyAccessible
    • ReplicationInstanceArn
    • ReplicationInstanceClass
    • ReplicationInstanceIdentifier
    • ReplicationInstancePrivateIpAddress
    • ReplicationInstancePrivateIpAddresses
      • items String
    • ReplicationInstancePublicIpAddress
    • ReplicationInstancePublicIpAddresses
      • items String
    • ReplicationInstanceStatus
    • ReplicationSubnetGroup
      • ReplicationSubnetGroupDescription
      • ReplicationSubnetGroupIdentifier
      • SubnetGroupStatus
      • Subnets
        • items Subnet
      • VpcId
    • SecondaryAvailabilityZone
    • VpcSecurityGroups
      • items VpcSecurityGroupMembership

CreateReplicationSubnetGroupMessage

• CreateReplicationSubnetGroupMessage object:
  • ReplicationSubnetGroupDescription required
  • ReplicationSubnetGroupIdentifier required
  • SubnetIds required
    • items String
  • Tags
    • items Tag

CreateReplicationSubnetGroupResponse

• CreateReplicationSubnetGroupResponse object:
  • ReplicationSubnetGroup
    • ReplicationSubnetGroupDescription
    • ReplicationSubnetGroupIdentifier
    • SubnetGroupStatus
    • Subnets
      • items Subnet
    • VpcId

CreateReplicationTaskMessage

• CreateReplicationTaskMessage object:
  • CdcStartPosition
  • CdcStartTime
  • CdcStopPosition
  • MigrationType required
  • ReplicationInstanceArn required
  • ReplicationTaskIdentifier required
  • ReplicationTaskSettings
  • ResourceIdentifier
  • SourceEndpointArn required
  • TableMappings required
  • Tags
    • items Tag
  • TargetEndpointArn required
  • TaskData

CreateReplicationTaskResponse

• CreateReplicationTaskResponse object:
  • ReplicationTask
    • CdcStartPosition
    • CdcStopPosition
    • LastFailureMessage
    • MigrationType
    • RecoveryCheckpoint
    • ReplicationInstanceArn
    • ReplicationTaskArn
    • ReplicationTaskCreationDate
    • ReplicationTaskIdentifier
    • ReplicationTaskSettings
    • ReplicationTaskStartDate
    • ReplicationTaskStats
      • ElapsedTimeMillis
      • FreshStartDate
      • FullLoadFinishDate
      • FullLoadProgressPercent
      • FullLoadStartDate
      • StartDate
      • StopDate
      • TablesErrored
      • TablesLoaded
      • TablesLoading
      • TablesQueued
    • SourceEndpointArn
    • Status
    • StopReason
    • TableMappings
    • TargetEndpointArn
    • TargetReplicationInstanceArn
    • TaskData

DataFormatValue

• DataFormatValue string (values: csv, parquet)

DatePartitionDelimiterValue

• DatePartitionDelimiterValue string (values: SLASH, UNDERSCORE, DASH, NONE)

DatePartitionSequenceValue

• DatePartitionSequenceValue string (values: YYYYMMDD, YYYYMMDDHH, YYYYMM, MMYYYYDD, DDMMYYYY)

DeleteCertificateMessage

• DeleteCertificateMessage object
  • CertificateArn required

DeleteCertificateResponse

• DeleteCertificateResponse object
  • Certificate
    • CertificateArn
    • CertificateCreationDate
    • CertificateIdentifier
    • CertificateOwner
    • CertificatePem
    • CertificateWallet
    • KeyLength
    • SigningAlgorithm
    • ValidFromDate
    • ValidToDate

DeleteConnectionMessage

• DeleteConnectionMessage object:
  • EndpointArn required
  • ReplicationInstanceArn required

DeleteConnectionResponse

• DeleteConnectionResponse object:
  • Connection
    • EndpointArn
    • EndpointIdentifier
    • LastFailureMessage
    • ReplicationInstanceArn
    • ReplicationInstanceIdentifier
    • Status

DeleteEndpointMessage

• DeleteEndpointMessage object:
  • EndpointArn required

DeleteEndpointResponse

• DeleteEndpointResponse object:
  • Endpoint
    • CertificateArn
    • DatabaseName
    • DmsTransferSettings
      • BucketName
      • ServiceAccessRoleArn
    • DocDbSettings DocDbSettings
    • DynamoDbSettings
      • ServiceAccessRoleArn required
    • ElasticsearchSettings
      • EndpointUri required
      • ErrorRetryDuration
      • FullLoadErrorPercentage
      • ServiceAccessRoleArn required
    • EndpointArn
    • EndpointIdentifier
    • EndpointType
    • EngineDisplayName
    • EngineName
    • ExternalId
    • ExternalTableDefinition
    • ExtraConnectionAttributes
    • IBMDb2Settings
      • CurrentLsn
      • DatabaseName
      • MaxKBytesPerRead
      • Password
      • Port
      • ServerName
      • SetDataCaptureChanges
      • Username
    • KafkaSettings
      • Broker
      • IncludeControlDetails
      • IncludeNullAndEmpty
      • IncludePartitionValue
      • IncludeTableAlterOperations
      • IncludeTransactionDetails
      • MessageFormat
      • MessageMaxBytes
      • PartitionIncludeSchemaTable
      • Topic
    • KinesisSettings
      • IncludeControlDetails
      • IncludeNullAndEmpty
      • IncludePartitionValue
      • IncludeTableAlterOperations
      • IncludeTransactionDetails
      • MessageFormat
      • PartitionIncludeSchemaTable
      • ServiceAccessRoleArn
      • StreamArn
    • KmsKeyId
    • MicrosoftSQLServerSettings
      • BcpPacketSize
      • ControlTablesFileGroup
      • DatabaseName
      • Password
      • Port
      • ReadBackupOnly
      • SafeguardPolicy
      • ServerName
      • UseBcpFullLoad
      • Username
    • MongoDbSettings
      • AuthMechanism
      • AuthSource
      • AuthType
      • DatabaseName
      • DocsToInvestigate
      • ExtractDocId
      • KmsKeyId
      • NestingLevel
      • Password
      • Port
      • ServerName
      • Username
    • MySQLSettings
      • AfterConnectScript
      • DatabaseName
      • EventsPollInterval
      • MaxFileSize
      • ParallelLoadThreads
      • Password
      • Port
      • ServerName
      • ServerTimezone
      • TargetDbType
      • Username
    • NeptuneSettings
      • ErrorRetryDuration
      • IamAuthEnabled
      • MaxFileSize
      • MaxRetryCount
      • S3BucketFolder required
      • S3BucketName required
      • ServiceAccessRoleArn
    • OracleSettings
      • AccessAlternateDirectly
      • AddSupplementalLogging
      • AdditionalArchivedLogDestId
      • AllowSelectNestedTables
      • ArchivedLogDestId
      • ArchivedLogsOnly
      • AsmPassword
      • AsmServer
      • AsmUser
      • CharLengthSemantics
      • DatabaseName
      • DirectPathNoLog
      • DirectPathParallelLoad
      • EnableHomogenousTablespace
      • FailTasksOnLobTruncation
      • NumberDatatypeScale
      • OraclePathPrefix
      • ParallelAsmReadThreads
      • Password
      • Port
      • ReadAheadBlocks
      • ReadTableSpaceName
      • ReplacePathPrefix
      • RetryInterval
      • SecurityDbEncryption
      • SecurityDbEncryptionName
      • ServerName
      • UseAlternateFolderForOnline
      • UsePathPrefix
      • Username
    • Port
    • PostgreSQLSettings
      • AfterConnectScript
      • CaptureDdls
      • DatabaseName
      • DdlArtifactsSchema
      • ExecuteTimeout
      • FailTasksOnLobTruncation
      • MaxFileSize
      • Password
      • Port
      • ServerName
      • SlotName
      • Username
    • RedshiftSettings
      • AcceptAnyDate
      • AfterConnectScript
      • BucketFolder
      • BucketName
      • CaseSensitiveNames
      • CompUpdate
      • ConnectionTimeout
      • DatabaseName
      • DateFormat
      • EmptyAsNull
      • EncryptionMode
      • ExplicitIds
      • FileTransferUploadStreams
      • LoadTimeout
      • MaxFileSize
      • Password
      • Port
      • RemoveQuotes
      • ReplaceChars
      • ReplaceInvalidChars
      • ServerName
      • ServerSideEncryptionKmsKeyId
      • ServiceAccessRoleArn
      • TimeFormat
      • TrimBlanks
      • TruncateColumns
      • Username
      • WriteBufferSize
    • S3Settings
      • BucketFolder
      • BucketName
      • CdcInsertsAndUpdates
      • CdcInsertsOnly
      • CdcPath
      • CompressionType
      • CsvDelimiter
      • CsvNoSupValue
      • CsvRowDelimiter
      • DataFormat
      • DataPageSize
      • DatePartitionDelimiter
      • DatePartitionEnabled
      • DatePartitionSequence
      • DictPageSizeLimit
      • EnableStatistics
      • EncodingType
      • EncryptionMode
      • ExternalTableDefinition
      • IncludeOpForFullLoad
      • ParquetTimestampInMillisecond
      • ParquetVersion
      • PreserveTransactions
      • RowGroupLength
      • ServerSideEncryptionKmsKeyId
      • ServiceAccessRoleArn
      • TimestampColumnName
      • UseCsvNoSupValue
    • ServerName
    • ServiceAccessRoleArn
    • SslMode
    • Status
    • SybaseSettings
      • DatabaseName
      • Password
      • Port
      • ServerName
      • Username
    • Username

DeleteEventSubscriptionMessage

• DeleteEventSubscriptionMessage object:
  • SubscriptionName required

DeleteEventSubscriptionResponse

• DeleteEventSubscriptionResponse object:
  • EventSubscription
    • CustSubscriptionId
    • CustomerAwsId
    • Enabled
    • EventCategoriesList
      • items String
    • SnsTopicArn
    • SourceIdsList
      • items String
    • SourceType
    • Status
    • SubscriptionCreationTime

DeleteReplicationInstanceMessage

• DeleteReplicationInstanceMessage object:
  • ReplicationInstanceArn required

DeleteReplicationInstanceResponse

• DeleteReplicationInstanceResponse object:
  • ReplicationInstance
    • AllocatedStorage
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • DnsNameServers
    • EngineVersion
    • FreeUntil
    • InstanceCreateTime
    • KmsKeyId
    • MultiAZ
    • PendingModifiedValues
      • AllocatedStorage
      • EngineVersion
      • MultiAZ
      • ReplicationInstanceClass
    • PreferredMaintenanceWindow
    • PubliclyAccessible
    • ReplicationInstanceArn
    • ReplicationInstanceClass
    • ReplicationInstanceIdentifier
    • ReplicationInstancePrivateIpAddress
    • ReplicationInstancePrivateIpAddresses
      • items String
    • ReplicationInstancePublicIpAddress
    • ReplicationInstancePublicIpAddresses
      • items String
    • ReplicationInstanceStatus
    • ReplicationSubnetGroup
      • ReplicationSubnetGroupDescription
      • ReplicationSubnetGroupIdentifier
      • SubnetGroupStatus
      • Subnets
        • items Subnet
      • VpcId
    • SecondaryAvailabilityZone
    • VpcSecurityGroups
      • items VpcSecurityGroupMembership

DeleteReplicationSubnetGroupMessage

• DeleteReplicationSubnetGroupMessage object:
  • ReplicationSubnetGroupIdentifier required

DeleteReplicationSubnetGroupResponse

• DeleteReplicationSubnetGroupResponse object:

DeleteReplicationTaskAssessmentRunMessage

• DeleteReplicationTaskAssessmentRunMessage object:
  • ReplicationTaskAssessmentRunArn required

DeleteReplicationTaskAssessmentRunResponse

• DeleteReplicationTaskAssessmentRunResponse object:
  • ReplicationTaskAssessmentRun
    • AssessmentProgress
      • IndividualAssessmentCompletedCount
      • IndividualAssessmentCount
    • AssessmentRunName
    • LastFailureMessage
    • ReplicationTaskArn
    • ReplicationTaskAssessmentRunArn
    • ReplicationTaskAssessmentRunCreationDate
    • ResultEncryptionMode
    • ResultKmsKeyArn
    • ResultLocationBucket
    • ResultLocationFolder
    • ServiceAccessRoleArn
    • Status

DeleteReplicationTaskMessage

• DeleteReplicationTaskMessage object:
  • ReplicationTaskArn required

DeleteReplicationTaskResponse

• DeleteReplicationTaskResponse object:
  • ReplicationTask
    • CdcStartPosition
    • CdcStopPosition
    • LastFailureMessage
    • MigrationType
    • RecoveryCheckpoint
    • ReplicationInstanceArn
    • ReplicationTaskArn
    • ReplicationTaskCreationDate
    • ReplicationTaskIdentifier
    • ReplicationTaskSettings
    • ReplicationTaskStartDate
    • ReplicationTaskStats
      • ElapsedTimeMillis
      • FreshStartDate
      • FullLoadFinishDate
      • FullLoadProgressPercent
      • FullLoadStartDate
      • StartDate
      • StopDate
      • TablesErrored
      • TablesLoaded
      • TablesLoading
      • TablesQueued
    • SourceEndpointArn
    • Status
    • StopReason
    • TableMappings
    • TargetEndpointArn
    • TargetReplicationInstanceArn
    • TaskData

DescribeAccountAttributesMessage

• DescribeAccountAttributesMessage object:

DescribeAccountAttributesResponse

• DescribeAccountAttributesResponse object:
  • AccountQuotas
    • items AccountQuota
  • UniqueAccountIdentifier

DescribeApplicableIndividualAssessmentsMessage

• DescribeApplicableIndividualAssessmentsMessage object:
  • Marker
  • MaxRecords
  • MigrationType
  • ReplicationInstanceArn
  • ReplicationTaskArn
  • SourceEngineName
  • TargetEngineName

DescribeApplicableIndividualAssessmentsResponse

• DescribeApplicableIndividualAssessmentsResponse object:
  • IndividualAssessmentNames
    • items String
  • Marker

DescribeCertificatesMessage

• DescribeCertificatesMessage object
  • Filters
    • items Filter
  • Marker
  • MaxRecords

DescribeCertificatesResponse

• DescribeCertificatesResponse object
  • Certificates
    • items Certificate
  • Marker

DescribeConnectionsMessage

• DescribeConnectionsMessage object:
  • Filters
    • items Filter
  • Marker
  • MaxRecords

DescribeConnectionsResponse

• DescribeConnectionsResponse object:
  • Connections
    • items Connection
  • Marker

DescribeEndpointTypesMessage

• DescribeEndpointTypesMessage object:
  • Filters
    • items Filter
  • Marker
  • MaxRecords

DescribeEndpointTypesResponse

• DescribeEndpointTypesResponse object:
  • Marker
  • SupportedEndpointTypes
    • items SupportedEndpointType

DescribeEndpointsMessage

• DescribeEndpointsMessage object:
  • Filters
    • items Filter
  • Marker
  • MaxRecords

DescribeEndpointsResponse

• DescribeEndpointsResponse object:
  • Endpoints
    • items Endpoint
  • Marker

DescribeEventCategoriesMessage

• DescribeEventCategoriesMessage object:
  • Filters
    • items Filter
  • SourceType

DescribeEventCategoriesResponse

• DescribeEventCategoriesResponse object:
  • EventCategoryGroupList
    • items EventCategoryGroup

DescribeEventSubscriptionsMessage

• DescribeEventSubscriptionsMessage object:
  • Filters
    • items Filter
  • Marker
  • MaxRecords
  • SubscriptionName

DescribeEventSubscriptionsResponse

• DescribeEventSubscriptionsResponse object:
  • EventSubscriptionsList
    • items EventSubscription
  • Marker

DescribeEventsMessage

• DescribeEventsMessage object:
  • Duration
  • EndTime
  • EventCategories
    • items String
  • Filters
    • items Filter
  • Marker
  • MaxRecords
  • SourceIdentifier
  • SourceType
  • StartTime

DescribeEventsResponse

• DescribeEventsResponse object:
  • Events
    • items Event
  • Marker

DescribeOrderableReplicationInstancesMessage

• DescribeOrderableReplicationInstancesMessage object:
  • Marker
  • MaxRecords

DescribeOrderableReplicationInstancesResponse

• DescribeOrderableReplicationInstancesResponse object:
  • Marker
  • OrderableReplicationInstances
    • items OrderableReplicationInstance

DescribePendingMaintenanceActionsMessage

• DescribePendingMaintenanceActionsMessage object:
  • Filters
    • items Filter
  • Marker
  • MaxRecords
  • ReplicationInstanceArn

DescribePendingMaintenanceActionsResponse

• DescribePendingMaintenanceActionsResponse object:
  • Marker
  • PendingMaintenanceActions
    • items ResourcePendingMaintenanceActions

DescribeRefreshSchemasStatusMessage

• DescribeRefreshSchemasStatusMessage object:
  • EndpointArn required

DescribeRefreshSchemasStatusResponse

• DescribeRefreshSchemasStatusResponse object:
  • RefreshSchemasStatus
    • EndpointArn
    • LastFailureMessage
    • LastRefreshDate
    • ReplicationInstanceArn
    • Status

DescribeReplicationInstanceTaskLogsMessage

• DescribeReplicationInstanceTaskLogsMessage object
  • Marker
  • MaxRecords
  • ReplicationInstanceArn required

DescribeReplicationInstanceTaskLogsResponse

• DescribeReplicationInstanceTaskLogsResponse object
  • Marker
  • ReplicationInstanceArn
  • ReplicationInstanceTaskLogs
    • items ReplicationInstanceTaskLog

DescribeReplicationInstancesMessage

• DescribeReplicationInstancesMessage object:
  • Filters
    • items Filter
  • Marker
  • MaxRecords

DescribeReplicationInstancesResponse

• DescribeReplicationInstancesResponse object:
  • Marker
  • ReplicationInstances
    • items ReplicationInstance

DescribeReplicationSubnetGroupsMessage

• DescribeReplicationSubnetGroupsMessage object:
  • Filters
    • items Filter
  • Marker
  • MaxRecords

DescribeReplicationSubnetGroupsResponse

• DescribeReplicationSubnetGroupsResponse object:
  • Marker
  • ReplicationSubnetGroups
    • items ReplicationSubnetGroup

DescribeReplicationTaskAssessmentResultsMessage

• DescribeReplicationTaskAssessmentResultsMessage object:
  • Marker
  • MaxRecords
  • ReplicationTaskArn

DescribeReplicationTaskAssessmentResultsResponse

• DescribeReplicationTaskAssessmentResultsResponse object:
  • BucketName
  • Marker
  • ReplicationTaskAssessmentResults
    • items ReplicationTaskAssessmentResult

DescribeReplicationTaskAssessmentRunsMessage

• DescribeReplicationTaskAssessmentRunsMessage object:
  • Filters
    • items Filter
  • Marker
  • MaxRecords

DescribeReplicationTaskAssessmentRunsResponse

• DescribeReplicationTaskAssessmentRunsResponse object:
  • Marker
  • ReplicationTaskAssessmentRuns
    • items ReplicationTaskAssessmentRun

DescribeReplicationTaskIndividualAssessmentsMessage

• DescribeReplicationTaskIndividualAssessmentsMessage object:
  • Filters
    • items Filter
  • Marker
  • MaxRecords

DescribeReplicationTaskIndividualAssessmentsResponse

• DescribeReplicationTaskIndividualAssessmentsResponse object:
  • Marker
  • ReplicationTaskIndividualAssessments
    • items ReplicationTaskIndividualAssessment

DescribeReplicationTasksMessage

• DescribeReplicationTasksMessage object:
  • Filters
    • items Filter
  • Marker
  • MaxRecords
  • WithoutSettings

DescribeReplicationTasksResponse

• DescribeReplicationTasksResponse object:
  • Marker
  • ReplicationTasks
    • items ReplicationTask

DescribeSchemasMessage

• DescribeSchemasMessage object:
  • EndpointArn required
  • Marker
  • MaxRecords

DescribeSchemasResponse

• DescribeSchemasResponse object:
  • Marker
  • Schemas
    • items String

DescribeTableStatisticsMessage

• DescribeTableStatisticsMessage object:
  • Filters
    • items Filter
  • Marker
  • MaxRecords
  • ReplicationTaskArn required

DescribeTableStatisticsResponse

• DescribeTableStatisticsResponse object:
  • Marker
  • ReplicationTaskArn
  • TableStatistics
    • items TableStatistics

DmsSslModeValue

• DmsSslModeValue string (values: none, require, verify-ca, verify-full)

DmsTransferSettings

• DmsTransferSettings object: The settings in JSON format for the DMS Transfer type source endpoint.
  • BucketName
  • ServiceAccessRoleArn

DocDbSettings

• DocDbSettings object: Provides information that defines a DocumentDB endpoint.
  • DatabaseName
  • DocsToInvestigate
  • ExtractDocId
  • KmsKeyId
  • NestingLevel
  • Password
  • Port
  • ServerName
  • Username

DynamoDbSettings

• DynamoDbSettings object: Provides the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role used to define an Amazon DynamoDB target endpoint.
  • ServiceAccessRoleArn required

ElasticsearchSettings

• ElasticsearchSettings object: Provides information that defines an Elasticsearch endpoint.
  • EndpointUri required
  • ErrorRetryDuration
  • FullLoadErrorPercentage
  • ServiceAccessRoleArn required

EncodingTypeValue

• EncodingTypeValue string (values: plain, plain-dictionary, rle-dictionary)

EncryptionModeValue

• EncryptionModeValue string (values: sse-s3, sse-kms)

Endpoint

• Endpoint object:

  Describes an endpoint of a database instance in response to operations such as the following:

  • CreateEndpoint

  • DescribeEndpoint

  • DescribeEndpointTypes

  • ModifyEndpoint

  • CertificateArn
  • DatabaseName
  • DmsTransferSettings
    • BucketName
    • ServiceAccessRoleArn
  • DocDbSettings DocDbSettings
  • DynamoDbSettings
    • ServiceAccessRoleArn required
  • ElasticsearchSettings
    • EndpointUri required
    • ErrorRetryDuration
    • FullLoadErrorPercentage
    • ServiceAccessRoleArn required
  • EndpointArn
  • EndpointIdentifier
  • EndpointType
  • EngineDisplayName
  • EngineName
  • ExternalId
  • ExternalTableDefinition
  • ExtraConnectionAttributes
  • IBMDb2Settings
    • CurrentLsn
    • DatabaseName
    • MaxKBytesPerRead
    • Password
    • Port
    • ServerName
    • SetDataCaptureChanges
    • Username
  • KafkaSettings
    • Broker
    • IncludeControlDetails
    • IncludeNullAndEmpty
    • IncludePartitionValue
    • IncludeTableAlterOperations
    • IncludeTransactionDetails
    • MessageFormat
    • MessageMaxBytes
    • PartitionIncludeSchemaTable
    • Topic
  • KinesisSettings
    • IncludeControlDetails
    • IncludeNullAndEmpty
    • IncludePartitionValue
    • IncludeTableAlterOperations
    • IncludeTransactionDetails
    • MessageFormat
    • PartitionIncludeSchemaTable
    • ServiceAccessRoleArn
    • StreamArn
  • KmsKeyId
  • MicrosoftSQLServerSettings
    • BcpPacketSize
    • ControlTablesFileGroup
    • DatabaseName
    • Password
    • Port
    • ReadBackupOnly
    • SafeguardPolicy
    • ServerName
    • UseBcpFullLoad
    • Username
  • MongoDbSettings
    • AuthMechanism
    • AuthSource
    • AuthType
    • DatabaseName
    • DocsToInvestigate
    • ExtractDocId
    • KmsKeyId
    • NestingLevel
    • Password
    • Port
    • ServerName
    • Username
  • MySQLSettings
    • AfterConnectScript
    • DatabaseName
    • EventsPollInterval
    • MaxFileSize
    • ParallelLoadThreads
    • Password
    • Port
    • ServerName
    • ServerTimezone
    • TargetDbType
    • Username
  • NeptuneSettings
    • ErrorRetryDuration
    • IamAuthEnabled
    • MaxFileSize
    • MaxRetryCount
    • S3BucketFolder required
    • S3BucketName required
    • ServiceAccessRoleArn
  • OracleSettings
    • AccessAlternateDirectly
    • AddSupplementalLogging
    • AdditionalArchivedLogDestId
    • AllowSelectNestedTables
    • ArchivedLogDestId
    • ArchivedLogsOnly
    • AsmPassword
    • AsmServer
    • AsmUser
    • CharLengthSemantics
    • DatabaseName
    • DirectPathNoLog
    • DirectPathParallelLoad
    • EnableHomogenousTablespace
    • FailTasksOnLobTruncation
    • NumberDatatypeScale
    • OraclePathPrefix
    • ParallelAsmReadThreads
    • Password
    • Port
    • ReadAheadBlocks
    • ReadTableSpaceName
    • ReplacePathPrefix
    • RetryInterval
    • SecurityDbEncryption
    • SecurityDbEncryptionName
    • ServerName
    • UseAlternateFolderForOnline
    • UsePathPrefix
    • Username
  • Port
  • PostgreSQLSettings
    • AfterConnectScript
    • CaptureDdls
    • DatabaseName
    • DdlArtifactsSchema
    • ExecuteTimeout
    • FailTasksOnLobTruncation
    • MaxFileSize
    • Password
    • Port
    • ServerName
    • SlotName
    • Username
  • RedshiftSettings
    • AcceptAnyDate
    • AfterConnectScript
    • BucketFolder
    • BucketName
    • CaseSensitiveNames
    • CompUpdate
    • ConnectionTimeout
    • DatabaseName
    • DateFormat
    • EmptyAsNull
    • EncryptionMode
    • ExplicitIds
    • FileTransferUploadStreams
    • LoadTimeout
    • MaxFileSize
    • Password
    • Port
    • RemoveQuotes
    • ReplaceChars
    • ReplaceInvalidChars
    • ServerName
    • ServerSideEncryptionKmsKeyId
    • ServiceAccessRoleArn
    • TimeFormat
    • TrimBlanks
    • TruncateColumns
    • Username
    • WriteBufferSize
  • S3Settings
    • BucketFolder
    • BucketName
    • CdcInsertsAndUpdates
    • CdcInsertsOnly
    • CdcPath
    • CompressionType
    • CsvDelimiter
    • CsvNoSupValue
    • CsvRowDelimiter
    • DataFormat
    • DataPageSize
    • DatePartitionDelimiter
    • DatePartitionEnabled
    • DatePartitionSequence
    • DictPageSizeLimit
    • EnableStatistics
    • EncodingType
    • EncryptionMode
    • ExternalTableDefinition
    • IncludeOpForFullLoad
    • ParquetTimestampInMillisecond
    • ParquetVersion
    • PreserveTransactions
    • RowGroupLength
    • ServerSideEncryptionKmsKeyId
    • ServiceAccessRoleArn
    • TimestampColumnName
    • UseCsvNoSupValue
  • ServerName
  • ServiceAccessRoleArn
  • SslMode
  • Status
  • SybaseSettings
    • DatabaseName
    • Password
    • Port
    • ServerName
    • Username
  • Username

EndpointList

• EndpointList array
  • items Endpoint

Event

• Event object: Describes an identifiable significant activity that affects a replication instance or task. This object can provide the message, the available event categories, the date and source of the event, and the AWS DMS resource type.
  • Date
  • EventCategories
    • items String
  • Message
  • SourceIdentifier
  • SourceType

EventCategoriesList

• EventCategoriesList array
  • items String

EventCategoryGroup

• EventCategoryGroup object: Lists categories of events subscribed to, and generated by, the applicable AWS DMS resource type. This data type appears in response to the DescribeEventCategories action.
  • EventCategories
    • items String
  • SourceType

EventCategoryGroupList

• EventCategoryGroupList array
  • items EventCategoryGroup

EventList

• EventList array
  • items Event

EventSubscription

• EventSubscription object: Describes an event notification subscription created by the CreateEventSubscription operation.
  • CustSubscriptionId
  • CustomerAwsId
  • Enabled
  • EventCategoriesList
    • items String
  • SnsTopicArn
  • SourceIdsList
    • items String
  • SourceType
  • Status
  • SubscriptionCreationTime

EventSubscriptionsList

• EventSubscriptionsList array
  • items EventSubscription

ExcludeTestList

• ExcludeTestList array
  • items String

Filter

• Filter object: Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter to the following APIs.
  • Name required
  • Values required
    • items String

FilterList

• FilterList array
  • items Filter

FilterValueList

• FilterValueList array
  • items String

IBMDb2Settings

• IBMDb2Settings object: Provides information that defines an IBM Db2 LUW endpoint.
  • CurrentLsn
  • DatabaseName
  • MaxKBytesPerRead
  • Password
  • Port
  • ServerName
  • SetDataCaptureChanges
  • Username

ImportCertificateMessage

• ImportCertificateMessage object
  • CertificateIdentifier required
  • CertificatePem
  • CertificateWallet
  • Tags
    • items Tag

ImportCertificateResponse

• ImportCertificateResponse object
  • Certificate
    • CertificateArn
    • CertificateCreationDate
    • CertificateIdentifier
    • CertificateOwner
    • CertificatePem
    • CertificateWallet
    • KeyLength
    • SigningAlgorithm
    • ValidFromDate
    • ValidToDate

IncludeTestList

• IncludeTestList array
  • items String

IndividualAssessmentNameList

• IndividualAssessmentNameList array
  • items String

InsufficientResourceCapacityFault

Integer

• Integer integer

IntegerOptional

• IntegerOptional integer

InvalidCertificateFault

InvalidResourceStateFault

InvalidSubnet

KMSAccessDeniedFault

KMSDisabledFault

KMSFault

KMSInvalidStateFault

KMSKeyNotAccessibleFault

KMSNotFoundFault

KMSThrottlingFault

KafkaSettings

• KafkaSettings object: Provides information that describes an Apache Kafka endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.
  • Broker
  • IncludeControlDetails
  • IncludeNullAndEmpty
  • IncludePartitionValue
  • IncludeTableAlterOperations
  • IncludeTransactionDetails
  • MessageFormat
  • MessageMaxBytes
  • PartitionIncludeSchemaTable
  • Topic

KeyList

• KeyList array
  • items String

KinesisSettings

• KinesisSettings object: Provides information that describes an Amazon Kinesis Data Stream endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.
  • IncludeControlDetails
  • IncludeNullAndEmpty
  • IncludePartitionValue
  • IncludeTableAlterOperations
  • IncludeTransactionDetails
  • MessageFormat
  • PartitionIncludeSchemaTable
  • ServiceAccessRoleArn
  • StreamArn

ListTagsForResourceMessage

• ListTagsForResourceMessage object:
  • ResourceArn required

ListTagsForResourceResponse

• ListTagsForResourceResponse object:
  • TagList
    • items Tag

Long

• Long integer

MessageFormatValue

• MessageFormatValue string (values: json, json-unformatted)

MicrosoftSQLServerSettings

• MicrosoftSQLServerSettings object: Provides information that defines a Microsoft SQL Server endpoint.
  • BcpPacketSize
  • ControlTablesFileGroup
  • DatabaseName
  • Password
  • Port
  • ReadBackupOnly
  • SafeguardPolicy
  • ServerName
  • UseBcpFullLoad
  • Username

MigrationTypeValue

• MigrationTypeValue string (values: full-load, cdc, full-load-and-cdc)

ModifyEndpointMessage

• ModifyEndpointMessage object:
  • CertificateArn
  • DatabaseName
  • DmsTransferSettings
    • BucketName
    • ServiceAccessRoleArn
  • DocDbSettings
    • DatabaseName
    • DocsToInvestigate
    • ExtractDocId
    • KmsKeyId
    • NestingLevel
    • Password
    • Port
    • ServerName
    • Username
  • DynamoDbSettings
    • ServiceAccessRoleArn required
  • ElasticsearchSettings
    • EndpointUri required
    • ErrorRetryDuration
    • FullLoadErrorPercentage
    • ServiceAccessRoleArn required
  • EndpointArn required
  • EndpointIdentifier
  • EndpointType
  • EngineName
  • ExternalTableDefinition
  • ExtraConnectionAttributes
  • IBMDb2Settings
    • CurrentLsn
    • DatabaseName
    • MaxKBytesPerRead
    • Password
    • Port
    • ServerName
    • SetDataCaptureChanges
    • Username
  • KafkaSettings
    • Broker
    • IncludeControlDetails
    • IncludeNullAndEmpty
    • IncludePartitionValue
    • IncludeTableAlterOperations
    • IncludeTransactionDetails
    • MessageFormat
    • MessageMaxBytes
    • PartitionIncludeSchemaTable
    • Topic
  • KinesisSettings
    • IncludeControlDetails
    • IncludeNullAndEmpty
    • IncludePartitionValue
    • IncludeTableAlterOperations
    • IncludeTransactionDetails
    • MessageFormat
    • PartitionIncludeSchemaTable
    • ServiceAccessRoleArn
    • StreamArn
  • MicrosoftSQLServerSettings
    • BcpPacketSize
    • ControlTablesFileGroup
    • DatabaseName
    • Password
    • Port
    • ReadBackupOnly
    • SafeguardPolicy
    • ServerName
    • UseBcpFullLoad
    • Username
  • MongoDbSettings
    • AuthMechanism
    • AuthSource
    • AuthType
    • DatabaseName
    • DocsToInvestigate
    • ExtractDocId
    • KmsKeyId
    • NestingLevel
    • Password
    • Port
    • ServerName
    • Username
  • MySQLSettings
    • AfterConnectScript
    • DatabaseName
    • EventsPollInterval
    • MaxFileSize
    • ParallelLoadThreads
    • Password
    • Port
    • ServerName
    • ServerTimezone
    • TargetDbType
    • Username
  • NeptuneSettings
    • ErrorRetryDuration
    • IamAuthEnabled
    • MaxFileSize
    • MaxRetryCount
    • S3BucketFolder required
    • S3BucketName required
    • ServiceAccessRoleArn
  • OracleSettings
    • AccessAlternateDirectly
    • AddSupplementalLogging
    • AdditionalArchivedLogDestId
    • AllowSelectNestedTables
    • ArchivedLogDestId
    • ArchivedLogsOnly
    • AsmPassword
    • AsmServer
    • AsmUser
    • CharLengthSemantics
    • DatabaseName
    • DirectPathNoLog
    • DirectPathParallelLoad
    • EnableHomogenousTablespace
    • FailTasksOnLobTruncation
    • NumberDatatypeScale
    • OraclePathPrefix
    • ParallelAsmReadThreads
    • Password
    • Port
    • ReadAheadBlocks
    • ReadTableSpaceName
    • ReplacePathPrefix
    • RetryInterval
    • SecurityDbEncryption
    • SecurityDbEncryptionName
    • ServerName
    • UseAlternateFolderForOnline
    • UsePathPrefix
    • Username
  • Password
  • Port
  • PostgreSQLSettings
    • AfterConnectScript
    • CaptureDdls
    • DatabaseName
    • DdlArtifactsSchema
    • ExecuteTimeout
    • FailTasksOnLobTruncation
    • MaxFileSize
    • Password
    • Port
    • ServerName
    • SlotName
    • Username
  • RedshiftSettings RedshiftSettings
  • S3Settings
    • BucketFolder
    • BucketName
    • CdcInsertsAndUpdates
    • CdcInsertsOnly
    • CdcPath
    • CompressionType
    • CsvDelimiter
    • CsvNoSupValue
    • CsvRowDelimiter
    • DataFormat
    • DataPageSize
    • DatePartitionDelimiter
    • DatePartitionEnabled
    • DatePartitionSequence
    • DictPageSizeLimit
    • EnableStatistics
    • EncodingType
    • EncryptionMode
    • ExternalTableDefinition
    • IncludeOpForFullLoad
    • ParquetTimestampInMillisecond
    • ParquetVersion
    • PreserveTransactions
    • RowGroupLength
    • ServerSideEncryptionKmsKeyId
    • ServiceAccessRoleArn
    • TimestampColumnName
    • UseCsvNoSupValue
  • ServerName
  • ServiceAccessRoleArn
  • SslMode
  • SybaseSettings
    • DatabaseName
    • Password
    • Port
    • ServerName
    • Username
  • Username

ModifyEndpointResponse

• ModifyEndpointResponse object:
  • Endpoint
    • CertificateArn
    • DatabaseName
    • DmsTransferSettings
      • BucketName
      • ServiceAccessRoleArn
    • DocDbSettings DocDbSettings
    • DynamoDbSettings
      • ServiceAccessRoleArn required
    • ElasticsearchSettings
      • EndpointUri required
      • ErrorRetryDuration
      • FullLoadErrorPercentage
      • ServiceAccessRoleArn required
    • EndpointArn
    • EndpointIdentifier
    • EndpointType
    • EngineDisplayName
    • EngineName
    • ExternalId
    • ExternalTableDefinition
    • ExtraConnectionAttributes
    • IBMDb2Settings
      • CurrentLsn
      • DatabaseName
      • MaxKBytesPerRead
      • Password
      • Port
      • ServerName
      • SetDataCaptureChanges
      • Username
    • KafkaSettings
      • Broker
      • IncludeControlDetails
      • IncludeNullAndEmpty
      • IncludePartitionValue
      • IncludeTableAlterOperations
      • IncludeTransactionDetails
      • MessageFormat
      • MessageMaxBytes
      • PartitionIncludeSchemaTable
      • Topic
    • KinesisSettings
      • IncludeControlDetails
      • IncludeNullAndEmpty
      • IncludePartitionValue
      • IncludeTableAlterOperations
      • IncludeTransactionDetails
      • MessageFormat
      • PartitionIncludeSchemaTable
      • ServiceAccessRoleArn
      • StreamArn
    • KmsKeyId
    • MicrosoftSQLServerSettings
      • BcpPacketSize
      • ControlTablesFileGroup
      • DatabaseName
      • Password
      • Port
      • ReadBackupOnly
      • SafeguardPolicy
      • ServerName
      • UseBcpFullLoad
      • Username
    • MongoDbSettings
      • AuthMechanism
      • AuthSource
      • AuthType
      • DatabaseName
      • DocsToInvestigate
      • ExtractDocId
      • KmsKeyId
      • NestingLevel
      • Password
      • Port
      • ServerName
      • Username
    • MySQLSettings
      • AfterConnectScript
      • DatabaseName
      • EventsPollInterval
      • MaxFileSize
      • ParallelLoadThreads
      • Password
      • Port
      • ServerName
      • ServerTimezone
      • TargetDbType
      • Username
    • NeptuneSettings
      • ErrorRetryDuration
      • IamAuthEnabled
      • MaxFileSize
      • MaxRetryCount
      • S3BucketFolder required
      • S3BucketName required
      • ServiceAccessRoleArn
    • OracleSettings
      • AccessAlternateDirectly
      • AddSupplementalLogging
      • AdditionalArchivedLogDestId
      • AllowSelectNestedTables
      • ArchivedLogDestId
      • ArchivedLogsOnly
      • AsmPassword
      • AsmServer
      • AsmUser
      • CharLengthSemantics
      • DatabaseName
      • DirectPathNoLog
      • DirectPathParallelLoad
      • EnableHomogenousTablespace
      • FailTasksOnLobTruncation
      • NumberDatatypeScale
      • OraclePathPrefix
      • ParallelAsmReadThreads
      • Password
      • Port
      • ReadAheadBlocks
      • ReadTableSpaceName
      • ReplacePathPrefix
      • RetryInterval
      • SecurityDbEncryption
      • SecurityDbEncryptionName
      • ServerName
      • UseAlternateFolderForOnline
      • UsePathPrefix
      • Username
    • Port
    • PostgreSQLSettings
      • AfterConnectScript
      • CaptureDdls
      • DatabaseName
      • DdlArtifactsSchema
      • ExecuteTimeout
      • FailTasksOnLobTruncation
      • MaxFileSize
      • Password
      • Port
      • ServerName
      • SlotName
      • Username
    • RedshiftSettings
      • AcceptAnyDate
      • AfterConnectScript
      • BucketFolder
      • BucketName
      • CaseSensitiveNames
      • CompUpdate
      • ConnectionTimeout
      • DatabaseName
      • DateFormat
      • EmptyAsNull
      • EncryptionMode
      • ExplicitIds
      • FileTransferUploadStreams
      • LoadTimeout
      • MaxFileSize
      • Password
      • Port
      • RemoveQuotes
      • ReplaceChars
      • ReplaceInvalidChars
      • ServerName
      • ServerSideEncryptionKmsKeyId
      • ServiceAccessRoleArn
      • TimeFormat
      • TrimBlanks
      • TruncateColumns
      • Username
      • WriteBufferSize
    • S3Settings
      • BucketFolder
      • BucketName
      • CdcInsertsAndUpdates
      • CdcInsertsOnly
      • CdcPath
      • CompressionType
      • CsvDelimiter
      • CsvNoSupValue
      • CsvRowDelimiter
      • DataFormat
      • DataPageSize
      • DatePartitionDelimiter
      • DatePartitionEnabled
      • DatePartitionSequence
      • DictPageSizeLimit
      • EnableStatistics
      • EncodingType
      • EncryptionMode
      • ExternalTableDefinition
      • IncludeOpForFullLoad
      • ParquetTimestampInMillisecond
      • ParquetVersion
      • PreserveTransactions
      • RowGroupLength
      • ServerSideEncryptionKmsKeyId
      • ServiceAccessRoleArn
      • TimestampColumnName
      • UseCsvNoSupValue
    • ServerName
    • ServiceAccessRoleArn
    • SslMode
    • Status
    • SybaseSettings
      • DatabaseName
      • Password
      • Port
      • ServerName
      • Username
    • Username

ModifyEventSubscriptionMessage

• ModifyEventSubscriptionMessage object:
  • Enabled
  • EventCategories
    • items String
  • SnsTopicArn
  • SourceType
  • SubscriptionName required

ModifyEventSubscriptionResponse

• ModifyEventSubscriptionResponse object:
  • EventSubscription
    • CustSubscriptionId
    • CustomerAwsId
    • Enabled
    • EventCategoriesList
      • items String
    • SnsTopicArn
    • SourceIdsList
      • items String
    • SourceType
    • Status
    • SubscriptionCreationTime

ModifyReplicationInstanceMessage

• ModifyReplicationInstanceMessage object:
  • AllocatedStorage
  • AllowMajorVersionUpgrade
  • ApplyImmediately
  • AutoMinorVersionUpgrade
  • EngineVersion
  • MultiAZ
  • PreferredMaintenanceWindow
  • ReplicationInstanceArn required
  • ReplicationInstanceClass
  • ReplicationInstanceIdentifier
  • VpcSecurityGroupIds
    • items String

ModifyReplicationInstanceResponse

• ModifyReplicationInstanceResponse object:
  • ReplicationInstance
    • AllocatedStorage
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • DnsNameServers
    • EngineVersion
    • FreeUntil
    • InstanceCreateTime
    • KmsKeyId
    • MultiAZ
    • PendingModifiedValues
      • AllocatedStorage
      • EngineVersion
      • MultiAZ
      • ReplicationInstanceClass
    • PreferredMaintenanceWindow
    • PubliclyAccessible
    • ReplicationInstanceArn
    • ReplicationInstanceClass
    • ReplicationInstanceIdentifier
    • ReplicationInstancePrivateIpAddress
    • ReplicationInstancePrivateIpAddresses
      • items String
    • ReplicationInstancePublicIpAddress
    • ReplicationInstancePublicIpAddresses
      • items String
    • ReplicationInstanceStatus
    • ReplicationSubnetGroup
      • ReplicationSubnetGroupDescription
      • ReplicationSubnetGroupIdentifier
      • SubnetGroupStatus
      • Subnets
        • items Subnet
      • VpcId
    • SecondaryAvailabilityZone
    • VpcSecurityGroups
      • items VpcSecurityGroupMembership

ModifyReplicationSubnetGroupMessage

• ModifyReplicationSubnetGroupMessage object:
  • ReplicationSubnetGroupDescription
  • ReplicationSubnetGroupIdentifier required
  • SubnetIds required
    • items String

ModifyReplicationSubnetGroupResponse

• ModifyReplicationSubnetGroupResponse object:
  • ReplicationSubnetGroup
    • ReplicationSubnetGroupDescription
    • ReplicationSubnetGroupIdentifier
    • SubnetGroupStatus
    • Subnets
      • items Subnet
    • VpcId

ModifyReplicationTaskMessage

• ModifyReplicationTaskMessage object:
  • CdcStartPosition
  • CdcStartTime
  • CdcStopPosition
  • MigrationType
  • ReplicationTaskArn required
  • ReplicationTaskIdentifier
  • ReplicationTaskSettings
  • TableMappings
  • TaskData

ModifyReplicationTaskResponse

• ModifyReplicationTaskResponse object:
  • ReplicationTask
    • CdcStartPosition
    • CdcStopPosition
    • LastFailureMessage
    • MigrationType
    • RecoveryCheckpoint
    • ReplicationInstanceArn
    • ReplicationTaskArn
    • ReplicationTaskCreationDate
    • ReplicationTaskIdentifier
    • ReplicationTaskSettings
    • ReplicationTaskStartDate
    • ReplicationTaskStats
      • ElapsedTimeMillis
      • FreshStartDate
      • FullLoadFinishDate
      • FullLoadProgressPercent
      • FullLoadStartDate
      • StartDate
      • StopDate
      • TablesErrored
      • TablesLoaded
      • TablesLoading
      • TablesQueued
    • SourceEndpointArn
    • Status
    • StopReason
    • TableMappings
    • TargetEndpointArn
    • TargetReplicationInstanceArn
    • TaskData

MongoDbSettings

• MongoDbSettings object: Provides information that defines a MongoDB endpoint.
  • AuthMechanism
  • AuthSource
  • AuthType
  • DatabaseName
  • DocsToInvestigate
  • ExtractDocId
  • KmsKeyId
  • NestingLevel
  • Password
  • Port
  • ServerName
  • Username

MoveReplicationTaskMessage

• MoveReplicationTaskMessage object:
  • ReplicationTaskArn required
  • TargetReplicationInstanceArn required

MoveReplicationTaskResponse

• MoveReplicationTaskResponse object:
  • ReplicationTask
    • CdcStartPosition
    • CdcStopPosition
    • LastFailureMessage
    • MigrationType
    • RecoveryCheckpoint
    • ReplicationInstanceArn
    • ReplicationTaskArn
    • ReplicationTaskCreationDate
    • ReplicationTaskIdentifier
    • ReplicationTaskSettings
    • ReplicationTaskStartDate
    • ReplicationTaskStats
      • ElapsedTimeMillis
      • FreshStartDate
      • FullLoadFinishDate
      • FullLoadProgressPercent
      • FullLoadStartDate
      • StartDate
      • StopDate
      • TablesErrored
      • TablesLoaded
      • TablesLoading
      • TablesQueued
    • SourceEndpointArn
    • Status
    • StopReason
    • TableMappings
    • TargetEndpointArn
    • TargetReplicationInstanceArn
    • TaskData

MySQLSettings

• MySQLSettings object: Provides information that defines a MySQL endpoint.
  • AfterConnectScript
  • DatabaseName
  • EventsPollInterval
  • MaxFileSize
  • ParallelLoadThreads
  • Password
  • Port
  • ServerName
  • ServerTimezone
  • TargetDbType
  • Username

NeptuneSettings

• NeptuneSettings object: Provides information that defines an Amazon Neptune endpoint.
  • ErrorRetryDuration
  • IamAuthEnabled
  • MaxFileSize
  • MaxRetryCount
  • S3BucketFolder required
  • S3BucketName required
  • ServiceAccessRoleArn

NestingLevelValue

• NestingLevelValue string (values: none, one)

OracleSettings

• OracleSettings object: Provides information that defines an Oracle endpoint.
  • AccessAlternateDirectly
  • AddSupplementalLogging
  • AdditionalArchivedLogDestId
  • AllowSelectNestedTables
  • ArchivedLogDestId
  • ArchivedLogsOnly
  • AsmPassword
  • AsmServer
  • AsmUser
  • CharLengthSemantics
  • DatabaseName
  • DirectPathNoLog
  • DirectPathParallelLoad
  • EnableHomogenousTablespace
  • FailTasksOnLobTruncation
  • NumberDatatypeScale
  • OraclePathPrefix
  • ParallelAsmReadThreads
  • Password
  • Port
  • ReadAheadBlocks
  • ReadTableSpaceName
  • ReplacePathPrefix
  • RetryInterval
  • SecurityDbEncryption
  • SecurityDbEncryptionName
  • ServerName
  • UseAlternateFolderForOnline
  • UsePathPrefix
  • Username

OrderableReplicationInstance

• OrderableReplicationInstance object: In response to the DescribeOrderableReplicationInstances operation, this object describes an available replication instance. This description includes the replication instance's type, engine version, and allocated storage.
  • AvailabilityZones
    • items String
  • DefaultAllocatedStorage
  • EngineVersion
  • IncludedAllocatedStorage
  • MaxAllocatedStorage
  • MinAllocatedStorage
  • ReleaseStatus
  • ReplicationInstanceClass
  • StorageType

OrderableReplicationInstanceList

• OrderableReplicationInstanceList array
  • items OrderableReplicationInstance

ParquetVersionValue

• ParquetVersionValue string (values: parquet-1-0, parquet-2-0)

PendingMaintenanceAction

• PendingMaintenanceAction object: Describes a maintenance action pending for an AWS DMS resource, including when and how it will be applied. This data type is a response element to the DescribePendingMaintenanceActions operation.
  • Action
  • AutoAppliedAfterDate
  • CurrentApplyDate
  • Description
  • ForcedApplyDate
  • OptInStatus

PendingMaintenanceActionDetails

• PendingMaintenanceActionDetails array
  • items PendingMaintenanceAction

PendingMaintenanceActions

• PendingMaintenanceActions array
  • items ResourcePendingMaintenanceActions

PostgreSQLSettings

• PostgreSQLSettings object: Provides information that defines a PostgreSQL endpoint.
  • AfterConnectScript
  • CaptureDdls
  • DatabaseName
  • DdlArtifactsSchema
  • ExecuteTimeout
  • FailTasksOnLobTruncation
  • MaxFileSize
  • Password
  • Port
  • ServerName
  • SlotName
  • Username

RebootReplicationInstanceMessage

• RebootReplicationInstanceMessage object
  • ForceFailover
  • ReplicationInstanceArn required

RebootReplicationInstanceResponse

• RebootReplicationInstanceResponse object
  • ReplicationInstance
    • AllocatedStorage
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • DnsNameServers
    • EngineVersion
    • FreeUntil
    • InstanceCreateTime
    • KmsKeyId
    • MultiAZ
    • PendingModifiedValues
      • AllocatedStorage
      • EngineVersion
      • MultiAZ
      • ReplicationInstanceClass
    • PreferredMaintenanceWindow
    • PubliclyAccessible
    • ReplicationInstanceArn
    • ReplicationInstanceClass
    • ReplicationInstanceIdentifier
    • ReplicationInstancePrivateIpAddress
    • ReplicationInstancePrivateIpAddresses
      • items String
    • ReplicationInstancePublicIpAddress
    • ReplicationInstancePublicIpAddresses
      • items String
    • ReplicationInstanceStatus
    • ReplicationSubnetGroup
      • ReplicationSubnetGroupDescription
      • ReplicationSubnetGroupIdentifier
      • SubnetGroupStatus
      • Subnets
        • items Subnet
      • VpcId
    • SecondaryAvailabilityZone
    • VpcSecurityGroups
      • items VpcSecurityGroupMembership

RedshiftSettings

• RedshiftSettings object: Provides information that defines an Amazon Redshift endpoint.
  • AcceptAnyDate
  • AfterConnectScript
  • BucketFolder
  • BucketName
  • CaseSensitiveNames
  • CompUpdate
  • ConnectionTimeout
  • DatabaseName
  • DateFormat
  • EmptyAsNull
  • EncryptionMode
  • ExplicitIds
  • FileTransferUploadStreams
  • LoadTimeout
  • MaxFileSize
  • Password
  • Port
  • RemoveQuotes
  • ReplaceChars
  • ReplaceInvalidChars
  • ServerName
  • ServerSideEncryptionKmsKeyId
  • ServiceAccessRoleArn
  • TimeFormat
  • TrimBlanks
  • TruncateColumns
  • Username
  • WriteBufferSize

RefreshSchemasMessage

• RefreshSchemasMessage object:
  • EndpointArn required
  • ReplicationInstanceArn required

RefreshSchemasResponse

• RefreshSchemasResponse object:
  • RefreshSchemasStatus
    • EndpointArn
    • LastFailureMessage
    • LastRefreshDate
    • ReplicationInstanceArn
    • Status

RefreshSchemasStatus

• RefreshSchemasStatus object: Provides information that describes status of a schema at an endpoint specified by the DescribeRefreshSchemaStatus operation.
  • EndpointArn
  • LastFailureMessage
  • LastRefreshDate
  • ReplicationInstanceArn
  • Status

RefreshSchemasStatusTypeValue

• RefreshSchemasStatusTypeValue string (values: successful, failed, refreshing)

ReleaseStatusValues

• ReleaseStatusValues string (values: beta)

ReloadOptionValue

• ReloadOptionValue string (values: data-reload, validate-only)

ReloadTablesMessage

• ReloadTablesMessage object
  • ReloadOption
  • ReplicationTaskArn required
  • TablesToReload required
    • items TableToReload

ReloadTablesResponse

• ReloadTablesResponse object
  • ReplicationTaskArn

RemoveTagsFromResourceMessage

• RemoveTagsFromResourceMessage object: Removes one or more tags from an AWS DMS resource.
  • ResourceArn required
  • TagKeys required
    • items String

RemoveTagsFromResourceResponse

• RemoveTagsFromResourceResponse object:

ReplicationEndpointTypeValue

• ReplicationEndpointTypeValue string (values: source, target)

ReplicationInstance

• ReplicationInstance object: Provides information that defines a replication instance.
  • AllocatedStorage
  • AutoMinorVersionUpgrade
  • AvailabilityZone
  • DnsNameServers
  • EngineVersion
  • FreeUntil
  • InstanceCreateTime
  • KmsKeyId
  • MultiAZ
  • PendingModifiedValues
    • AllocatedStorage
    • EngineVersion
    • MultiAZ
    • ReplicationInstanceClass
  • PreferredMaintenanceWindow
  • PubliclyAccessible
  • ReplicationInstanceArn
  • ReplicationInstanceClass
  • ReplicationInstanceIdentifier
  • ReplicationInstancePrivateIpAddress
  • ReplicationInstancePrivateIpAddresses
    • items String
  • ReplicationInstancePublicIpAddress
  • ReplicationInstancePublicIpAddresses
    • items String
  • ReplicationInstanceStatus
  • ReplicationSubnetGroup
    • ReplicationSubnetGroupDescription
    • ReplicationSubnetGroupIdentifier
    • SubnetGroupStatus
    • Subnets
      • items Subnet
    • VpcId
  • SecondaryAvailabilityZone
  • VpcSecurityGroups
    • items VpcSecurityGroupMembership

ReplicationInstanceList

• ReplicationInstanceList array
  • items ReplicationInstance

ReplicationInstancePrivateIpAddressList

• ReplicationInstancePrivateIpAddressList array
  • items String

ReplicationInstancePublicIpAddressList

• ReplicationInstancePublicIpAddressList array
  • items String

ReplicationInstanceTaskLog

• ReplicationInstanceTaskLog object: Contains metadata for a replication instance task log.
  • ReplicationInstanceTaskLogSize
  • ReplicationTaskArn
  • ReplicationTaskName

ReplicationInstanceTaskLogsList

• ReplicationInstanceTaskLogsList array
  • items ReplicationInstanceTaskLog

ReplicationPendingModifiedValues

• ReplicationPendingModifiedValues object: Provides information about the values of pending modifications to a replication instance. This data type is an object of the ReplicationInstance user-defined data type.
  • AllocatedStorage
  • EngineVersion
  • MultiAZ
  • ReplicationInstanceClass

ReplicationSubnetGroup

• ReplicationSubnetGroup object: Describes a subnet group in response to a request by the DescribeReplicationSubnetGroups operation.
  • ReplicationSubnetGroupDescription
  • ReplicationSubnetGroupIdentifier
  • SubnetGroupStatus
  • Subnets
    • items Subnet
  • VpcId

ReplicationSubnetGroupDoesNotCoverEnoughAZs

ReplicationSubnetGroups

• ReplicationSubnetGroups array
  • items ReplicationSubnetGroup

ReplicationTask

• ReplicationTask object: Provides information that describes a replication task created by the CreateReplicationTask operation.
  • CdcStartPosition
  • CdcStopPosition
  • LastFailureMessage
  • MigrationType
  • RecoveryCheckpoint
  • ReplicationInstanceArn
  • ReplicationTaskArn
  • ReplicationTaskCreationDate
  • ReplicationTaskIdentifier
  • ReplicationTaskSettings
  • ReplicationTaskStartDate
  • ReplicationTaskStats
    • ElapsedTimeMillis
    • FreshStartDate
    • FullLoadFinishDate
    • FullLoadProgressPercent
    • FullLoadStartDate
    • StartDate
    • StopDate
    • TablesErrored
    • TablesLoaded
    • TablesLoading
    • TablesQueued
  • SourceEndpointArn
  • Status
  • StopReason
  • TableMappings
  • TargetEndpointArn
  • TargetReplicationInstanceArn
  • TaskData

ReplicationTaskAssessmentResult

• ReplicationTaskAssessmentResult object: The task assessment report in JSON format.
  • AssessmentResults
  • AssessmentResultsFile
  • AssessmentStatus
  • ReplicationTaskArn
  • ReplicationTaskIdentifier
  • ReplicationTaskLastAssessmentDate
  • S3ObjectUrl

ReplicationTaskAssessmentResultList

• ReplicationTaskAssessmentResultList array
  • items ReplicationTaskAssessmentResult

ReplicationTaskAssessmentRun

• ReplicationTaskAssessmentRun object:

  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.

  • AssessmentProgress
    • IndividualAssessmentCompletedCount
    • IndividualAssessmentCount
  • AssessmentRunName
  • LastFailureMessage
  • ReplicationTaskArn
  • ReplicationTaskAssessmentRunArn
  • ReplicationTaskAssessmentRunCreationDate
  • ResultEncryptionMode
  • ResultKmsKeyArn
  • ResultLocationBucket
  • ResultLocationFolder
  • ServiceAccessRoleArn
  • Status

ReplicationTaskAssessmentRunList

• ReplicationTaskAssessmentRunList array
  • items ReplicationTaskAssessmentRun

ReplicationTaskAssessmentRunProgress

• ReplicationTaskAssessmentRunProgress object: The progress values reported by the AssessmentProgress response element.
  • IndividualAssessmentCompletedCount
  • IndividualAssessmentCount

ReplicationTaskIndividualAssessment

• ReplicationTaskIndividualAssessment object: Provides information that describes an individual assessment from a premigration assessment run.
  • IndividualAssessmentName
  • ReplicationTaskAssessmentRunArn
  • ReplicationTaskIndividualAssessmentArn
  • ReplicationTaskIndividualAssessmentStartDate
  • Status

ReplicationTaskIndividualAssessmentList

• ReplicationTaskIndividualAssessmentList array
  • items ReplicationTaskIndividualAssessment

ReplicationTaskList

• ReplicationTaskList array
  • items ReplicationTask

ReplicationTaskStats

• ReplicationTaskStats object: In response to a request by the DescribeReplicationTasks operation, this object provides a collection of statistics about a replication task.
  • ElapsedTimeMillis
  • FreshStartDate
  • FullLoadFinishDate
  • FullLoadProgressPercent
  • FullLoadStartDate
  • StartDate
  • StopDate
  • TablesErrored
  • TablesLoaded
  • TablesLoading
  • TablesQueued

ResourceAlreadyExistsFault

ResourceNotFoundFault

ResourcePendingMaintenanceActions

• ResourcePendingMaintenanceActions object: Identifies an AWS DMS resource and any pending actions for it.
  • PendingMaintenanceActionDetails
    • items PendingMaintenanceAction
  • ResourceIdentifier

ResourceQuotaExceededFault

S3AccessDeniedFault

S3ResourceNotFoundFault

S3Settings

• S3Settings object: Settings for exporting data to Amazon S3.
  • BucketFolder
  • BucketName
  • CdcInsertsAndUpdates
  • CdcInsertsOnly
  • CdcPath
  • CompressionType
  • CsvDelimiter
  • CsvNoSupValue
  • CsvRowDelimiter
  • DataFormat
  • DataPageSize
  • DatePartitionDelimiter
  • DatePartitionEnabled
  • DatePartitionSequence
  • DictPageSizeLimit
  • EnableStatistics
  • EncodingType
  • EncryptionMode
  • ExternalTableDefinition
  • IncludeOpForFullLoad
  • ParquetTimestampInMillisecond
  • ParquetVersion
  • PreserveTransactions
  • RowGroupLength
  • ServerSideEncryptionKmsKeyId
  • ServiceAccessRoleArn
  • TimestampColumnName
  • UseCsvNoSupValue

SNSInvalidTopicFault

SNSNoAuthorizationFault

SafeguardPolicy

• SafeguardPolicy string (values: rely-on-sql-server-replication-agent, exclusive-automatic-truncation, shared-automatic-truncation)

SchemaList

• SchemaList array
  • items String

SecretString

• SecretString string

SourceIdsList

• SourceIdsList array
  • items String

SourceType

• SourceType string (values: replication-instance)

StartReplicationTaskAssessmentMessage

• StartReplicationTaskAssessmentMessage object:
  • ReplicationTaskArn required

StartReplicationTaskAssessmentResponse

• StartReplicationTaskAssessmentResponse object:
  • ReplicationTask
    • CdcStartPosition
    • CdcStopPosition
    • LastFailureMessage
    • MigrationType
    • RecoveryCheckpoint
    • ReplicationInstanceArn
    • ReplicationTaskArn
    • ReplicationTaskCreationDate
    • ReplicationTaskIdentifier
    • ReplicationTaskSettings
    • ReplicationTaskStartDate
    • ReplicationTaskStats
      • ElapsedTimeMillis
      • FreshStartDate
      • FullLoadFinishDate
      • FullLoadProgressPercent
      • FullLoadStartDate
      • StartDate
      • StopDate
      • TablesErrored
      • TablesLoaded
      • TablesLoading
      • TablesQueued
    • SourceEndpointArn
    • Status
    • StopReason
    • TableMappings
    • TargetEndpointArn
    • TargetReplicationInstanceArn
    • TaskData

StartReplicationTaskAssessmentRunMessage

• StartReplicationTaskAssessmentRunMessage object:
  • AssessmentRunName required
  • Exclude
    • items String
  • IncludeOnly
    • items String
  • ReplicationTaskArn required
  • ResultEncryptionMode
  • ResultKmsKeyArn
  • ResultLocationBucket required
  • ResultLocationFolder
  • ServiceAccessRoleArn required

StartReplicationTaskAssessmentRunResponse

• StartReplicationTaskAssessmentRunResponse object:
  • ReplicationTaskAssessmentRun
    • AssessmentProgress
      • IndividualAssessmentCompletedCount
      • IndividualAssessmentCount
    • AssessmentRunName
    • LastFailureMessage
    • ReplicationTaskArn
    • ReplicationTaskAssessmentRunArn
    • ReplicationTaskAssessmentRunCreationDate
    • ResultEncryptionMode
    • ResultKmsKeyArn
    • ResultLocationBucket
    • ResultLocationFolder
    • ServiceAccessRoleArn
    • Status

StartReplicationTaskMessage

• StartReplicationTaskMessage object:
  • CdcStartPosition
  • CdcStartTime
  • CdcStopPosition
  • ReplicationTaskArn required
  • StartReplicationTaskType required

StartReplicationTaskResponse

• StartReplicationTaskResponse object:
  • ReplicationTask
    • CdcStartPosition
    • CdcStopPosition
    • LastFailureMessage
    • MigrationType
    • RecoveryCheckpoint
    • ReplicationInstanceArn
    • ReplicationTaskArn
    • ReplicationTaskCreationDate
    • ReplicationTaskIdentifier
    • ReplicationTaskSettings
    • ReplicationTaskStartDate
    • ReplicationTaskStats
      • ElapsedTimeMillis
      • FreshStartDate
      • FullLoadFinishDate
      • FullLoadProgressPercent
      • FullLoadStartDate
      • StartDate
      • StopDate
      • TablesErrored
      • TablesLoaded
      • TablesLoading
      • TablesQueued
    • SourceEndpointArn
    • Status
    • StopReason
    • TableMappings
    • TargetEndpointArn
    • TargetReplicationInstanceArn
    • TaskData

StartReplicationTaskTypeValue

• StartReplicationTaskTypeValue string (values: start-replication, resume-processing, reload-target)

StopReplicationTaskMessage

• StopReplicationTaskMessage object:
  • ReplicationTaskArn required

StopReplicationTaskResponse

• StopReplicationTaskResponse object:
  • ReplicationTask
    • CdcStartPosition
    • CdcStopPosition
    • LastFailureMessage
    • MigrationType
    • RecoveryCheckpoint
    • ReplicationInstanceArn
    • ReplicationTaskArn
    • ReplicationTaskCreationDate
    • ReplicationTaskIdentifier
    • ReplicationTaskSettings
    • ReplicationTaskStartDate
    • ReplicationTaskStats
      • ElapsedTimeMillis
      • FreshStartDate
      • FullLoadFinishDate
      • FullLoadProgressPercent
      • FullLoadStartDate
      • StartDate
      • StopDate
      • TablesErrored
      • TablesLoaded
      • TablesLoading
      • TablesQueued
    • SourceEndpointArn
    • Status
    • StopReason
    • TableMappings
    • TargetEndpointArn
    • TargetReplicationInstanceArn
    • TaskData

StorageQuotaExceededFault

String

• String string

Subnet

• Subnet object: In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
  • SubnetAvailabilityZone
    • Name
  • SubnetIdentifier
  • SubnetStatus

SubnetAlreadyInUse

SubnetIdentifierList

• SubnetIdentifierList array
  • items String

SubnetList

• SubnetList array
  • items Subnet

SupportedEndpointType

• SupportedEndpointType object: Provides information about types of supported endpoints in response to a request by the DescribeEndpointTypes operation. This information includes the type of endpoint, the database engine name, and whether change data capture (CDC) is supported.
  • EndpointType
  • EngineDisplayName
  • EngineName
  • ReplicationInstanceEngineMinimumVersion
  • SupportsCDC

SupportedEndpointTypeList

• SupportedEndpointTypeList array
  • items SupportedEndpointType

SybaseSettings

• SybaseSettings object: Provides information that defines a SAP ASE endpoint.
  • DatabaseName
  • Password
  • Port
  • ServerName
  • Username

TStamp

• TStamp string

TableListToReload

• TableListToReload array
  • items TableToReload

TableStatistics

• TableStatistics object: Provides a collection of table statistics in response to a request by the DescribeTableStatistics operation.
  • Ddls
  • Deletes
  • FullLoadCondtnlChkFailedRows
  • FullLoadEndTime
  • FullLoadErrorRows
  • FullLoadReloaded
  • FullLoadRows
  • FullLoadStartTime
  • Inserts
  • LastUpdateTime
  • SchemaName
  • TableName
  • TableState
  • Updates
  • ValidationFailedRecords
  • ValidationPendingRecords
  • ValidationState
  • ValidationStateDetails
  • ValidationSuspendedRecords

TableStatisticsList

• TableStatisticsList array
  • items TableStatistics

TableToReload

• TableToReload object: Provides the name of the schema and table to be reloaded.
  • SchemaName required
  • TableName required

Tag

• Tag object:

  A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:

  • AddTagsToResource

  • ListTagsForResource

  • RemoveTagsFromResource

  • Key
  • Value

TagList

• TagList array
  • items Tag

TargetDbType

• TargetDbType string (values: specific-database, multiple-databases)

TestConnectionMessage

• TestConnectionMessage object:
  • EndpointArn required
  • ReplicationInstanceArn required

TestConnectionResponse

• TestConnectionResponse object:
  • Connection
    • EndpointArn
    • EndpointIdentifier
    • LastFailureMessage
    • ReplicationInstanceArn
    • ReplicationInstanceIdentifier
    • Status

UpgradeDependencyFailureFault

VpcSecurityGroupIdList

• VpcSecurityGroupIdList array
  • items String

VpcSecurityGroupMembership

• VpcSecurityGroupMembership object: Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
  • Status
  • VpcSecurityGroupId

VpcSecurityGroupMembershipList

• VpcSecurityGroupMembershipList array
  • items VpcSecurityGroupMembership