@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: ""
});

amazonaws_dms.AddTagsToResource({
  "ResourceArn": "",
  "Tags": []
}).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 the AWS DMS user guide at What Is AWS Database Migration Service?

Actions

AddTagsToResource

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

Input

• input object
  • ResourceArn required String
  • Tags required TagList

Output

• output AddTagsToResourceResponse

CreateEndpoint

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

Input

• input object
  • CertificateArn String
  • DatabaseName String
  • DynamoDbSettings DynamoDbSettings
  • EndpointIdentifier required String
  • EndpointType required ReplicationEndpointTypeValue
  • EngineName required String
  • ExtraConnectionAttributes String
  • KmsKeyId String
  • MongoDbSettings MongoDbSettings
  • Password SecretString
  • Port IntegerOptional
  • S3Settings S3Settings
  • ServerName String
  • SslMode DmsSslModeValue
  • Tags TagList
  • Username String

Output

• output CreateEndpointResponse

CreateEventSubscription

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

Input

• input object
  • Enabled BooleanOptional
  • EventCategories EventCategoriesList
  • SnsTopicArn required String
  • SourceIds SourceIdsList
  • SourceType String
  • SubscriptionName required String
  • Tags TagList

Output

• output CreateEventSubscriptionResponse

CreateReplicationInstance

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

Input

• input object
  • AllocatedStorage IntegerOptional
  • AutoMinorVersionUpgrade BooleanOptional
  • AvailabilityZone String
  • EngineVersion String
  • KmsKeyId String
  • MultiAZ BooleanOptional
  • PreferredMaintenanceWindow String
  • PubliclyAccessible BooleanOptional
  • ReplicationInstanceClass required String
  • ReplicationInstanceIdentifier required String
  • ReplicationSubnetGroupIdentifier String
  • Tags TagList
  • VpcSecurityGroupIds VpcSecurityGroupIdList

Output

• output CreateReplicationInstanceResponse

CreateReplicationSubnetGroup

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

Input

• input object
  • ReplicationSubnetGroupDescription required String
  • ReplicationSubnetGroupIdentifier required String
  • SubnetIds required SubnetIdentifierList
  • Tags TagList

Output

• output CreateReplicationSubnetGroupResponse

CreateReplicationTask

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

Input

• input object
  • CdcStartTime TStamp
  • MigrationType required MigrationTypeValue
  • ReplicationInstanceArn required String
  • ReplicationTaskIdentifier required String
  • ReplicationTaskSettings String
  • SourceEndpointArn required String
  • TableMappings required String
  • Tags TagList
  • TargetEndpointArn required String

Output

• output CreateReplicationTaskResponse

DeleteCertificate

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

Input

• input object
  • CertificateArn required String

Output

• output DeleteCertificateResponse

DeleteEndpoint

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

Input

• input object
  • EndpointArn required String

Output

• output DeleteEndpointResponse

DeleteEventSubscription

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

Input

• input object
  • SubscriptionName required String

Output

• output DeleteEventSubscriptionResponse

DeleteReplicationInstance

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

Input

• input object
  • ReplicationInstanceArn required String

Output

• output DeleteReplicationInstanceResponse

DeleteReplicationSubnetGroup

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

Input

• input object
  • ReplicationSubnetGroupIdentifier required String

Output

• output DeleteReplicationSubnetGroupResponse

DeleteReplicationTask

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

Input

• input object
  • ReplicationTaskArn required String

Output

• output DeleteReplicationTaskResponse

DescribeAccountAttributes

amazonaws_dms.DescribeAccountAttributes({}, context)

Input

• input object

Output

• output DescribeAccountAttributesResponse

DescribeCertificates

amazonaws_dms.DescribeCertificates({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

Output

• output DescribeCertificatesResponse

DescribeConnections

amazonaws_dms.DescribeConnections({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

Output

• output DescribeConnectionsResponse

DescribeEndpointTypes

amazonaws_dms.DescribeEndpointTypes({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

Output

• output DescribeEndpointTypesResponse

DescribeEndpoints

amazonaws_dms.DescribeEndpoints({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

Output

• output DescribeEndpointsResponse

DescribeEventCategories

amazonaws_dms.DescribeEventCategories({}, context)

Input

• input object
  • Filters FilterList
  • SourceType String

Output

• output DescribeEventCategoriesResponse

DescribeEventSubscriptions

amazonaws_dms.DescribeEventSubscriptions({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional
  • SubscriptionName String

Output

• output DescribeEventSubscriptionsResponse

DescribeEvents

amazonaws_dms.DescribeEvents({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Duration IntegerOptional
  • EndTime TStamp
  • EventCategories EventCategoriesList
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional
  • SourceIdentifier String
  • SourceType SourceType
  • StartTime TStamp

Output

• output DescribeEventsResponse

DescribeOrderableReplicationInstances

amazonaws_dms.DescribeOrderableReplicationInstances({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Marker String
  • MaxRecords IntegerOptional

Output

• output DescribeOrderableReplicationInstancesResponse

DescribeRefreshSchemasStatus

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

Input

• input object
  • EndpointArn required String

Output

• output DescribeRefreshSchemasStatusResponse

DescribeReplicationInstanceTaskLogs

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

Input

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

Output

• output DescribeReplicationInstanceTaskLogsResponse

DescribeReplicationInstances

amazonaws_dms.DescribeReplicationInstances({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

Output

• output DescribeReplicationInstancesResponse

DescribeReplicationSubnetGroups

amazonaws_dms.DescribeReplicationSubnetGroups({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

Output

• output DescribeReplicationSubnetGroupsResponse

DescribeReplicationTaskAssessmentResults

amazonaws_dms.DescribeReplicationTaskAssessmentResults({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Marker String
  • MaxRecords IntegerOptional
  • ReplicationTaskArn String

Output

• output DescribeReplicationTaskAssessmentResultsResponse

DescribeReplicationTasks

amazonaws_dms.DescribeReplicationTasks({}, context)

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

Output

• output DescribeReplicationTasksResponse

DescribeSchemas

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

Input

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

Output

• output DescribeSchemasResponse

DescribeTableStatistics

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

Input

• input object
  • MaxRecords string
  • Marker string
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional
  • ReplicationTaskArn required String

Output

• output DescribeTableStatisticsResponse

ImportCertificate

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

Input

• input object
  • CertificateIdentifier required String
  • CertificatePem String
  • CertificateWallet CertificateWallet
  • Tags TagList

Output

• output ImportCertificateResponse

ListTagsForResource

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

Input

• input object
  • ResourceArn required String

Output

• output ListTagsForResourceResponse

ModifyEndpoint

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

Input

• input object
  • CertificateArn String
  • DatabaseName String
  • DynamoDbSettings DynamoDbSettings
  • EndpointArn required String
  • EndpointIdentifier String
  • EndpointType ReplicationEndpointTypeValue
  • EngineName String
  • ExtraConnectionAttributes String
  • MongoDbSettings MongoDbSettings
  • Password SecretString
  • Port IntegerOptional
  • S3Settings S3Settings
  • ServerName String
  • SslMode DmsSslModeValue
  • Username String

Output

• output ModifyEndpointResponse

ModifyEventSubscription

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

Input

• input object
  • Enabled BooleanOptional
  • EventCategories EventCategoriesList
  • SnsTopicArn String
  • SourceType String
  • SubscriptionName required String

Output

• output ModifyEventSubscriptionResponse

ModifyReplicationInstance

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

Input

• input object
  • AllocatedStorage IntegerOptional
  • AllowMajorVersionUpgrade Boolean
  • ApplyImmediately Boolean
  • AutoMinorVersionUpgrade BooleanOptional
  • EngineVersion String
  • MultiAZ BooleanOptional
  • PreferredMaintenanceWindow String
  • ReplicationInstanceArn required String
  • ReplicationInstanceClass String
  • ReplicationInstanceIdentifier String
  • VpcSecurityGroupIds VpcSecurityGroupIdList

Output

• output ModifyReplicationInstanceResponse

ModifyReplicationSubnetGroup

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

Input

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

Output

• output ModifyReplicationSubnetGroupResponse

ModifyReplicationTask

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

Input

• input object
  • CdcStartTime TStamp
  • MigrationType MigrationTypeValue
  • ReplicationTaskArn required String
  • ReplicationTaskIdentifier String
  • ReplicationTaskSettings String
  • TableMappings String

Output

• output ModifyReplicationTaskResponse

RebootReplicationInstance

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

Input

• input object
  • ForceFailover BooleanOptional
  • ReplicationInstanceArn required String

Output

• output RebootReplicationInstanceResponse

RefreshSchemas

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

Input

• input object
  • EndpointArn required String
  • ReplicationInstanceArn required String

Output

• output RefreshSchemasResponse

ReloadTables

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

Input

• input object
  • ReplicationTaskArn required String
  • TablesToReload required TableListToReload

Output

• output ReloadTablesResponse

RemoveTagsFromResource

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

Input

• input object
  • ResourceArn required String
  • TagKeys required KeyList

Output

• output RemoveTagsFromResourceResponse

StartReplicationTask

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

Input

• input object
  • CdcStartTime TStamp
  • ReplicationTaskArn required String
  • StartReplicationTaskType required StartReplicationTaskTypeValue

Output

• output StartReplicationTaskResponse

StartReplicationTaskAssessment

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

Input

• input object
  • ReplicationTaskArn required String

Output

• output StartReplicationTaskAssessmentResponse

StopReplicationTask

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

Input

• input object
  • ReplicationTaskArn required String

Output

• output StopReplicationTaskResponse

TestConnection

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

Input

• input object
  • EndpointArn required String
  • ReplicationInstanceArn required String

Output

• output TestConnectionResponse

Definitions

AccessDeniedFault

• AccessDeniedFault object: AWS DMS was denied access to the endpoint.
  • message ExceptionMessage

AccountQuota

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

AccountQuotaList

• AccountQuotaList array
  • items AccountQuota

AddTagsToResourceMessage

• AddTagsToResourceMessage object:
  • ResourceArn required String
  • Tags required TagList

AddTagsToResourceResponse

• AddTagsToResourceResponse object:

AuthMechanismValue

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

AuthTypeValue

• AuthTypeValue string (values: no, password)

AvailabilityZone

• AvailabilityZone object:
  • Name String

Boolean

• Boolean boolean

BooleanOptional

• BooleanOptional boolean

Certificate

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

CertificateList

• CertificateList array
  • items Certificate

CertificateWallet

• CertificateWallet string

CompressionTypeValue

• CompressionTypeValue string (values: none, gzip)

Connection

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

ConnectionList

• ConnectionList array
  • items Connection

CreateEndpointMessage

• CreateEndpointMessage object:
  • CertificateArn String
  • DatabaseName String
  • DynamoDbSettings DynamoDbSettings
  • EndpointIdentifier required String
  • EndpointType required ReplicationEndpointTypeValue
  • EngineName required String
  • ExtraConnectionAttributes String
  • KmsKeyId String
  • MongoDbSettings MongoDbSettings
  • Password SecretString
  • Port IntegerOptional
  • S3Settings S3Settings
  • ServerName String
  • SslMode DmsSslModeValue
  • Tags TagList
  • Username String

CreateEndpointResponse

• CreateEndpointResponse object:
  • Endpoint Endpoint

CreateEventSubscriptionMessage

• CreateEventSubscriptionMessage object:
  • Enabled BooleanOptional
  • EventCategories EventCategoriesList
  • SnsTopicArn required String
  • SourceIds SourceIdsList
  • SourceType String
  • SubscriptionName required String
  • Tags TagList

CreateEventSubscriptionResponse

• CreateEventSubscriptionResponse object:
  • EventSubscription EventSubscription

CreateReplicationInstanceMessage

• CreateReplicationInstanceMessage object:
  • AllocatedStorage IntegerOptional
  • AutoMinorVersionUpgrade BooleanOptional
  • AvailabilityZone String
  • EngineVersion String
  • KmsKeyId String
  • MultiAZ BooleanOptional
  • PreferredMaintenanceWindow String
  • PubliclyAccessible BooleanOptional
  • ReplicationInstanceClass required String
  • ReplicationInstanceIdentifier required String
  • ReplicationSubnetGroupIdentifier String
  • Tags TagList
  • VpcSecurityGroupIds VpcSecurityGroupIdList

CreateReplicationInstanceResponse

• CreateReplicationInstanceResponse object:
  • ReplicationInstance ReplicationInstance

CreateReplicationSubnetGroupMessage

• CreateReplicationSubnetGroupMessage object:
  • ReplicationSubnetGroupDescription required String
  • ReplicationSubnetGroupIdentifier required String
  • SubnetIds required SubnetIdentifierList
  • Tags TagList

CreateReplicationSubnetGroupResponse

• CreateReplicationSubnetGroupResponse object:
  • ReplicationSubnetGroup ReplicationSubnetGroup

CreateReplicationTaskMessage

• CreateReplicationTaskMessage object:
  • CdcStartTime TStamp
  • MigrationType required MigrationTypeValue
  • ReplicationInstanceArn required String
  • ReplicationTaskIdentifier required String
  • ReplicationTaskSettings String
  • SourceEndpointArn required String
  • TableMappings required String
  • Tags TagList
  • TargetEndpointArn required String

CreateReplicationTaskResponse

• CreateReplicationTaskResponse object:
  • ReplicationTask ReplicationTask

DeleteCertificateMessage

• DeleteCertificateMessage object
  • CertificateArn required String

DeleteCertificateResponse

• DeleteCertificateResponse object
  • Certificate Certificate

DeleteEndpointMessage

• DeleteEndpointMessage object:
  • EndpointArn required String

DeleteEndpointResponse

• DeleteEndpointResponse object:
  • Endpoint Endpoint

DeleteEventSubscriptionMessage

• DeleteEventSubscriptionMessage object:
  • SubscriptionName required String

DeleteEventSubscriptionResponse

• DeleteEventSubscriptionResponse object:
  • EventSubscription EventSubscription

DeleteReplicationInstanceMessage

• DeleteReplicationInstanceMessage object:
  • ReplicationInstanceArn required String

DeleteReplicationInstanceResponse

• DeleteReplicationInstanceResponse object:
  • ReplicationInstance ReplicationInstance

DeleteReplicationSubnetGroupMessage

• DeleteReplicationSubnetGroupMessage object:
  • ReplicationSubnetGroupIdentifier required String

DeleteReplicationSubnetGroupResponse

• DeleteReplicationSubnetGroupResponse object:

DeleteReplicationTaskMessage

• DeleteReplicationTaskMessage object:
  • ReplicationTaskArn required String

DeleteReplicationTaskResponse

• DeleteReplicationTaskResponse object:
  • ReplicationTask ReplicationTask

DescribeAccountAttributesMessage

• DescribeAccountAttributesMessage object:

DescribeAccountAttributesResponse

• DescribeAccountAttributesResponse object:
  • AccountQuotas AccountQuotaList

DescribeCertificatesMessage

• DescribeCertificatesMessage object
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

DescribeCertificatesResponse

• DescribeCertificatesResponse object
  • Certificates CertificateList
  • Marker String

DescribeConnectionsMessage

• DescribeConnectionsMessage object:
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

DescribeConnectionsResponse

• DescribeConnectionsResponse object:
  • Connections ConnectionList
  • Marker String

DescribeEndpointTypesMessage

• DescribeEndpointTypesMessage object:
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

DescribeEndpointTypesResponse

• DescribeEndpointTypesResponse object:
  • Marker String
  • SupportedEndpointTypes SupportedEndpointTypeList

DescribeEndpointsMessage

• DescribeEndpointsMessage object:
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

DescribeEndpointsResponse

• DescribeEndpointsResponse object:
  • Endpoints EndpointList
  • Marker String

DescribeEventCategoriesMessage

• DescribeEventCategoriesMessage object:
  • Filters FilterList
  • SourceType String

DescribeEventCategoriesResponse

• DescribeEventCategoriesResponse object:
  • EventCategoryGroupList EventCategoryGroupList

DescribeEventSubscriptionsMessage

• DescribeEventSubscriptionsMessage object:
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional
  • SubscriptionName String

DescribeEventSubscriptionsResponse

• DescribeEventSubscriptionsResponse object:
  • EventSubscriptionsList EventSubscriptionsList
  • Marker String

DescribeEventsMessage

• DescribeEventsMessage object:
  • Duration IntegerOptional
  • EndTime TStamp
  • EventCategories EventCategoriesList
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional
  • SourceIdentifier String
  • SourceType SourceType
  • StartTime TStamp

DescribeEventsResponse

• DescribeEventsResponse object:
  • Events EventList
  • Marker String

DescribeOrderableReplicationInstancesMessage

• DescribeOrderableReplicationInstancesMessage object:
  • Marker String
  • MaxRecords IntegerOptional

DescribeOrderableReplicationInstancesResponse

• DescribeOrderableReplicationInstancesResponse object:
  • Marker String
  • OrderableReplicationInstances OrderableReplicationInstanceList

DescribeRefreshSchemasStatusMessage

• DescribeRefreshSchemasStatusMessage object:
  • EndpointArn required String

DescribeRefreshSchemasStatusResponse

• DescribeRefreshSchemasStatusResponse object:
  • RefreshSchemasStatus RefreshSchemasStatus

DescribeReplicationInstanceTaskLogsMessage

• DescribeReplicationInstanceTaskLogsMessage object
  • Marker String
  • MaxRecords IntegerOptional
  • ReplicationInstanceArn required String

DescribeReplicationInstanceTaskLogsResponse

• DescribeReplicationInstanceTaskLogsResponse object
  • Marker String
  • ReplicationInstanceArn String
  • ReplicationInstanceTaskLogs ReplicationInstanceTaskLogsList

DescribeReplicationInstancesMessage

• DescribeReplicationInstancesMessage object:
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

DescribeReplicationInstancesResponse

• DescribeReplicationInstancesResponse object:
  • Marker String
  • ReplicationInstances ReplicationInstanceList

DescribeReplicationSubnetGroupsMessage

• DescribeReplicationSubnetGroupsMessage object:
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

DescribeReplicationSubnetGroupsResponse

• DescribeReplicationSubnetGroupsResponse object:
  • Marker String
  • ReplicationSubnetGroups ReplicationSubnetGroups

DescribeReplicationTaskAssessmentResultsMessage

• DescribeReplicationTaskAssessmentResultsMessage object:
  • Marker String
  • MaxRecords IntegerOptional
  • ReplicationTaskArn String

DescribeReplicationTaskAssessmentResultsResponse

• DescribeReplicationTaskAssessmentResultsResponse object:
  • BucketName String
  • Marker String
  • ReplicationTaskAssessmentResults ReplicationTaskAssessmentResultList

DescribeReplicationTasksMessage

• DescribeReplicationTasksMessage object:
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional

DescribeReplicationTasksResponse

• DescribeReplicationTasksResponse object:
  • Marker String
  • ReplicationTasks ReplicationTaskList

DescribeSchemasMessage

• DescribeSchemasMessage object:
  • EndpointArn required String
  • Marker String
  • MaxRecords IntegerOptional

DescribeSchemasResponse

• DescribeSchemasResponse object:
  • Marker String
  • Schemas SchemaList

DescribeTableStatisticsMessage

• DescribeTableStatisticsMessage object:
  • Filters FilterList
  • Marker String
  • MaxRecords IntegerOptional
  • ReplicationTaskArn required String

DescribeTableStatisticsResponse

• DescribeTableStatisticsResponse object:
  • Marker String
  • ReplicationTaskArn String
  • TableStatistics TableStatisticsList

DmsSslModeValue

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

DynamoDbSettings

• DynamoDbSettings object:
  • ServiceAccessRoleArn required String

Endpoint

• Endpoint object:
  • CertificateArn String
  • DatabaseName String
  • DynamoDbSettings DynamoDbSettings
  • EndpointArn String
  • EndpointIdentifier String
  • EndpointType ReplicationEndpointTypeValue
  • EngineName String
  • ExternalId String
  • ExtraConnectionAttributes String
  • KmsKeyId String
  • MongoDbSettings MongoDbSettings
  • Port IntegerOptional
  • S3Settings S3Settings
  • ServerName String
  • SslMode DmsSslModeValue
  • Status String
  • Username String

EndpointList

• EndpointList array
  • items Endpoint

Event

• Event object:
  • Date TStamp
  • EventCategories EventCategoriesList
  • Message String
  • SourceIdentifier String
  • SourceType SourceType

EventCategoriesList

• EventCategoriesList array
  • items String

EventCategoryGroup

• EventCategoryGroup object:
  • EventCategories EventCategoriesList
  • SourceType String

EventCategoryGroupList

• EventCategoryGroupList array
  • items EventCategoryGroup

EventList

• EventList array
  • items Event

EventSubscription

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

EventSubscriptionsList

• EventSubscriptionsList array
  • items EventSubscription

ExceptionMessage

• ExceptionMessage string

Filter

• Filter object:
  • Name required String
  • Values required FilterValueList

FilterList

• FilterList array
  • items Filter

FilterValueList

• FilterValueList array
  • items String

ImportCertificateMessage

• ImportCertificateMessage object
  • CertificateIdentifier required String
  • CertificatePem String
  • CertificateWallet CertificateWallet
  • Tags TagList

ImportCertificateResponse

• ImportCertificateResponse object
  • Certificate Certificate

InsufficientResourceCapacityFault

• InsufficientResourceCapacityFault object: There are not enough resources allocated to the database migration.
  • message ExceptionMessage

Integer

• Integer integer

IntegerOptional

• IntegerOptional integer

InvalidCertificateFault

• InvalidCertificateFault object: The certificate was not valid.
  • message ExceptionMessage

InvalidResourceStateFault

• InvalidResourceStateFault object: The resource is in a state that prevents it from being used for database migration.
  • message ExceptionMessage

InvalidSubnet

• InvalidSubnet object: The subnet provided is invalid.
  • message ExceptionMessage

KMSKeyNotAccessibleFault

• KMSKeyNotAccessibleFault object: AWS DMS cannot access the KMS key.
  • message ExceptionMessage

KeyList

• KeyList array
  • items String

ListTagsForResourceMessage

• ListTagsForResourceMessage object:
  • ResourceArn required String

ListTagsForResourceResponse

• ListTagsForResourceResponse object:
  • TagList TagList

Long

• Long integer

MigrationTypeValue

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

ModifyEndpointMessage

• ModifyEndpointMessage object:
  • CertificateArn String
  • DatabaseName String
  • DynamoDbSettings DynamoDbSettings
  • EndpointArn required String
  • EndpointIdentifier String
  • EndpointType ReplicationEndpointTypeValue
  • EngineName String
  • ExtraConnectionAttributes String
  • MongoDbSettings MongoDbSettings
  • Password SecretString
  • Port IntegerOptional
  • S3Settings S3Settings
  • ServerName String
  • SslMode DmsSslModeValue
  • Username String

ModifyEndpointResponse

• ModifyEndpointResponse object:
  • Endpoint Endpoint

ModifyEventSubscriptionMessage

• ModifyEventSubscriptionMessage object:
  • Enabled BooleanOptional
  • EventCategories EventCategoriesList
  • SnsTopicArn String
  • SourceType String
  • SubscriptionName required String

ModifyEventSubscriptionResponse

• ModifyEventSubscriptionResponse object:
  • EventSubscription EventSubscription

ModifyReplicationInstanceMessage

• ModifyReplicationInstanceMessage object:
  • AllocatedStorage IntegerOptional
  • AllowMajorVersionUpgrade Boolean
  • ApplyImmediately Boolean
  • AutoMinorVersionUpgrade BooleanOptional
  • EngineVersion String
  • MultiAZ BooleanOptional
  • PreferredMaintenanceWindow String
  • ReplicationInstanceArn required String
  • ReplicationInstanceClass String
  • ReplicationInstanceIdentifier String
  • VpcSecurityGroupIds VpcSecurityGroupIdList

ModifyReplicationInstanceResponse

• ModifyReplicationInstanceResponse object:
  • ReplicationInstance ReplicationInstance

ModifyReplicationSubnetGroupMessage

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

ModifyReplicationSubnetGroupResponse

• ModifyReplicationSubnetGroupResponse object:
  • ReplicationSubnetGroup ReplicationSubnetGroup

ModifyReplicationTaskMessage

• ModifyReplicationTaskMessage object:
  • CdcStartTime TStamp
  • MigrationType MigrationTypeValue
  • ReplicationTaskArn required String
  • ReplicationTaskIdentifier String
  • ReplicationTaskSettings String
  • TableMappings String

ModifyReplicationTaskResponse

• ModifyReplicationTaskResponse object:
  • ReplicationTask ReplicationTask

MongoDbSettings

• MongoDbSettings object:
  • AuthMechanism AuthMechanismValue
  • AuthSource String
  • AuthType AuthTypeValue
  • DatabaseName String
  • DocsToInvestigate String
  • ExtractDocId String
  • NestingLevel NestingLevelValue
  • Password SecretString
  • Port IntegerOptional
  • ServerName String
  • Username String

NestingLevelValue

• NestingLevelValue string (values: none, one)

OrderableReplicationInstance

• OrderableReplicationInstance object:
  • DefaultAllocatedStorage Integer
  • EngineVersion String
  • IncludedAllocatedStorage Integer
  • MaxAllocatedStorage Integer
  • MinAllocatedStorage Integer
  • ReplicationInstanceClass String
  • StorageType String

OrderableReplicationInstanceList

• OrderableReplicationInstanceList array
  • items OrderableReplicationInstance

RebootReplicationInstanceMessage

• RebootReplicationInstanceMessage object
  • ForceFailover BooleanOptional
  • ReplicationInstanceArn required String

RebootReplicationInstanceResponse

• RebootReplicationInstanceResponse object
  • ReplicationInstance ReplicationInstance

RefreshSchemasMessage

• RefreshSchemasMessage object:
  • EndpointArn required String
  • ReplicationInstanceArn required String

RefreshSchemasResponse

• RefreshSchemasResponse object:
  • RefreshSchemasStatus RefreshSchemasStatus

RefreshSchemasStatus

• RefreshSchemasStatus object:
  • EndpointArn String
  • LastFailureMessage String
  • LastRefreshDate TStamp
  • ReplicationInstanceArn String
  • Status RefreshSchemasStatusTypeValue

RefreshSchemasStatusTypeValue

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

ReloadTablesMessage

• ReloadTablesMessage object
  • ReplicationTaskArn required String
  • TablesToReload required TableListToReload

ReloadTablesResponse

• ReloadTablesResponse object
  • ReplicationTaskArn String

RemoveTagsFromResourceMessage

• RemoveTagsFromResourceMessage object:
  • ResourceArn required String
  • TagKeys required KeyList

RemoveTagsFromResourceResponse

• RemoveTagsFromResourceResponse object:

ReplicationEndpointTypeValue

• ReplicationEndpointTypeValue string (values: source, target)

ReplicationInstance

• ReplicationInstance object:
  • AllocatedStorage Integer
  • AutoMinorVersionUpgrade Boolean
  • AvailabilityZone String
  • EngineVersion String
  • InstanceCreateTime TStamp
  • KmsKeyId String
  • MultiAZ Boolean
  • PendingModifiedValues ReplicationPendingModifiedValues
  • PreferredMaintenanceWindow String
  • PubliclyAccessible Boolean
  • ReplicationInstanceArn String
  • ReplicationInstanceClass String
  • ReplicationInstanceIdentifier String
  • ReplicationInstancePrivateIpAddress String
  • ReplicationInstancePrivateIpAddresses ReplicationInstancePrivateIpAddressList
  • ReplicationInstancePublicIpAddress String
  • ReplicationInstancePublicIpAddresses ReplicationInstancePublicIpAddressList
  • ReplicationInstanceStatus String
  • ReplicationSubnetGroup ReplicationSubnetGroup
  • SecondaryAvailabilityZone String
  • VpcSecurityGroups VpcSecurityGroupMembershipList

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 Long
  • ReplicationTaskArn String
  • ReplicationTaskName String

ReplicationInstanceTaskLogsList

• ReplicationInstanceTaskLogsList array
  • items ReplicationInstanceTaskLog

ReplicationPendingModifiedValues

• ReplicationPendingModifiedValues object:
  • AllocatedStorage IntegerOptional
  • EngineVersion String
  • MultiAZ BooleanOptional
  • ReplicationInstanceClass String

ReplicationSubnetGroup

• ReplicationSubnetGroup object:
  • ReplicationSubnetGroupDescription String
  • ReplicationSubnetGroupIdentifier String
  • SubnetGroupStatus String
  • Subnets SubnetList
  • VpcId String

ReplicationSubnetGroupDoesNotCoverEnoughAZs

• ReplicationSubnetGroupDoesNotCoverEnoughAZs object: The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
  • message ExceptionMessage

ReplicationSubnetGroups

• ReplicationSubnetGroups array
  • items ReplicationSubnetGroup

ReplicationTask

• ReplicationTask object:
  • LastFailureMessage String
  • MigrationType MigrationTypeValue
  • ReplicationInstanceArn String
  • ReplicationTaskArn String
  • ReplicationTaskCreationDate TStamp
  • ReplicationTaskIdentifier String
  • ReplicationTaskSettings String
  • ReplicationTaskStartDate TStamp
  • ReplicationTaskStats ReplicationTaskStats
  • SourceEndpointArn String
  • Status String
  • StopReason String
  • TableMappings String
  • TargetEndpointArn String

ReplicationTaskAssessmentResult

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

ReplicationTaskAssessmentResultList

• ReplicationTaskAssessmentResultList array
  • items ReplicationTaskAssessmentResult

ReplicationTaskList

• ReplicationTaskList array
  • items ReplicationTask

ReplicationTaskStats

• ReplicationTaskStats object:
  • ElapsedTimeMillis Long
  • FullLoadProgressPercent Integer
  • TablesErrored Integer
  • TablesLoaded Integer
  • TablesLoading Integer
  • TablesQueued Integer

ResourceAlreadyExistsFault

• ResourceAlreadyExistsFault object: The resource you are attempting to create already exists.
  • message ExceptionMessage

ResourceNotFoundFault

• ResourceNotFoundFault object: The resource could not be found.
  • message ExceptionMessage

ResourceQuotaExceededFault

• ResourceQuotaExceededFault object: The quota for this resource quota has been exceeded.
  • message ExceptionMessage

S3Settings

• S3Settings object:
  • BucketFolder String
  • BucketName String
  • CompressionType CompressionTypeValue
  • CsvDelimiter String
  • CsvRowDelimiter String
  • ExternalTableDefinition String
  • ServiceAccessRoleArn String

SNSInvalidTopicFault

• SNSInvalidTopicFault object: The SNS topic is invalid.
  • message ExceptionMessage

SNSNoAuthorizationFault

• SNSNoAuthorizationFault object: You are not authorized for the SNS subscription.
  • message ExceptionMessage

SchemaList

• SchemaList array
  • items String

SecretString

• SecretString string

SourceIdsList

• SourceIdsList array
  • items String

SourceType

• SourceType string (values: replication-instance)

StartReplicationTaskAssessmentMessage

• StartReplicationTaskAssessmentMessage object:
  • ReplicationTaskArn required String

StartReplicationTaskAssessmentResponse

• StartReplicationTaskAssessmentResponse object:
  • ReplicationTask ReplicationTask

StartReplicationTaskMessage

• StartReplicationTaskMessage object:
  • CdcStartTime TStamp
  • ReplicationTaskArn required String
  • StartReplicationTaskType required StartReplicationTaskTypeValue

StartReplicationTaskResponse

• StartReplicationTaskResponse object:
  • ReplicationTask ReplicationTask

StartReplicationTaskTypeValue

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

StopReplicationTaskMessage

• StopReplicationTaskMessage object:
  • ReplicationTaskArn required String

StopReplicationTaskResponse

• StopReplicationTaskResponse object:
  • ReplicationTask ReplicationTask

StorageQuotaExceededFault

• StorageQuotaExceededFault object: The storage quota has been exceeded.
  • message ExceptionMessage

String

• String string

Subnet

• Subnet object:
  • SubnetAvailabilityZone AvailabilityZone
  • SubnetIdentifier String
  • SubnetStatus String

SubnetAlreadyInUse

• SubnetAlreadyInUse object: The specified subnet is already in use.
  • message ExceptionMessage

SubnetIdentifierList

• SubnetIdentifierList array
  • items String

SubnetList

• SubnetList array
  • items Subnet

SupportedEndpointType

• SupportedEndpointType object:
  • EndpointType ReplicationEndpointTypeValue
  • EngineName String
  • SupportsCDC Boolean

SupportedEndpointTypeList

• SupportedEndpointTypeList array
  • items SupportedEndpointType

TStamp

• TStamp string

TableListToReload

• TableListToReload array
  • items TableToReload

TableStatistics

• TableStatistics object:
  • Ddls Long
  • Deletes Long
  • FullLoadCondtnlChkFailedRows Long
  • FullLoadErrorRows Long
  • FullLoadRows Long
  • Inserts Long
  • LastUpdateTime TStamp
  • SchemaName String
  • TableName String
  • TableState String
  • Updates Long
  • ValidationFailedRecords Long
  • ValidationPendingRecords Long
  • ValidationState String
  • ValidationSuspendedRecords Long

TableStatisticsList

• TableStatisticsList array
  • items TableStatistics

TableToReload

• TableToReload object:
  • SchemaName String
  • TableName String

Tag

• Tag object:
  • Key String
  • Value String

TagList

• TagList array
  • items Tag

TestConnectionMessage

• TestConnectionMessage object:
  • EndpointArn required String
  • ReplicationInstanceArn required String

TestConnectionResponse

• TestConnectionResponse object:
  • Connection Connection

UpgradeDependencyFailureFault

• UpgradeDependencyFailureFault object: An upgrade dependency is preventing the database migration.
  • message ExceptionMessage

VpcSecurityGroupIdList

• VpcSecurityGroupIdList array
  • items String

VpcSecurityGroupMembership

• VpcSecurityGroupMembership object:
  • Status String
  • VpcSecurityGroupId String

VpcSecurityGroupMembershipList

• VpcSecurityGroupMembershipList array
  • items VpcSecurityGroupMembership