AddTagsToResource

$result = $client->addTagsToResource([/* ... */]);
$promise = $client->addTagsToResourceAsync([/* ... */]);

Adds metadata tags to an DMS resource, including replication instance, endpoint, subnet group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS. For more information, see Tag data type description.

Parameter Syntax

$result = $client->addTagsToResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'ResourceArn' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

Examples

Example 1: Add tags to resource

Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with AWS DMS resources, or used in a Condition statement in an IAM policy for AWS DMS.

$result = $client->addTagsToResource([
    'ResourceArn' => 'arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E', // Required. Use the ARN of the resource you want to tag.
    'Tags' => [
        [
            'Key' => 'Acount',
            'Value' => '1633456',
        ],
    ], // Required. Use the Key/Value pair format.
]);

Result syntax:

[
]

ApplyPendingMaintenanceAction

$result = $client->applyPendingMaintenanceAction([/* ... */]);
$promise = $client->applyPendingMaintenanceActionAsync([/* ... */]);

Applies a pending maintenance action to a resource (for example, to a replication instance).

Parameter Syntax

$result = $client->applyPendingMaintenanceAction([
    'ApplyAction' => '<string>', // REQUIRED
    'OptInType' => '<string>', // REQUIRED
    'ReplicationInstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ResourcePendingMaintenanceActions' => [
        'PendingMaintenanceActionDetails' => [
            [
                'Action' => '<string>',
                'AutoAppliedAfterDate' => <DateTime>,
                'CurrentApplyDate' => <DateTime>,
                'Description' => '<string>',
                'ForcedApplyDate' => <DateTime>,
                'OptInStatus' => '<string>',
            ],
            // ...
        ],
        'ResourceIdentifier' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

BatchStartRecommendations

$result = $client->batchStartRecommendations([/* ... */]);
$promise = $client->batchStartRecommendationsAsync([/* ... */]);

End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

Starts the analysis of up to 20 source databases to recommend target engines for each source database. This is a batch version of StartRecommendations.

The result of analysis of each source database is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

Parameter Syntax

$result = $client->batchStartRecommendations([
    'Data' => [
        [
            'DatabaseId' => '<string>', // REQUIRED
            'Settings' => [ // REQUIRED
                'InstanceSizingType' => '<string>', // REQUIRED
                'WorkloadType' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ErrorEntries' => [
        [
            'Code' => '<string>',
            'DatabaseId' => '<string>',
            'Message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceNotFoundFault:

The resource could not be found.

CancelMetadataModelConversion

$result = $client->cancelMetadataModelConversion([/* ... */]);
$promise = $client->cancelMetadataModelConversionAsync([/* ... */]);

Cancels a single metadata model conversion operation that was started with StartMetadataModelConversion.

Required permissions: dms:CancelMetadataModelConversion. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameter Syntax

$result = $client->cancelMetadataModelConversion([
    'MigrationProjectIdentifier' => '<string>', // REQUIRED
    'RequestIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Request' => [
        'Error' => [
            'defaultErrorDetails' => [
                'Message' => '<string>',
            ],
        ],
        'ExportSqlDetails' => [
            'ObjectURL' => '<string>',
            'S3ObjectKey' => '<string>',
        ],
        'MigrationProjectArn' => '<string>',
        'Progress' => [
            'ProcessedObject' => [
                'EndpointType' => '<string>',
                'Name' => '<string>',
                'Type' => '<string>',
            ],
            'ProgressPercent' => <float>,
            'ProgressStep' => '<string>',
            'TotalObjects' => <integer>,
        ],
        'RequestIdentifier' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

Examples

Example 1: Cancel a metadata model conversion

The following example cancels a metadata model conversion operation.

$result = $client->cancelMetadataModelConversion([
    'MigrationProjectIdentifier' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
    'RequestIdentifier' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
]);

Result syntax:

[
    'Request' => [
        'MigrationProjectArn' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
        'RequestIdentifier' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
        'Status' => 'CANCELING',
    ],
]

CancelMetadataModelCreation

$result = $client->cancelMetadataModelCreation([/* ... */]);
$promise = $client->cancelMetadataModelCreationAsync([/* ... */]);

Cancels a single metadata model creation operation that was started with StartMetadataModelCreation.

Required permissions: dms:CancelMetadataModelCreation. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameter Syntax

$result = $client->cancelMetadataModelCreation([
    'MigrationProjectIdentifier' => '<string>', // REQUIRED
    'RequestIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Request' => [
        'Error' => [
            'defaultErrorDetails' => [
                'Message' => '<string>',
            ],
        ],
        'ExportSqlDetails' => [
            'ObjectURL' => '<string>',
            'S3ObjectKey' => '<string>',
        ],
        'MigrationProjectArn' => '<string>',
        'Progress' => [
            'ProcessedObject' => [
                'EndpointType' => '<string>',
                'Name' => '<string>',
                'Type' => '<string>',
            ],
            'ProgressPercent' => <float>,
            'ProgressStep' => '<string>',
            'TotalObjects' => <integer>,
        ],
        'RequestIdentifier' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

Examples

Example 1: Cancel a metadata model creation

The following example cancels a metadata model creation operation.

$result = $client->cancelMetadataModelCreation([
    'MigrationProjectIdentifier' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
    'RequestIdentifier' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
]);

Result syntax:

[
    'Request' => [
        'MigrationProjectArn' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
        'RequestIdentifier' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
        'Status' => 'CANCELING',
    ],
]

CancelReplicationTaskAssessmentRun

$result = $client->cancelReplicationTaskAssessmentRun([/* ... */]);
$promise = $client->cancelReplicationTaskAssessmentRunAsync([/* ... */]);

Cancels a single premigration assessment run.

This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.

Parameter Syntax

$result = $client->cancelReplicationTaskAssessmentRun([
    'ReplicationTaskAssessmentRunArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ReplicationTaskAssessmentRun' => [
        'AssessmentProgress' => [
            'IndividualAssessmentCompletedCount' => <integer>,
            'IndividualAssessmentCount' => <integer>,
        ],
        'AssessmentRunName' => '<string>',
        'IsLatestTaskAssessmentRun' => true || false,
        'LastFailureMessage' => '<string>',
        'ReplicationTaskArn' => '<string>',
        'ReplicationTaskAssessmentRunArn' => '<string>',
        'ReplicationTaskAssessmentRunCreationDate' => <DateTime>,
        'ResultEncryptionMode' => '<string>',
        'ResultKmsKeyArn' => '<string>',
        'ResultLocationBucket' => '<string>',
        'ResultLocationFolder' => '<string>',
        'ResultStatistic' => [
            'Cancelled' => <integer>,
            'Error' => <integer>,
            'Failed' => <integer>,
            'Passed' => <integer>,
            'Skipped' => <integer>,
            'Warning' => <integer>,
        ],
        'ServiceAccessRoleArn' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

CreateDataMigration

$result = $client->createDataMigration([/* ... */]);
$promise = $client->createDataMigrationAsync([/* ... */]);

Creates a data migration using the provided settings.

Parameter Syntax

$result = $client->createDataMigration([
    'DataMigrationName' => '<string>',
    'DataMigrationType' => 'full-load|cdc|full-load-and-cdc', // REQUIRED
    'EnableCloudwatchLogs' => true || false,
    'MigrationProjectIdentifier' => '<string>', // REQUIRED
    'NumberOfJobs' => <integer>,
    'SelectionRules' => '<string>',
    'ServiceAccessRoleArn' => '<string>', // REQUIRED
    'SourceDataSettings' => [
        [
            'CDCStartPosition' => '<string>',
            'CDCStartTime' => <integer || string || DateTime>,
            'CDCStopTime' => <integer || string || DateTime>,
            'SlotName' => '<string>',
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'ResourceArn' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetDataSettings' => [
        [
            'TablePreparationMode' => 'drop-tables-on-target|truncate|do-nothing',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DataMigration' => [
        'DataMigrationArn' => '<string>',
        'DataMigrationCidrBlocks' => ['<string>', ...],
        'DataMigrationCreateTime' => <DateTime>,
        'DataMigrationEndTime' => <DateTime>,
        'DataMigrationName' => '<string>',
        'DataMigrationSettings' => [
            'CloudwatchLogsEnabled' => true || false,
            'NumberOfJobs' => <integer>,
            'SelectionRules' => '<string>',
        ],
        'DataMigrationStartTime' => <DateTime>,
        'DataMigrationStatistics' => [
            'CDCLatency' => <integer>,
            'ElapsedTimeMillis' => <integer>,
            'FullLoadPercentage' => <integer>,
            'StartTime' => <DateTime>,
            'StopTime' => <DateTime>,
            'TablesErrored' => <integer>,
            'TablesLoaded' => <integer>,
            'TablesLoading' => <integer>,
            'TablesQueued' => <integer>,
        ],
        'DataMigrationStatus' => '<string>',
        'DataMigrationType' => 'full-load|cdc|full-load-and-cdc',
        'LastFailureMessage' => '<string>',
        'MigrationProjectArn' => '<string>',
        'PublicIpAddresses' => ['<string>', ...],
        'ServiceAccessRoleArn' => '<string>',
        'SourceDataSettings' => [
            [
                'CDCStartPosition' => '<string>',
                'CDCStartTime' => <DateTime>,
                'CDCStopTime' => <DateTime>,
                'SlotName' => '<string>',
            ],
            // ...
        ],
        'StopReason' => '<string>',
        'TargetDataSettings' => [
            [
                'TablePreparationMode' => 'drop-tables-on-target|truncate|do-nothing',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceQuotaExceededFault:

The quota for this resource quota has been exceeded.

ResourceNotFoundFault:

The resource could not be found.

ResourceAlreadyExistsFault:

The resource you are attempting to create already exists.

InvalidOperationFault:

The action or operation requested isn't valid.

FailedDependencyFault:

A dependency threw an exception.

CreateDataProvider

$result = $client->createDataProvider([/* ... */]);
$promise = $client->createDataProviderAsync([/* ... */]);

Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database.

Required permissions: dms:CreateDataProvider. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameter Syntax

$result = $client->createDataProvider([
    'DataProviderName' => '<string>',
    'Description' => '<string>',
    'Engine' => '<string>', // REQUIRED
    'Settings' => [ // REQUIRED
        'DocDbSettings' => [
            'CertificateArn' => '<string>',
            'DatabaseName' => '<string>',
            'Port' => <integer>,
            'ServerName' => '<string>',
            'SslMode' => 'none|require|verify-ca|verify-full',
        ],
        'IbmDb2LuwSettings' => [
            'CertificateArn' => '<string>',
            'DatabaseName' => '<string>',
            'EncryptionAlgorithm' => <integer>,
            'Port' => <integer>,
            'S3AccessRoleArn' => '<string>',
            'S3Path' => '<string>',
            'SecurityMechanism' => <integer>,
            'ServerName' => '<string>',
            'SslMode' => 'none|require|verify-ca|verify-full',
        ],
        'IbmDb2zOsSettings' => [
            'CertificateArn' => '<string>',
            'DatabaseName' => '<string>',
            'Port' => <integer>,
            'S3AccessRoleArn' => '<string>',
            'S3Path' => '<string>',
            'ServerName' => '<string>',
            'SslMode' => 'none|require|verify-ca|verify-full',
        ],
        'MariaDbSettings' => [
            'CertificateArn' => '<string>',
            'Port' => <integer>,
            'S3AccessRoleArn' => '<string>',
            'S3Path' => '<string>',
            'ServerName' => '<string>',
            'SslMode' => 'none|require|verify-ca|verify-full',
        ],
        'MicrosoftSqlServerSettings' => [
            'CertificateArn' => '<string>',
            'DatabaseName' => '<string>',
            'Port' => <integer>,
            'S3AccessRoleArn' => '<string>',
            'S3Path' => '<string>',
            'ServerName' => '<string>',
            'SslMode' => 'none|require|verify-ca|verify-full',
        ],
        'MongoDbSettings' => [
            'AuthMechanism' => 'default|mongodb_cr|scram_sha_1',
            'AuthSource' => '<string>',
            'AuthType' => 'no|password',
            'CertificateArn' => '<string>',
            'DatabaseName' => '<string>',
            'Port' => <integer>,
            'ServerName' => '<string>',
            'SslMode' => 'none|require|verify-ca|verify-full',
        ],
        'MySqlSettings' => [
            'CertificateArn' => '<string>',
            'Port' => <integer>,
            'S3AccessRoleArn' => '<string>',
            'S3Path' => '<string>',
            'ServerName' => '<string>',
            'SslMode' => 'none|require|verify-ca|verify-full',
        ],
        'OracleSettings' => [
            'AsmServer' => '<string>',
            'CertificateArn' => '<string>',
            'DatabaseName' => '<string>',
            'Port' => <integer>,
            'S3AccessRoleArn' => '<string>',
            'S3Path' => '<string>',
            'SecretsManagerOracleAsmAccessRoleArn' => '<string>',
            'SecretsManagerOracleAsmSecretId' => '<string>',
            'SecretsManagerSecurityDbEncryptionAccessRoleArn' => '<string>',
            'SecretsManagerSecurityDbEncryptionSecretId' => '<string>',
            'ServerName' => '<string>',
            'SslMode' => 'none|require|verify-ca|verify-full',
        ],
        'PostgreSqlSettings' => [
            'CertificateArn' => '<string>',
            'DatabaseName' => '<string>',
            'Port' => <integer>,
            'S3AccessRoleArn' => '<string>',
            'S3Path' => '<string>',
            'ServerName' => '<string>',
            'SslMode' => 'none|require|verify-ca|verify-full',
        ],
        'RedshiftSettings' => [
            'DatabaseName' => '<string>',
            'Port' => <integer>,
            'S3AccessRoleArn' => '<string>',
            'S3Path' => '<string>',
            'ServerName' => '<string>',
        ],
        'SybaseAseSettings' => [
            'CertificateArn' => '<string>',
            'DatabaseName' => '<string>',
            'EncryptPassword' => true || false,
            'Port' => <integer>,
            'ServerName' => '<string>',
            'SslMode' => 'none|require|verify-ca|verify-full',
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'ResourceArn' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Virtual' => true || false,
]);

Parameter Details

Result Syntax

[
    'DataProvider' => [
        'DataProviderArn' => '<string>',
        'DataProviderCreationTime' => <DateTime>,
        'DataProviderName' => '<string>',
        'Description' => '<string>',
        'Engine' => '<string>',
        'Settings' => [
            'DocDbSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'IbmDb2LuwSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'EncryptionAlgorithm' => <integer>,
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'SecurityMechanism' => <integer>,
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'IbmDb2zOsSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'MariaDbSettings' => [
                'CertificateArn' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'MicrosoftSqlServerSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'MongoDbSettings' => [
                'AuthMechanism' => 'default|mongodb_cr|scram_sha_1',
                'AuthSource' => '<string>',
                'AuthType' => 'no|password',
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'MySqlSettings' => [
                'CertificateArn' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'OracleSettings' => [
                'AsmServer' => '<string>',
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'SecretsManagerOracleAsmAccessRoleArn' => '<string>',
                'SecretsManagerOracleAsmSecretId' => '<string>',
                'SecretsManagerSecurityDbEncryptionAccessRoleArn' => '<string>',
                'SecretsManagerSecurityDbEncryptionSecretId' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'PostgreSqlSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'RedshiftSettings' => [
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
            ],
            'SybaseAseSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'EncryptPassword' => true || false,
                'Port' => <integer>,
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
        ],
        'Virtual' => true || false,
    ],
]

Result Details

Errors

ResourceQuotaExceededFault:

The quota for this resource quota has been exceeded.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceAlreadyExistsFault:

The resource you are attempting to create already exists.

FailedDependencyFault:

A dependency threw an exception.

Examples

Example 1: Create a Microsoft SQL Server data provider

The following example creates a Microsoft SQL Server data provider.

$result = $client->createDataProvider([
    'DataProviderName' => 'example-data-provider',
    'Description' => 'Example data provider for documentation',
    'Engine' => 'sqlserver',
    'Settings' => [
        'MicrosoftSqlServerSettings' => [
            'CertificateArn' => 'arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS',
            'DatabaseName' => 'ExampleDatabase',
            'Port' => 1433,
            'ServerName' => 'example-source-server.us-east-1.rds.amazonaws.com',
            'SslMode' => 'verify-full',
        ],
    ],
]);

Result syntax:

[
    'DataProvider' => [
        'DataProviderArn' => 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS',
        'DataProviderCreationTime' => ,
        'DataProviderName' => 'example-data-provider',
        'Description' => 'Example data provider for documentation',
        'Engine' => 'sqlserver',
        'Settings' => [
            'MicrosoftSqlServerSettings' => [
                'CertificateArn' => 'arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS',
                'DatabaseName' => 'ExampleDatabase',
                'Port' => 1433,
                'ServerName' => 'example-source-server.us-east-1.rds.amazonaws.com',
                'SslMode' => 'verify-full',
            ],
        ],
    ],
]

CreateEndpoint

$result = $client->createEndpoint([/* ... */]);
$promise = $client->createEndpointAsync([/* ... */]);

Creates an endpoint using the provided settings.

Parameter Syntax

$result = $client->createEndpoint([
    'CertificateArn' => '<string>',
    'DatabaseName' => '<string>',
    'DmsTransferSettings' => [
        'BucketName' => '<string>',
        'ServiceAccessRoleArn' => '<string>',
    ],
    'DocDbSettings' => [
        'DatabaseName' => '<string>',
        'DocsToInvestigate' => <integer>,
        'ExtractDocId' => true || false,
        'KmsKeyId' => '<string>',
        'NestingLevel' => 'none|one',
        'Password' => '<string>',
        'Port' => <integer>,
        'ReplicateShardCollections' => true || false,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        'UseUpdateLookUp' => true || false,
        'Username' => '<string>',
    ],
    'DynamoDbSettings' => [
        'ServiceAccessRoleArn' => '<string>', // REQUIRED
    ],
    'ElasticsearchSettings' => [
        'EndpointUri' => '<string>', // REQUIRED
        'ErrorRetryDuration' => <integer>,
        'FullLoadErrorPercentage' => <integer>,
        'ServiceAccessRoleArn' => '<string>', // REQUIRED
        'UseNewMappingType' => true || false,
    ],
    'EndpointIdentifier' => '<string>', // REQUIRED
    'EndpointType' => 'source|target', // REQUIRED
    'EngineName' => '<string>', // REQUIRED
    'ExternalTableDefinition' => '<string>',
    'ExtraConnectionAttributes' => '<string>',
    'GcpMySQLSettings' => [
        'AfterConnectScript' => '<string>',
        'CleanSourceMetadataOnMismatch' => true || false,
        'DatabaseName' => '<string>',
        'EventsPollInterval' => <integer>,
        'MaxFileSize' => <integer>,
        'ParallelLoadThreads' => <integer>,
        'Password' => '<string>',
        'Port' => <integer>,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        'ServerTimezone' => '<string>',
        'TargetDbType' => 'specific-database|multiple-databases',
        'Username' => '<string>',
    ],
    'IBMDb2Settings' => [
        'CurrentLsn' => '<string>',
        'DatabaseName' => '<string>',
        'KeepCsvFiles' => true || false,
        'LoadTimeout' => <integer>,
        'MaxFileSize' => <integer>,
        'MaxKBytesPerRead' => <integer>,
        'Password' => '<string>',
        'Port' => <integer>,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        'SetDataCaptureChanges' => true || false,
        'Username' => '<string>',
        'WriteBufferSize' => <integer>,
    ],
    'KafkaSettings' => [
        'Broker' => '<string>',
        'IncludeControlDetails' => true || false,
        'IncludeNullAndEmpty' => true || false,
        'IncludePartitionValue' => true || false,
        'IncludeTableAlterOperations' => true || false,
        'IncludeTransactionDetails' => true || false,
        'MessageFormat' => 'json|json-unformatted',
        'MessageMaxBytes' => <integer>,
        'NoHexPrefix' => true || false,
        'PartitionIncludeSchemaTable' => true || false,
        'SaslMechanism' => 'scram-sha-512|plain',
        'SaslPassword' => '<string>',
        'SaslUsername' => '<string>',
        'SecurityProtocol' => 'plaintext|ssl-authentication|ssl-encryption|sasl-ssl',
        'SslCaCertificateArn' => '<string>',
        'SslClientCertificateArn' => '<string>',
        'SslClientKeyArn' => '<string>',
        'SslClientKeyPassword' => '<string>',
        'SslEndpointIdentificationAlgorithm' => 'none|https',
        'Topic' => '<string>',
        'UseLargeIntegerValue' => true || false,
    ],
    'KinesisSettings' => [
        'IncludeControlDetails' => true || false,
        'IncludeNullAndEmpty' => true || false,
        'IncludePartitionValue' => true || false,
        'IncludeTableAlterOperations' => true || false,
        'IncludeTransactionDetails' => true || false,
        'MessageFormat' => 'json|json-unformatted',
        'NoHexPrefix' => true || false,
        'PartitionIncludeSchemaTable' => true || false,
        'ServiceAccessRoleArn' => '<string>',
        'StreamArn' => '<string>',
        'UseLargeIntegerValue' => true || false,
    ],
    'KmsKeyId' => '<string>',
    'MicrosoftSQLServerSettings' => [
        'AuthenticationMethod' => 'password|kerberos',
        'BcpPacketSize' => <integer>,
        'ControlTablesFileGroup' => '<string>',
        'DatabaseName' => '<string>',
        'ForceLobLookup' => true || false,
        'Password' => '<string>',
        'Port' => <integer>,
        'QuerySingleAlwaysOnNode' => true || false,
        'ReadBackupOnly' => true || false,
        'SafeguardPolicy' => 'rely-on-sql-server-replication-agent|exclusive-automatic-truncation|shared-automatic-truncation',
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        'TlogAccessMode' => 'BackupOnly|PreferBackup|PreferTlog|TlogOnly',
        'TrimSpaceInChar' => true || false,
        'UseBcpFullLoad' => true || false,
        'UseThirdPartyBackupDevice' => true || false,
        'Username' => '<string>',
    ],
    'MongoDbSettings' => [
        'AuthMechanism' => 'default|mongodb_cr|scram_sha_1',
        'AuthSource' => '<string>',
        'AuthType' => 'no|password',
        'DatabaseName' => '<string>',
        'DocsToInvestigate' => '<string>',
        'ExtractDocId' => '<string>',
        'KmsKeyId' => '<string>',
        'NestingLevel' => 'none|one',
        'Password' => '<string>',
        'Port' => <integer>,
        'ReplicateShardCollections' => true || false,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        'UseUpdateLookUp' => true || false,
        'Username' => '<string>',
    ],
    'MySQLSettings' => [
        'AfterConnectScript' => '<string>',
        'AuthenticationMethod' => 'password|iam',
        'CleanSourceMetadataOnMismatch' => true || false,
        'DatabaseName' => '<string>',
        'EventsPollInterval' => <integer>,
        'ExecuteTimeout' => <integer>,
        'MaxFileSize' => <integer>,
        'ParallelLoadThreads' => <integer>,
        'Password' => '<string>',
        'Port' => <integer>,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        'ServerTimezone' => '<string>',
        'ServiceAccessRoleArn' => '<string>',
        'TargetDbType' => 'specific-database|multiple-databases',
        'Username' => '<string>',
    ],
    'NeptuneSettings' => [
        'ErrorRetryDuration' => <integer>,
        'IamAuthEnabled' => true || false,
        'MaxFileSize' => <integer>,
        'MaxRetryCount' => <integer>,
        'S3BucketFolder' => '<string>', // REQUIRED
        'S3BucketName' => '<string>', // REQUIRED
        'ServiceAccessRoleArn' => '<string>',
    ],
    'OracleSettings' => [
        'AccessAlternateDirectly' => true || false,
        'AddSupplementalLogging' => true || false,
        'AdditionalArchivedLogDestId' => <integer>,
        'AllowSelectNestedTables' => true || false,
        'ArchivedLogDestId' => <integer>,
        'ArchivedLogsOnly' => true || false,
        'AsmPassword' => '<string>',
        'AsmServer' => '<string>',
        'AsmUser' => '<string>',
        'AuthenticationMethod' => 'password|kerberos',
        'CharLengthSemantics' => 'default|char|byte',
        'ConvertTimestampWithZoneToUTC' => true || false,
        'DatabaseName' => '<string>',
        'DirectPathNoLog' => true || false,
        'DirectPathParallelLoad' => true || false,
        'EnableHomogenousTablespace' => true || false,
        'ExtraArchivedLogDestIds' => [<integer>, ...],
        'FailTasksOnLobTruncation' => true || false,
        'NumberDatatypeScale' => <integer>,
        'OpenTransactionWindow' => <integer>,
        'OraclePathPrefix' => '<string>',
        'ParallelAsmReadThreads' => <integer>,
        'Password' => '<string>',
        'Port' => <integer>,
        'ReadAheadBlocks' => <integer>,
        'ReadTableSpaceName' => true || false,
        'ReplacePathPrefix' => true || false,
        'RetryInterval' => <integer>,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerOracleAsmAccessRoleArn' => '<string>',
        'SecretsManagerOracleAsmSecretId' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'SecurityDbEncryption' => '<string>',
        'SecurityDbEncryptionName' => '<string>',
        'ServerName' => '<string>',
        'SpatialDataOptionToGeoJsonFunctionName' => '<string>',
        'StandbyDelayTime' => <integer>,
        'TrimSpaceInChar' => true || false,
        'UseAlternateFolderForOnline' => true || false,
        'UseBFile' => true || false,
        'UseDirectPathFullLoad' => true || false,
        'UseLogminerReader' => true || false,
        'UsePathPrefix' => '<string>',
        'Username' => '<string>',
    ],
    'Password' => '<string>',
    'Port' => <integer>,
    'PostgreSQLSettings' => [
        'AfterConnectScript' => '<string>',
        'AuthenticationMethod' => 'password|iam',
        'BabelfishDatabaseName' => '<string>',
        'CaptureDdls' => true || false,
        'DatabaseMode' => 'default|babelfish',
        'DatabaseName' => '<string>',
        'DdlArtifactsSchema' => '<string>',
        'DisableUnicodeSourceFilter' => true || false,
        'ExecuteTimeout' => <integer>,
        'FailTasksOnLobTruncation' => true || false,
        'HeartbeatEnable' => true || false,
        'HeartbeatFrequency' => <integer>,
        'HeartbeatSchema' => '<string>',
        'MapBooleanAsBoolean' => true || false,
        'MapJsonbAsClob' => true || false,
        'MapLongVarcharAs' => 'wstring|clob|nclob',
        'MaxFileSize' => <integer>,
        'Password' => '<string>',
        'PluginName' => 'no-preference|test-decoding|pglogical',
        'Port' => <integer>,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        'ServiceAccessRoleArn' => '<string>',
        'SlotName' => '<string>',
        'TrimSpaceInChar' => true || false,
        'Username' => '<string>',
    ],
    'RedisSettings' => [
        'AuthPassword' => '<string>',
        'AuthType' => 'none|auth-role|auth-token',
        'AuthUserName' => '<string>',
        'Port' => <integer>, // REQUIRED
        'ServerName' => '<string>', // REQUIRED
        'SslCaCertificateArn' => '<string>',
        'SslSecurityProtocol' => 'plaintext|ssl-encryption',
    ],
    'RedshiftSettings' => [
        'AcceptAnyDate' => true || false,
        'AfterConnectScript' => '<string>',
        'BucketFolder' => '<string>',
        'BucketName' => '<string>',
        'CaseSensitiveNames' => true || false,
        'CompUpdate' => true || false,
        'ConnectionTimeout' => <integer>,
        'DatabaseName' => '<string>',
        'DateFormat' => '<string>',
        'EmptyAsNull' => true || false,
        'EncryptionMode' => 'sse-s3|sse-kms',
        'ExplicitIds' => true || false,
        'FileTransferUploadStreams' => <integer>,
        'LoadTimeout' => <integer>,
        'MapBooleanAsBoolean' => true || false,
        'MaxFileSize' => <integer>,
        'Password' => '<string>',
        'Port' => <integer>,
        'RemoveQuotes' => true || false,
        'ReplaceChars' => '<string>',
        'ReplaceInvalidChars' => '<string>',
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        'ServerSideEncryptionKmsKeyId' => '<string>',
        'ServiceAccessRoleArn' => '<string>',
        'TimeFormat' => '<string>',
        'TrimBlanks' => true || false,
        'TruncateColumns' => true || false,
        'Username' => '<string>',
        'WriteBufferSize' => <integer>,
    ],
    'ResourceIdentifier' => '<string>',
    'S3Settings' => [
        'AddColumnName' => true || false,
        'AddTrailingPaddingCharacter' => true || false,
        'BucketFolder' => '<string>',
        'BucketName' => '<string>',
        'CannedAclForObjects' => 'none|private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control',
        'CdcInsertsAndUpdates' => true || false,
        'CdcInsertsOnly' => true || false,
        'CdcMaxBatchInterval' => <integer>,
        'CdcMinFileSize' => <integer>,
        'CdcPath' => '<string>',
        'CompressionType' => 'none|gzip',
        'CsvDelimiter' => '<string>',
        'CsvNoSupValue' => '<string>',
        'CsvNullValue' => '<string>',
        'CsvRowDelimiter' => '<string>',
        'DataFormat' => 'csv|parquet',
        'DataPageSize' => <integer>,
        'DatePartitionDelimiter' => 'SLASH|UNDERSCORE|DASH|NONE',
        'DatePartitionEnabled' => true || false,
        'DatePartitionSequence' => 'YYYYMMDD|YYYYMMDDHH|YYYYMM|MMYYYYDD|DDMMYYYY',
        'DatePartitionTimezone' => '<string>',
        'DictPageSizeLimit' => <integer>,
        'EnableStatistics' => true || false,
        'EncodingType' => 'plain|plain-dictionary|rle-dictionary',
        'EncryptionMode' => 'sse-s3|sse-kms',
        'ExpectedBucketOwner' => '<string>',
        'ExternalTableDefinition' => '<string>',
        'GlueCatalogGeneration' => true || false,
        'IgnoreHeaderRows' => <integer>,
        'IncludeOpForFullLoad' => true || false,
        'MaxFileSize' => <integer>,
        'ParquetTimestampInMillisecond' => true || false,
        'ParquetVersion' => 'parquet-1-0|parquet-2-0',
        'PreserveTransactions' => true || false,
        'Rfc4180' => true || false,
        'RowGroupLength' => <integer>,
        'ServerSideEncryptionKmsKeyId' => '<string>',
        'ServiceAccessRoleArn' => '<string>',
        'TimestampColumnName' => '<string>',
        'UseCsvNoSupValue' => true || false,
        'UseTaskStartTimeForFullLoadTimestamp' => true || false,
    ],
    'ServerName' => '<string>',
    'ServiceAccessRoleArn' => '<string>',
    'SslMode' => 'none|require|verify-ca|verify-full',
    'SybaseSettings' => [
        'DatabaseName' => '<string>',
        'Password' => '<string>',
        'Port' => <integer>,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        'Username' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'ResourceArn' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TimestreamSettings' => [
        'CdcInsertsAndUpdates' => true || false,
        'DatabaseName' => '<string>', // REQUIRED
        'EnableMagneticStoreWrites' => true || false,
        'MagneticDuration' => <integer>, // REQUIRED
        'MemoryDuration' => <integer>, // REQUIRED
    ],
    'Username' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Endpoint' => [
        'CertificateArn' => '<string>',
        'DatabaseName' => '<string>',
        'DmsTransferSettings' => [
            'BucketName' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
        ],
        'DocDbSettings' => [
            'DatabaseName' => '<string>',
            'DocsToInvestigate' => <integer>,
            'ExtractDocId' => true || false,
            'KmsKeyId' => '<string>',
            'NestingLevel' => 'none|one',
            'Password' => '<string>',
            'Port' => <integer>,
            'ReplicateShardCollections' => true || false,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'UseUpdateLookUp' => true || false,
            'Username' => '<string>',
        ],
        'DynamoDbSettings' => [
            'ServiceAccessRoleArn' => '<string>',
        ],
        'ElasticsearchSettings' => [
            'EndpointUri' => '<string>',
            'ErrorRetryDuration' => <integer>,
            'FullLoadErrorPercentage' => <integer>,
            'ServiceAccessRoleArn' => '<string>',
            'UseNewMappingType' => true || false,
        ],
        'EndpointArn' => '<string>',
        'EndpointIdentifier' => '<string>',
        'EndpointType' => 'source|target',
        'EngineDisplayName' => '<string>',
        'EngineName' => '<string>',
        'ExternalId' => '<string>',
        'ExternalTableDefinition' => '<string>',
        'ExtraConnectionAttributes' => '<string>',
        'GcpMySQLSettings' => [
            'AfterConnectScript' => '<string>',
            'CleanSourceMetadataOnMismatch' => true || false,
            'DatabaseName' => '<string>',
            'EventsPollInterval' => <integer>,
            'MaxFileSize' => <integer>,
            'ParallelLoadThreads' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'ServerTimezone' => '<string>',
            'TargetDbType' => 'specific-database|multiple-databases',
            'Username' => '<string>',
        ],
        'IBMDb2Settings' => [
            'CurrentLsn' => '<string>',
            'DatabaseName' => '<string>',
            'KeepCsvFiles' => true || false,
            'LoadTimeout' => <integer>,
            'MaxFileSize' => <integer>,
            'MaxKBytesPerRead' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'SetDataCaptureChanges' => true || false,
            'Username' => '<string>',
            'WriteBufferSize' => <integer>,
        ],
        'IsReadOnly' => true || false,
        'KafkaSettings' => [
            'Broker' => '<string>',
            'IncludeControlDetails' => true || false,
            'IncludeNullAndEmpty' => true || false,
            'IncludePartitionValue' => true || false,
            'IncludeTableAlterOperations' => true || false,
            'IncludeTransactionDetails' => true || false,
            'MessageFormat' => 'json|json-unformatted',
            'MessageMaxBytes' => <integer>,
            'NoHexPrefix' => true || false,
            'PartitionIncludeSchemaTable' => true || false,
            'SaslMechanism' => 'scram-sha-512|plain',
            'SaslPassword' => '<string>',
            'SaslUsername' => '<string>',
            'SecurityProtocol' => 'plaintext|ssl-authentication|ssl-encryption|sasl-ssl',
            'SslCaCertificateArn' => '<string>',
            'SslClientCertificateArn' => '<string>',
            'SslClientKeyArn' => '<string>',
            'SslClientKeyPassword' => '<string>',
            'SslEndpointIdentificationAlgorithm' => 'none|https',
            'Topic' => '<string>',
            'UseLargeIntegerValue' => true || false,
        ],
        'KinesisSettings' => [
            'IncludeControlDetails' => true || false,
            'IncludeNullAndEmpty' => true || false,
            'IncludePartitionValue' => true || false,
            'IncludeTableAlterOperations' => true || false,
            'IncludeTransactionDetails' => true || false,
            'MessageFormat' => 'json|json-unformatted',
            'NoHexPrefix' => true || false,
            'PartitionIncludeSchemaTable' => true || false,
            'ServiceAccessRoleArn' => '<string>',
            'StreamArn' => '<string>',
            'UseLargeIntegerValue' => true || false,
        ],
        'KmsKeyId' => '<string>',
        'LakehouseSettings' => [
            'Arn' => '<string>',
        ],
        'MicrosoftSQLServerSettings' => [
            'AuthenticationMethod' => 'password|kerberos',
            'BcpPacketSize' => <integer>,
            'ControlTablesFileGroup' => '<string>',
            'DatabaseName' => '<string>',
            'ForceLobLookup' => true || false,
            'Password' => '<string>',
            'Port' => <integer>,
            'QuerySingleAlwaysOnNode' => true || false,
            'ReadBackupOnly' => true || false,
            'SafeguardPolicy' => 'rely-on-sql-server-replication-agent|exclusive-automatic-truncation|shared-automatic-truncation',
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'TlogAccessMode' => 'BackupOnly|PreferBackup|PreferTlog|TlogOnly',
            'TrimSpaceInChar' => true || false,
            'UseBcpFullLoad' => true || false,
            'UseThirdPartyBackupDevice' => true || false,
            'Username' => '<string>',
        ],
        'MongoDbSettings' => [
            'AuthMechanism' => 'default|mongodb_cr|scram_sha_1',
            'AuthSource' => '<string>',
            'AuthType' => 'no|password',
            'DatabaseName' => '<string>',
            'DocsToInvestigate' => '<string>',
            'ExtractDocId' => '<string>',
            'KmsKeyId' => '<string>',
            'NestingLevel' => 'none|one',
            'Password' => '<string>',
            'Port' => <integer>,
            'ReplicateShardCollections' => true || false,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'UseUpdateLookUp' => true || false,
            'Username' => '<string>',
        ],
        'MySQLSettings' => [
            'AfterConnectScript' => '<string>',
            'AuthenticationMethod' => 'password|iam',
            'CleanSourceMetadataOnMismatch' => true || false,
            'DatabaseName' => '<string>',
            'EventsPollInterval' => <integer>,
            'ExecuteTimeout' => <integer>,
            'MaxFileSize' => <integer>,
            'ParallelLoadThreads' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'ServerTimezone' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
            'TargetDbType' => 'specific-database|multiple-databases',
            'Username' => '<string>',
        ],
        'NeptuneSettings' => [
            'ErrorRetryDuration' => <integer>,
            'IamAuthEnabled' => true || false,
            'MaxFileSize' => <integer>,
            'MaxRetryCount' => <integer>,
            'S3BucketFolder' => '<string>',
            'S3BucketName' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
        ],
        'OracleSettings' => [
            'AccessAlternateDirectly' => true || false,
            'AddSupplementalLogging' => true || false,
            'AdditionalArchivedLogDestId' => <integer>,
            'AllowSelectNestedTables' => true || false,
            'ArchivedLogDestId' => <integer>,
            'ArchivedLogsOnly' => true || false,
            'AsmPassword' => '<string>',
            'AsmServer' => '<string>',
            'AsmUser' => '<string>',
            'AuthenticationMethod' => 'password|kerberos',
            'CharLengthSemantics' => 'default|char|byte',
            'ConvertTimestampWithZoneToUTC' => true || false,
            'DatabaseName' => '<string>',
            'DirectPathNoLog' => true || false,
            'DirectPathParallelLoad' => true || false,
            'EnableHomogenousTablespace' => true || false,
            'ExtraArchivedLogDestIds' => [<integer>, ...],
            'FailTasksOnLobTruncation' => true || false,
            'NumberDatatypeScale' => <integer>,
            'OpenTransactionWindow' => <integer>,
            'OraclePathPrefix' => '<string>',
            'ParallelAsmReadThreads' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'ReadAheadBlocks' => <integer>,
            'ReadTableSpaceName' => true || false,
            'ReplacePathPrefix' => true || false,
            'RetryInterval' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerOracleAsmAccessRoleArn' => '<string>',
            'SecretsManagerOracleAsmSecretId' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'SecurityDbEncryption' => '<string>',
            'SecurityDbEncryptionName' => '<string>',
            'ServerName' => '<string>',
            'SpatialDataOptionToGeoJsonFunctionName' => '<string>',
            'StandbyDelayTime' => <integer>,
            'TrimSpaceInChar' => true || false,
            'UseAlternateFolderForOnline' => true || false,
            'UseBFile' => true || false,
            'UseDirectPathFullLoad' => true || false,
            'UseLogminerReader' => true || false,
            'UsePathPrefix' => '<string>',
            'Username' => '<string>',
        ],
        'Port' => <integer>,
        'PostgreSQLSettings' => [
            'AfterConnectScript' => '<string>',
            'AuthenticationMethod' => 'password|iam',
            'BabelfishDatabaseName' => '<string>',
            'CaptureDdls' => true || false,
            'DatabaseMode' => 'default|babelfish',
            'DatabaseName' => '<string>',
            'DdlArtifactsSchema' => '<string>',
            'DisableUnicodeSourceFilter' => true || false,
            'ExecuteTimeout' => <integer>,
            'FailTasksOnLobTruncation' => true || false,
            'HeartbeatEnable' => true || false,
            'HeartbeatFrequency' => <integer>,
            'HeartbeatSchema' => '<string>',
            'MapBooleanAsBoolean' => true || false,
            'MapJsonbAsClob' => true || false,
            'MapLongVarcharAs' => 'wstring|clob|nclob',
            'MaxFileSize' => <integer>,
            'Password' => '<string>',
            'PluginName' => 'no-preference|test-decoding|pglogical',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
            'SlotName' => '<string>',
            'TrimSpaceInChar' => true || false,
            'Username' => '<string>',
        ],
        'RedisSettings' => [
            'AuthPassword' => '<string>',
            'AuthType' => 'none|auth-role|auth-token',
            'AuthUserName' => '<string>',
            'Port' => <integer>,
            'ServerName' => '<string>',
            'SslCaCertificateArn' => '<string>',
            'SslSecurityProtocol' => 'plaintext|ssl-encryption',
        ],
        'RedshiftSettings' => [
            'AcceptAnyDate' => true || false,
            'AfterConnectScript' => '<string>',
            'BucketFolder' => '<string>',
            'BucketName' => '<string>',
            'CaseSensitiveNames' => true || false,
            'CompUpdate' => true || false,
            'ConnectionTimeout' => <integer>,
            'DatabaseName' => '<string>',
            'DateFormat' => '<string>',
            'EmptyAsNull' => true || false,
            'EncryptionMode' => 'sse-s3|sse-kms',
            'ExplicitIds' => true || false,
            'FileTransferUploadStreams' => <integer>,
            'LoadTimeout' => <integer>,
            'MapBooleanAsBoolean' => true || false,
            'MaxFileSize' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'RemoveQuotes' => true || false,
            'ReplaceChars' => '<string>',
            'ReplaceInvalidChars' => '<string>',
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'ServerSideEncryptionKmsKeyId' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
            'TimeFormat' => '<string>',
            'TrimBlanks' => true || false,
            'TruncateColumns' => true || false,
            'Username' => '<string>',
            'WriteBufferSize' => <integer>,
        ],
        'S3Settings' => [
            'AddColumnName' => true || false,
            'AddTrailingPaddingCharacter' => true || false,
            'BucketFolder' => '<string>',
            'BucketName' => '<string>',
            'CannedAclForObjects' => 'none|private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control',
            'CdcInsertsAndUpdates' => true || false,
            'CdcInsertsOnly' => true || false,
            'CdcMaxBatchInterval' => <integer>,
            'CdcMinFileSize' => <integer>,
            'CdcPath' => '<string>',
            'CompressionType' => 'none|gzip',
            'CsvDelimiter' => '<string>',
            'CsvNoSupValue' => '<string>',
            'CsvNullValue' => '<string>',
            'CsvRowDelimiter' => '<string>',
            'DataFormat' => 'csv|parquet',
            'DataPageSize' => <integer>,
            'DatePartitionDelimiter' => 'SLASH|UNDERSCORE|DASH|NONE',
            'DatePartitionEnabled' => true || false,
            'DatePartitionSequence' => 'YYYYMMDD|YYYYMMDDHH|YYYYMM|MMYYYYDD|DDMMYYYY',
            'DatePartitionTimezone' => '<string>',
            'DictPageSizeLimit' => <integer>,
            'EnableStatistics' => true || false,
            'EncodingType' => 'plain|plain-dictionary|rle-dictionary',
            'EncryptionMode' => 'sse-s3|sse-kms',
            'ExpectedBucketOwner' => '<string>',
            'ExternalTableDefinition' => '<string>',
            'GlueCatalogGeneration' => true || false,
            'IgnoreHeaderRows' => <integer>,
            'IncludeOpForFullLoad' => true || false,
            'MaxFileSize' => <integer>,
            'ParquetTimestampInMillisecond' => true || false,
            'ParquetVersion' => 'parquet-1-0|parquet-2-0',
            'PreserveTransactions' => true || false,
            'Rfc4180' => true || false,
            'RowGroupLength' => <integer>,
            'ServerSideEncryptionKmsKeyId' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
            'TimestampColumnName' => '<string>',
            'UseCsvNoSupValue' => true || false,
            'UseTaskStartTimeForFullLoadTimestamp' => true || false,
        ],
        'ServerName' => '<string>',
        'ServiceAccessRoleArn' => '<string>',
        'SslMode' => 'none|require|verify-ca|verify-full',
        'Status' => '<string>',
        'SybaseSettings' => [
            'DatabaseName' => '<string>',
            'Password' => '<string>',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'Username' => '<string>',
        ],
        'TimestreamSettings' => [
            'CdcInsertsAndUpdates' => true || false,
            'DatabaseName' => '<string>',
            'EnableMagneticStoreWrites' => true || false,
            'MagneticDuration' => <integer>,
            'MemoryDuration' => <integer>,
        ],
        'Username' => '<string>',
    ],
]

Result Details

Errors

KMSKeyNotAccessibleFault:

DMS cannot access the KMS key.

ResourceAlreadyExistsFault:

The resource you are attempting to create already exists.

ResourceQuotaExceededFault:

The quota for this resource quota has been exceeded.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

ResourceNotFoundFault:

The resource could not be found.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

S3AccessDeniedFault:

Insufficient privileges are preventing access to an Amazon S3 object.

Examples

Example 1: Create endpoint

Creates an endpoint using the provided settings.

$result = $client->createEndpoint([
    'CertificateArn' => '',
    'DatabaseName' => 'testdb',
    'EndpointIdentifier' => 'test-endpoint-1',
    'EndpointType' => 'source',
    'EngineName' => 'mysql',
    'ExtraConnectionAttributes' => '',
    'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
    'Password' => 'pasword',
    'Port' => 3306,
    'ServerName' => 'mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com',
    'SslMode' => 'require',
    'Tags' => [
        [
            'Key' => 'Acount',
            'Value' => '143327655',
        ],
    ],
    'Username' => 'username',
]);

Result syntax:

[
    'Endpoint' => [
        'EndpointArn' => 'arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM',
        'EndpointIdentifier' => 'test-endpoint-1',
        'EndpointType' => 'source',
        'EngineName' => 'mysql',
        'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
        'Port' => 3306,
        'ServerName' => 'mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com',
        'Status' => 'active',
        'Username' => 'username',
    ],
]

CreateEventSubscription

$result = $client->createEventSubscription([/* ... */]);
$promise = $client->createEventSubscriptionAsync([/* ... */]);

Creates an DMS event notification subscription.

You can specify the type of source (SourceType) you want to be notified of, provide a list of DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all DMS sources belonging to your customer account.

For more information about DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.

Parameter Syntax

$result = $client->createEventSubscription([
    'Enabled' => true || false,
    'EventCategories' => ['<string>', ...],
    'SnsTopicArn' => '<string>', // REQUIRED
    'SourceIds' => ['<string>', ...],
    'SourceType' => '<string>',
    'SubscriptionName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'ResourceArn' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Errors

ResourceQuotaExceededFault:

The quota for this resource quota has been exceeded.

ResourceNotFoundFault:

The resource could not be found.

ResourceAlreadyExistsFault:

The resource you are attempting to create already exists.

SNSInvalidTopicFault:

The SNS topic is invalid.

SNSNoAuthorizationFault:

You are not authorized for the SNS subscription.

KMSAccessDeniedFault:

The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.

KMSDisabledFault:

The specified KMS key isn't enabled.

KMSInvalidStateFault:

The state of the specified KMS resource isn't valid for this request.

KMSNotFoundFault:

The specified KMS entity or resource can't be found.

KMSThrottlingFault:

This request triggered KMS request throttling.

CreateFleetAdvisorCollector

$result = $client->createFleetAdvisorCollector([/* ... */]);
$promise = $client->createFleetAdvisorCollectorAsync([/* ... */]);

End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

Creates a Fleet Advisor collector using the specified parameters.

Parameter Syntax

$result = $client->createFleetAdvisorCollector([
    'CollectorName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'S3BucketName' => '<string>', // REQUIRED
    'ServiceAccessRoleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CollectorName' => '<string>',
    'CollectorReferencedId' => '<string>',
    'Description' => '<string>',
    'S3BucketName' => '<string>',
    'ServiceAccessRoleArn' => '<string>',
]

Result Details

Errors

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

S3AccessDeniedFault:

Insufficient privileges are preventing access to an Amazon S3 object.

S3ResourceNotFoundFault:

A specified Amazon S3 bucket, bucket folder, or other object can't be found.

ResourceQuotaExceededFault:

The quota for this resource quota has been exceeded.

CreateInstanceProfile

$result = $client->createInstanceProfile([/* ... */]);
$promise = $client->createInstanceProfileAsync([/* ... */]);

Creates the instance profile using the specified parameters.

Required permissions: dms:CreateInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameter Syntax

$result = $client->createInstanceProfile([
    'AvailabilityZone' => '<string>',
    'Description' => '<string>',
    'InstanceProfileName' => '<string>',
    'KmsKeyArn' => '<string>',
    'NetworkType' => '<string>',
    'PubliclyAccessible' => true || false,
    'SubnetGroupIdentifier' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'ResourceArn' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcSecurityGroups' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'InstanceProfile' => [
        'AvailabilityZone' => '<string>',
        'Description' => '<string>',
        'InstanceProfileArn' => '<string>',
        'InstanceProfileCreationTime' => <DateTime>,
        'InstanceProfileName' => '<string>',
        'KmsKeyArn' => '<string>',
        'NetworkType' => '<string>',
        'PubliclyAccessible' => true || false,
        'SubnetGroupIdentifier' => '<string>',
        'VpcSecurityGroups' => ['<string>', ...],
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceAlreadyExistsFault:

The resource you are attempting to create already exists.

ResourceNotFoundFault:

The resource could not be found.

ResourceQuotaExceededFault:

The quota for this resource quota has been exceeded.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

KMSKeyNotAccessibleFault:

DMS cannot access the KMS key.

S3ResourceNotFoundFault:

A specified Amazon S3 bucket, bucket folder, or other object can't be found.

S3AccessDeniedFault:

Insufficient privileges are preventing access to an Amazon S3 object.

FailedDependencyFault:

A dependency threw an exception.

Examples

Example 1: Create an instance profile

The following example creates an instance profile.

$result = $client->createInstanceProfile([
    'Description' => 'Example instance profile for documentation',
    'InstanceProfileName' => 'example-instance-profile',
    'KmsKeyArn' => 'arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'NetworkType' => 'IPV4',
    'PubliclyAccessible' => ,
    'SubnetGroupIdentifier' => 'example-replication-subnet-group',
    'VpcSecurityGroups' => [
        'sg-0123456789abcdef0',
    ],
]);

Result syntax:

[
    'InstanceProfile' => [
        'Description' => 'Example instance profile for documentation',
        'InstanceProfileArn' => 'arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS',
        'InstanceProfileCreationTime' => ,
        'InstanceProfileName' => 'example-instance-profile',
        'KmsKeyArn' => 'arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
        'NetworkType' => 'IPV4',
        'PubliclyAccessible' => ,
        'SubnetGroupIdentifier' => 'example-replication-subnet-group',
        'VpcSecurityGroups' => [
            'sg-0123456789abcdef0',
        ],
    ],
]

CreateMigrationProject

$result = $client->createMigrationProject([/* ... */]);
$promise = $client->createMigrationProjectAsync([/* ... */]);

Creates the migration project using the specified parameters.

You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider.

Required permissions: dms:CreateMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameter Syntax

$result = $client->createMigrationProject([
    'Description' => '<string>',
    'InstanceProfileIdentifier' => '<string>', // REQUIRED
    'MigrationProjectName' => '<string>',
    'SchemaConversionApplicationAttributes' => [
        'S3BucketPath' => '<string>',
        'S3BucketRoleArn' => '<string>',
    ],
    'SourceDataProviderDescriptors' => [ // REQUIRED
        [
            'DataProviderIdentifier' => '<string>', // REQUIRED
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'ResourceArn' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetDataProviderDescriptors' => [ // REQUIRED
        [
            'DataProviderIdentifier' => '<string>', // REQUIRED
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
        ],
        // ...
    ],
    'TransformationRules' => '<string>',
]);

Parameter Details

Result Syntax

[
    'MigrationProject' => [
        'Description' => '<string>',
        'InstanceProfileArn' => '<string>',
        'InstanceProfileName' => '<string>',
        'MigrationProjectArn' => '<string>',
        'MigrationProjectCreationTime' => <DateTime>,
        'MigrationProjectName' => '<string>',
        'SchemaConversionApplicationAttributes' => [
            'S3BucketPath' => '<string>',
            'S3BucketRoleArn' => '<string>',
        ],
        'SourceDataProviderDescriptors' => [
            [
                'DataProviderArn' => '<string>',
                'DataProviderName' => '<string>',
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
            ],
            // ...
        ],
        'TargetDataProviderDescriptors' => [
            [
                'DataProviderArn' => '<string>',
                'DataProviderName' => '<string>',
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
            ],
            // ...
        ],
        'TransformationRules' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceAlreadyExistsFault:

The resource you are attempting to create already exists.

ResourceQuotaExceededFault:

The quota for this resource quota has been exceeded.

ResourceNotFoundFault:

The resource could not be found.

S3ResourceNotFoundFault:

A specified Amazon S3 bucket, bucket folder, or other object can't be found.

S3AccessDeniedFault:

Insufficient privileges are preventing access to an Amazon S3 object.

FailedDependencyFault:

A dependency threw an exception.

Examples

Example 1: Create a migration project

The following example creates a migration project.

$result = $client->createMigrationProject([
    'Description' => 'Example migration project for documentation',
    'InstanceProfileIdentifier' => 'arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS',
    'MigrationProjectName' => 'example-migration-project',
    'SchemaConversionApplicationAttributes' => [
        'S3BucketPath' => 's3://amzn-s3-demo-bucket',
        'S3BucketRoleArn' => 'arn:aws:iam::111122223333:role/example-s3-access-role',
    ],
    'SourceDataProviderDescriptors' => [
        [
            'DataProviderIdentifier' => 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS',
            'SecretsManagerAccessRoleArn' => 'arn:aws:iam::111122223333:role/example-secrets-manager-role',
            'SecretsManagerSecretId' => 'arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3',
        ],
    ],
    'TargetDataProviderDescriptors' => [
        [
            'DataProviderIdentifier' => 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS',
            'SecretsManagerAccessRoleArn' => 'arn:aws:iam::111122223333:role/example-secrets-manager-role',
            'SecretsManagerSecretId' => 'arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3',
        ],
    ],
    'TransformationRules' => '{"rules":[{"rule-type":"transformation","rule-id":"1","rule-name":"1","rule-target":"schema","rule-action":"rename","object-locator":{"schema-name":"ExampleSchema"},"value":"TargetSchema"}]}',
]);

Result syntax:

[
    'MigrationProject' => [
        'Description' => 'Example migration project for documentation',
        'InstanceProfileArn' => 'arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS',
        'InstanceProfileName' => 'example-instance-profile',
        'MigrationProjectArn' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
        'MigrationProjectCreationTime' => ,
        'MigrationProjectName' => 'example-migration-project',
        'SchemaConversionApplicationAttributes' => [
            'S3BucketPath' => 's3://amzn-s3-demo-bucket',
            'S3BucketRoleArn' => 'arn:aws:iam::111122223333:role/example-s3-access-role',
        ],
        'SourceDataProviderDescriptors' => [
            [
                'DataProviderArn' => 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS',
                'DataProviderName' => 'example-data-provider',
                'SecretsManagerAccessRoleArn' => 'arn:aws:iam::111122223333:role/example-secrets-manager-role',
                'SecretsManagerSecretId' => 'arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3',
            ],
        ],
        'TargetDataProviderDescriptors' => [
            [
                'DataProviderArn' => 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS',
                'DataProviderName' => 'example-data-provider',
                'SecretsManagerAccessRoleArn' => 'arn:aws:iam::111122223333:role/example-secrets-manager-role',
                'SecretsManagerSecretId' => 'arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3',
            ],
        ],
        'TransformationRules' => '{"rules":[{"rule-type":"transformation","rule-id":"1","rule-name":"1","rule-target":"schema","rule-action":"rename","object-locator":{"schema-name":"ExampleSchema"},"value":"TargetSchema"}]}',
    ],
]

CreateReplicationConfig

$result = $client->createReplicationConfig([/* ... */]);
$promise = $client->createReplicationConfigAsync([/* ... */]);

Creates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.

Parameter Syntax

$result = $client->createReplicationConfig([
    'ComputeConfig' => [ // REQUIRED
        'AvailabilityZone' => '<string>',
        'DnsNameServers' => '<string>',
        'KmsKeyId' => '<string>',
        'MaxCapacityUnits' => <integer>,
        'MinCapacityUnits' => <integer>,
        'MultiAZ' => true || false,
        'PreferredMaintenanceWindow' => '<string>',
        'ReplicationSubnetGroupId' => '<string>',
        'VpcSecurityGroupIds' => ['<string>', ...],
    ],
    'ReplicationConfigIdentifier' => '<string>', // REQUIRED
    'ReplicationSettings' => '<string>',
    'ReplicationType' => 'full-load|cdc|full-load-and-cdc', // REQUIRED
    'ResourceIdentifier' => '<string>',
    'SourceEndpointArn' => '<string>', // REQUIRED
    'SupplementalSettings' => '<string>',
    'TableMappings' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'ResourceArn' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetEndpointArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ReplicationConfig' => [
        'ComputeConfig' => [
            'AvailabilityZone' => '<string>',
            'DnsNameServers' => '<string>',
            'KmsKeyId' => '<string>',
            'MaxCapacityUnits' => <integer>,
            'MinCapacityUnits' => <integer>,
            'MultiAZ' => true || false,
            'PreferredMaintenanceWindow' => '<string>',
            'ReplicationSubnetGroupId' => '<string>',
            'VpcSecurityGroupIds' => ['<string>', ...],
        ],
        'IsReadOnly' => true || false,
        'ReplicationConfigArn' => '<string>',
        'ReplicationConfigCreateTime' => <DateTime>,
        'ReplicationConfigIdentifier' => '<string>',
        'ReplicationConfigUpdateTime' => <DateTime>,
        'ReplicationSettings' => '<string>',
        'ReplicationType' => 'full-load|cdc|full-load-and-cdc',
        'SourceEndpointArn' => '<string>',
        'SupplementalSettings' => '<string>',
        'TableMappings' => '<string>',
        'TargetEndpointArn' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceAlreadyExistsFault:

The resource you are attempting to create already exists.

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

ReplicationSubnetGroupDoesNotCoverEnoughAZs:

The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.

InvalidSubnet:

The subnet provided isn't valid.

KMSKeyNotAccessibleFault:

DMS cannot access the KMS key.

ResourceQuotaExceededFault:

The quota for this resource quota has been exceeded.

CreateReplicationInstance

$result = $client->createReplicationInstance([/* ... */]);
$promise = $client->createReplicationInstanceAsync([/* ... */]);

Creates the replication instance using the specified parameters.

DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.

Parameter Syntax

$result = $client->createReplicationInstance([
    'AllocatedStorage' => <integer>,
    'AutoMinorVersionUpgrade' => true || false,
    'AvailabilityZone' => '<string>',
    'DnsNameServers' => '<string>',
    'EngineVersion' => '<string>',
    'KerberosAuthenticationSettings' => [
        'KeyCacheSecretIamArn' => '<string>',
        'KeyCacheSecretId' => '<string>',
        'Krb5FileContents' => '<string>',
    ],
    'KmsKeyId' => '<string>',
    'MultiAZ' => true || false,
    'NetworkType' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'PubliclyAccessible' => true || false,
    'ReplicationInstanceClass' => '<string>', // REQUIRED
    'ReplicationInstanceIdentifier' => '<string>', // REQUIRED
    'ReplicationSubnetGroupIdentifier' => '<string>',
    'ResourceIdentifier' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'ResourceArn' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ReplicationInstance' => [
        'AllocatedStorage' => <integer>,
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'DnsNameServers' => '<string>',
        'EngineVersion' => '<string>',
        'FreeUntil' => <DateTime>,
        'InstanceCreateTime' => <DateTime>,
        'KerberosAuthenticationSettings' => [
            'KeyCacheSecretIamArn' => '<string>',
            'KeyCacheSecretId' => '<string>',
            'Krb5FileContents' => '<string>',
        ],
        'KmsKeyId' => '<string>',
        'MultiAZ' => true || false,
        'NetworkType' => '<string>',
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'EngineVersion' => '<string>',
            'MultiAZ' => true || false,
            'NetworkType' => '<string>',
            'ReplicationInstanceClass' => '<string>',
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReplicationInstanceArn' => '<string>',
        'ReplicationInstanceClass' => '<string>',
        'ReplicationInstanceIdentifier' => '<string>',
        'ReplicationInstanceIpv6Addresses' => ['<string>', ...],
        'ReplicationInstancePrivateIpAddress' => '<string>',
        'ReplicationInstancePrivateIpAddresses' => ['<string>', ...],
        'ReplicationInstancePublicIpAddress' => '<string>',
        'ReplicationInstancePublicIpAddresses' => ['<string>', ...],
        'ReplicationInstanceStatus' => '<string>',
        'ReplicationSubnetGroup' => [
            'IsReadOnly' => true || false,
            'ReplicationSubnetGroupDescription' => '<string>',
            'ReplicationSubnetGroupIdentifier' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'SupportedNetworkTypes' => ['<string>', ...],
            'VpcId' => '<string>',
        ],
        'SecondaryAvailabilityZone' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceAlreadyExistsFault:

The resource you are attempting to create already exists.

InsufficientResourceCapacityFault:

There are not enough resources allocated to the database migration.

ResourceQuotaExceededFault:

The quota for this resource quota has been exceeded.

StorageQuotaExceededFault:

The storage quota has been exceeded.

ResourceNotFoundFault:

The resource could not be found.

ReplicationSubnetGroupDoesNotCoverEnoughAZs:

The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

InvalidSubnet:

The subnet provided isn't valid.

KMSKeyNotAccessibleFault:

DMS cannot access the KMS key.

Examples

Example 1: Create replication instance

Creates the replication instance using the specified parameters.

$result = $client->createReplicationInstance([
    'AllocatedStorage' => 123,
    'AutoMinorVersionUpgrade' => 1,
    'AvailabilityZone' => '',
    'EngineVersion' => '',
    'KmsKeyId' => '',
    'MultiAZ' => 1,
    'PreferredMaintenanceWindow' => '',
    'PubliclyAccessible' => 1,
    'ReplicationInstanceClass' => '',
    'ReplicationInstanceIdentifier' => '',
    'ReplicationSubnetGroupIdentifier' => '',
    'Tags' => [
        [
            'Key' => 'string',
            'Value' => 'string',
        ],
    ],
    'VpcSecurityGroupIds' => [
    ],
]);

Result syntax:

[
    'ReplicationInstance' => [
        'AllocatedStorage' => 5,
        'AutoMinorVersionUpgrade' => 1,
        'EngineVersion' => '1.5.0',
        'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
        'PendingModifiedValues' => [
        ],
        'PreferredMaintenanceWindow' => 'sun:06:00-sun:14:00',
        'PubliclyAccessible' => 1,
        'ReplicationInstanceArn' => 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
        'ReplicationInstanceClass' => 'dms.t2.micro',
        'ReplicationInstanceIdentifier' => 'test-rep-1',
        'ReplicationInstanceStatus' => 'creating',
        'ReplicationSubnetGroup' => [
            'ReplicationSubnetGroupDescription' => 'default',
            'ReplicationSubnetGroupIdentifier' => 'default',
            'SubnetGroupStatus' => 'Complete',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1d',
                    ],
                    'SubnetIdentifier' => 'subnet-f6dd91af',
                    'SubnetStatus' => 'Active',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1b',
                    ],
                    'SubnetIdentifier' => 'subnet-3605751d',
                    'SubnetStatus' => 'Active',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1c',
                    ],
                    'SubnetIdentifier' => 'subnet-c2daefb5',
                    'SubnetStatus' => 'Active',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1e',
                    ],
                    'SubnetIdentifier' => 'subnet-85e90cb8',
                    'SubnetStatus' => 'Active',
                ],
            ],
            'VpcId' => 'vpc-6741a603',
        ],
    ],
]

CreateReplicationSubnetGroup

$result = $client->createReplicationSubnetGroup([/* ... */]);
$promise = $client->createReplicationSubnetGroupAsync([/* ... */]);

Creates a replication subnet group given a list of the subnet IDs in a VPC.

The VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception.

If a replication subnet group exists in your Amazon Web Services account, the CreateReplicationSubnetGroup action returns the following error message: The Replication Subnet Group already exists. In this case, delete the existing replication subnet group. To do so, use the DeleteReplicationSubnetGroup action. Optionally, choose Subnet groups in the DMS console, then choose your subnet group. Next, choose Delete from Actions.

Parameter Syntax

$result = $client->createReplicationSubnetGroup([
    'ReplicationSubnetGroupDescription' => '<string>', // REQUIRED
    'ReplicationSubnetGroupIdentifier' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'ResourceArn' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ReplicationSubnetGroup' => [
        'IsReadOnly' => true || false,
        'ReplicationSubnetGroupDescription' => '<string>',
        'ReplicationSubnetGroupIdentifier' => '<string>',
        'SubnetGroupStatus' => '<string>',
        'Subnets' => [
            [
                'SubnetAvailabilityZone' => [
                    'Name' => '<string>',
                ],
                'SubnetIdentifier' => '<string>',
                'SubnetStatus' => '<string>',
            ],
            // ...
        ],
        'SupportedNetworkTypes' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceAlreadyExistsFault:

The resource you are attempting to create already exists.

ResourceNotFoundFault:

The resource could not be found.

ResourceQuotaExceededFault:

The quota for this resource quota has been exceeded.

ReplicationSubnetGroupDoesNotCoverEnoughAZs:

The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.

InvalidSubnet:

The subnet provided isn't valid.

Examples

Example 1: Create replication subnet group

Creates a replication subnet group given a list of the subnet IDs in a VPC.

$result = $client->createReplicationSubnetGroup([
    'ReplicationSubnetGroupDescription' => 'US West subnet group',
    'ReplicationSubnetGroupIdentifier' => 'us-west-2ab-vpc-215ds366',
    'SubnetIds' => [
        'subnet-e145356n',
        'subnet-58f79200',
    ],
    'Tags' => [
        [
            'Key' => 'Acount',
            'Value' => '145235',
        ],
    ],
]);

Result syntax:

[
    'ReplicationSubnetGroup' => [
    ],
]

CreateReplicationTask

$result = $client->createReplicationTask([/* ... */]);
$promise = $client->createReplicationTaskAsync([/* ... */]);

Creates a replication task using the specified parameters.

Parameter Syntax

$result = $client->createReplicationTask([
    'CdcStartPosition' => '<string>',
    'CdcStartTime' => <integer || string || DateTime>,
    'CdcStopPosition' => '<string>',
    'MigrationType' => 'full-load|cdc|full-load-and-cdc', // REQUIRED
    'ReplicationInstanceArn' => '<string>', // REQUIRED
    'ReplicationTaskIdentifier' => '<string>', // REQUIRED
    'ReplicationTaskSettings' => '<string>',
    'ResourceIdentifier' => '<string>',
    'SourceEndpointArn' => '<string>', // REQUIRED
    'TableMappings' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'ResourceArn' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetEndpointArn' => '<string>', // REQUIRED
    'TaskData' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ReplicationTask' => [
        'CdcStartPosition' => '<string>',
        'CdcStopPosition' => '<string>',
        'LastFailureMessage' => '<string>',
        'MigrationType' => 'full-load|cdc|full-load-and-cdc',
        'RecoveryCheckpoint' => '<string>',
        'ReplicationInstanceArn' => '<string>',
        'ReplicationTaskArn' => '<string>',
        'ReplicationTaskCreationDate' => <DateTime>,
        'ReplicationTaskIdentifier' => '<string>',
        'ReplicationTaskSettings' => '<string>',
        'ReplicationTaskStartDate' => <DateTime>,
        'ReplicationTaskStats' => [
            'ElapsedTimeMillis' => <integer>,
            'FreshStartDate' => <DateTime>,
            'FullLoadFinishDate' => <DateTime>,
            'FullLoadProgressPercent' => <integer>,
            'FullLoadStartDate' => <DateTime>,
            'StartDate' => <DateTime>,
            'StopDate' => <DateTime>,
            'TablesErrored' => <integer>,
            'TablesLoaded' => <integer>,
            'TablesLoading' => <integer>,
            'TablesQueued' => <integer>,
        ],
        'SourceEndpointArn' => '<string>',
        'Status' => '<string>',
        'StopReason' => '<string>',
        'TableMappings' => '<string>',
        'TargetEndpointArn' => '<string>',
        'TargetReplicationInstanceArn' => '<string>',
        'TaskData' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

ResourceAlreadyExistsFault:

The resource you are attempting to create already exists.

ResourceNotFoundFault:

The resource could not be found.

KMSKeyNotAccessibleFault:

DMS cannot access the KMS key.

ResourceQuotaExceededFault:

The quota for this resource quota has been exceeded.

Examples

Example 1: Create replication task

Creates a replication task using the specified parameters.

$result = $client->createReplicationTask([
    'CdcStartTime' => ,
    'MigrationType' => 'full-load',
    'ReplicationInstanceArn' => 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
    'ReplicationTaskIdentifier' => 'task1',
    'ReplicationTaskSettings' => '',
    'SourceEndpointArn' => 'arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE',
    'TableMappings' => 'file://mappingfile.json',
    'Tags' => [
        [
            'Key' => 'Acount',
            'Value' => '24352226',
        ],
    ],
    'TargetEndpointArn' => 'arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E',
]);

Result syntax:

[
    'ReplicationTask' => [
        'MigrationType' => 'full-load',
        'ReplicationInstanceArn' => 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
        'ReplicationTaskArn' => 'arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM',
        'ReplicationTaskCreationDate' => ,
        'ReplicationTaskIdentifier' => 'task1',
        'ReplicationTaskSettings' => '{"TargetMetadata":{"TargetSchema":"","SupportLobs":true,"FullLobMode":true,"LobChunkSize":64,"LimitedSizeLobMode":false,"LobMaxSize":0},"FullLoadSettings":{"FullLoadEnabled":true,"ApplyChangesEnabled":false,"TargetTablePrepMode":"DROP_AND_CREATE","CreatePkAfterFullLoad":false,"StopTaskCachedChangesApplied":false,"StopTaskCachedChangesNotApplied":false,"ResumeEnabled":false,"ResumeMinTableSize":100000,"ResumeOnlyClusteredPKTables":true,"MaxFullLoadSubTasks":8,"TransactionConsistencyTimeout":600,"CommitRate":10000},"Logging":{"EnableLogging":false}}',
        'SourceEndpointArn' => 'arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE',
        'Status' => 'creating',
        'TableMappings' => 'file://mappingfile.json',
        'TargetEndpointArn' => 'arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E',
    ],
]

DeleteCertificate

$result = $client->deleteCertificate([/* ... */]);
$promise = $client->deleteCertificateAsync([/* ... */]);

Deletes the specified certificate.

Parameter Syntax

$result = $client->deleteCertificate([
    'CertificateArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Certificate' => [
        'CertificateArn' => '<string>',
        'CertificateCreationDate' => <DateTime>,
        'CertificateIdentifier' => '<string>',
        'CertificateOwner' => '<string>',
        'CertificatePem' => '<string>',
        'CertificateWallet' => <string || resource || Psr\Http\Message\StreamInterface>,
        'KeyLength' => <integer>,
        'KmsKeyId' => '<string>',
        'SigningAlgorithm' => '<string>',
        'ValidFromDate' => <DateTime>,
        'ValidToDate' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

Examples

Example 1: Delete Certificate

Deletes the specified certificate.

$result = $client->deleteCertificate([
    'CertificateArn' => 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ',
]);

Result syntax:

[
    'Certificate' => [
    ],
]

DeleteConnection

$result = $client->deleteConnection([/* ... */]);
$promise = $client->deleteConnectionAsync([/* ... */]);

Deletes the connection between a replication instance and an endpoint.

Parameter Syntax

$result = $client->deleteConnection([
    'EndpointArn' => '<string>', // REQUIRED
    'ReplicationInstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Connection' => [
        'EndpointArn' => '<string>',
        'EndpointIdentifier' => '<string>',
        'LastFailureMessage' => '<string>',
        'ReplicationInstanceArn' => '<string>',
        'ReplicationInstanceIdentifier' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

Examples

Example 1: Delete Connection

Deletes the connection between the replication instance and the endpoint.

$result = $client->deleteConnection([
    'EndpointArn' => 'arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM',
    'ReplicationInstanceArn' => 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
]);

Result syntax:

[
    'Connection' => [
    ],
]

DeleteDataMigration

$result = $client->deleteDataMigration([/* ... */]);
$promise = $client->deleteDataMigrationAsync([/* ... */]);

Deletes the specified data migration.

Parameter Syntax

$result = $client->deleteDataMigration([
    'DataMigrationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DataMigration' => [
        'DataMigrationArn' => '<string>',
        'DataMigrationCidrBlocks' => ['<string>', ...],
        'DataMigrationCreateTime' => <DateTime>,
        'DataMigrationEndTime' => <DateTime>,
        'DataMigrationName' => '<string>',
        'DataMigrationSettings' => [
            'CloudwatchLogsEnabled' => true || false,
            'NumberOfJobs' => <integer>,
            'SelectionRules' => '<string>',
        ],
        'DataMigrationStartTime' => <DateTime>,
        'DataMigrationStatistics' => [
            'CDCLatency' => <integer>,
            'ElapsedTimeMillis' => <integer>,
            'FullLoadPercentage' => <integer>,
            'StartTime' => <DateTime>,
            'StopTime' => <DateTime>,
            'TablesErrored' => <integer>,
            'TablesLoaded' => <integer>,
            'TablesLoading' => <integer>,
            'TablesQueued' => <integer>,
        ],
        'DataMigrationStatus' => '<string>',
        'DataMigrationType' => 'full-load|cdc|full-load-and-cdc',
        'LastFailureMessage' => '<string>',
        'MigrationProjectArn' => '<string>',
        'PublicIpAddresses' => ['<string>', ...],
        'ServiceAccessRoleArn' => '<string>',
        'SourceDataSettings' => [
            [
                'CDCStartPosition' => '<string>',
                'CDCStartTime' => <DateTime>,
                'CDCStopTime' => <DateTime>,
                'SlotName' => '<string>',
            ],
            // ...
        ],
        'StopReason' => '<string>',
        'TargetDataSettings' => [
            [
                'TablePreparationMode' => 'drop-tables-on-target|truncate|do-nothing',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

ResourceNotFoundFault:

The resource could not be found.

FailedDependencyFault:

A dependency threw an exception.

DeleteDataProvider

$result = $client->deleteDataProvider([/* ... */]);
$promise = $client->deleteDataProviderAsync([/* ... */]);

Deletes the specified data provider.

Required permissions: dms:DeleteDataProvider. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameter Syntax

$result = $client->deleteDataProvider([
    'DataProviderIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DataProvider' => [
        'DataProviderArn' => '<string>',
        'DataProviderCreationTime' => <DateTime>,
        'DataProviderName' => '<string>',
        'Description' => '<string>',
        'Engine' => '<string>',
        'Settings' => [
            'DocDbSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'IbmDb2LuwSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'EncryptionAlgorithm' => <integer>,
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'SecurityMechanism' => <integer>,
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'IbmDb2zOsSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'MariaDbSettings' => [
                'CertificateArn' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'MicrosoftSqlServerSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'MongoDbSettings' => [
                'AuthMechanism' => 'default|mongodb_cr|scram_sha_1',
                'AuthSource' => '<string>',
                'AuthType' => 'no|password',
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'MySqlSettings' => [
                'CertificateArn' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'OracleSettings' => [
                'AsmServer' => '<string>',
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'SecretsManagerOracleAsmAccessRoleArn' => '<string>',
                'SecretsManagerOracleAsmSecretId' => '<string>',
                'SecretsManagerSecurityDbEncryptionAccessRoleArn' => '<string>',
                'SecretsManagerSecurityDbEncryptionSecretId' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'PostgreSqlSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
            'RedshiftSettings' => [
                'DatabaseName' => '<string>',
                'Port' => <integer>,
                'S3AccessRoleArn' => '<string>',
                'S3Path' => '<string>',
                'ServerName' => '<string>',
            ],
            'SybaseAseSettings' => [
                'CertificateArn' => '<string>',
                'DatabaseName' => '<string>',
                'EncryptPassword' => true || false,
                'Port' => <integer>,
                'ServerName' => '<string>',
                'SslMode' => 'none|require|verify-ca|verify-full',
            ],
        ],
        'Virtual' => true || false,
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

FailedDependencyFault:

A dependency threw an exception.

Examples

Example 1: Delete a data provider

The following example deletes a data provider identified by its ARN.

$result = $client->deleteDataProvider([
    'DataProviderIdentifier' => 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS',
]);

Result syntax:

[
    'DataProvider' => [
        'DataProviderArn' => 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS',
        'DataProviderCreationTime' => ,
        'DataProviderName' => 'example-data-provider',
        'Description' => 'Example data provider for documentation',
        'Engine' => 'sqlserver',
        'Settings' => [
            'MicrosoftSqlServerSettings' => [
                'CertificateArn' => 'arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS',
                'DatabaseName' => 'ExampleDatabase',
                'Port' => 1433,
                'ServerName' => 'example-source-server.us-east-1.rds.amazonaws.com',
                'SslMode' => 'verify-full',
            ],
        ],
    ],
]

DeleteEndpoint

$result = $client->deleteEndpoint([/* ... */]);
$promise = $client->deleteEndpointAsync([/* ... */]);

Deletes the specified endpoint.

Parameter Syntax

$result = $client->deleteEndpoint([
    'EndpointArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Endpoint' => [
        'CertificateArn' => '<string>',
        'DatabaseName' => '<string>',
        'DmsTransferSettings' => [
            'BucketName' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
        ],
        'DocDbSettings' => [
            'DatabaseName' => '<string>',
            'DocsToInvestigate' => <integer>,
            'ExtractDocId' => true || false,
            'KmsKeyId' => '<string>',
            'NestingLevel' => 'none|one',
            'Password' => '<string>',
            'Port' => <integer>,
            'ReplicateShardCollections' => true || false,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'UseUpdateLookUp' => true || false,
            'Username' => '<string>',
        ],
        'DynamoDbSettings' => [
            'ServiceAccessRoleArn' => '<string>',
        ],
        'ElasticsearchSettings' => [
            'EndpointUri' => '<string>',
            'ErrorRetryDuration' => <integer>,
            'FullLoadErrorPercentage' => <integer>,
            'ServiceAccessRoleArn' => '<string>',
            'UseNewMappingType' => true || false,
        ],
        'EndpointArn' => '<string>',
        'EndpointIdentifier' => '<string>',
        'EndpointType' => 'source|target',
        'EngineDisplayName' => '<string>',
        'EngineName' => '<string>',
        'ExternalId' => '<string>',
        'ExternalTableDefinition' => '<string>',
        'ExtraConnectionAttributes' => '<string>',
        'GcpMySQLSettings' => [
            'AfterConnectScript' => '<string>',
            'CleanSourceMetadataOnMismatch' => true || false,
            'DatabaseName' => '<string>',
            'EventsPollInterval' => <integer>,
            'MaxFileSize' => <integer>,
            'ParallelLoadThreads' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'ServerTimezone' => '<string>',
            'TargetDbType' => 'specific-database|multiple-databases',
            'Username' => '<string>',
        ],
        'IBMDb2Settings' => [
            'CurrentLsn' => '<string>',
            'DatabaseName' => '<string>',
            'KeepCsvFiles' => true || false,
            'LoadTimeout' => <integer>,
            'MaxFileSize' => <integer>,
            'MaxKBytesPerRead' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'SetDataCaptureChanges' => true || false,
            'Username' => '<string>',
            'WriteBufferSize' => <integer>,
        ],
        'IsReadOnly' => true || false,
        'KafkaSettings' => [
            'Broker' => '<string>',
            'IncludeControlDetails' => true || false,
            'IncludeNullAndEmpty' => true || false,
            'IncludePartitionValue' => true || false,
            'IncludeTableAlterOperations' => true || false,
            'IncludeTransactionDetails' => true || false,
            'MessageFormat' => 'json|json-unformatted',
            'MessageMaxBytes' => <integer>,
            'NoHexPrefix' => true || false,
            'PartitionIncludeSchemaTable' => true || false,
            'SaslMechanism' => 'scram-sha-512|plain',
            'SaslPassword' => '<string>',
            'SaslUsername' => '<string>',
            'SecurityProtocol' => 'plaintext|ssl-authentication|ssl-encryption|sasl-ssl',
            'SslCaCertificateArn' => '<string>',
            'SslClientCertificateArn' => '<string>',
            'SslClientKeyArn' => '<string>',
            'SslClientKeyPassword' => '<string>',
            'SslEndpointIdentificationAlgorithm' => 'none|https',
            'Topic' => '<string>',
            'UseLargeIntegerValue' => true || false,
        ],
        'KinesisSettings' => [
            'IncludeControlDetails' => true || false,
            'IncludeNullAndEmpty' => true || false,
            'IncludePartitionValue' => true || false,
            'IncludeTableAlterOperations' => true || false,
            'IncludeTransactionDetails' => true || false,
            'MessageFormat' => 'json|json-unformatted',
            'NoHexPrefix' => true || false,
            'PartitionIncludeSchemaTable' => true || false,
            'ServiceAccessRoleArn' => '<string>',
            'StreamArn' => '<string>',
            'UseLargeIntegerValue' => true || false,
        ],
        'KmsKeyId' => '<string>',
        'LakehouseSettings' => [
            'Arn' => '<string>',
        ],
        'MicrosoftSQLServerSettings' => [
            'AuthenticationMethod' => 'password|kerberos',
            'BcpPacketSize' => <integer>,
            'ControlTablesFileGroup' => '<string>',
            'DatabaseName' => '<string>',
            'ForceLobLookup' => true || false,
            'Password' => '<string>',
            'Port' => <integer>,
            'QuerySingleAlwaysOnNode' => true || false,
            'ReadBackupOnly' => true || false,
            'SafeguardPolicy' => 'rely-on-sql-server-replication-agent|exclusive-automatic-truncation|shared-automatic-truncation',
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'TlogAccessMode' => 'BackupOnly|PreferBackup|PreferTlog|TlogOnly',
            'TrimSpaceInChar' => true || false,
            'UseBcpFullLoad' => true || false,
            'UseThirdPartyBackupDevice' => true || false,
            'Username' => '<string>',
        ],
        'MongoDbSettings' => [
            'AuthMechanism' => 'default|mongodb_cr|scram_sha_1',
            'AuthSource' => '<string>',
            'AuthType' => 'no|password',
            'DatabaseName' => '<string>',
            'DocsToInvestigate' => '<string>',
            'ExtractDocId' => '<string>',
            'KmsKeyId' => '<string>',
            'NestingLevel' => 'none|one',
            'Password' => '<string>',
            'Port' => <integer>,
            'ReplicateShardCollections' => true || false,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'UseUpdateLookUp' => true || false,
            'Username' => '<string>',
        ],
        'MySQLSettings' => [
            'AfterConnectScript' => '<string>',
            'AuthenticationMethod' => 'password|iam',
            'CleanSourceMetadataOnMismatch' => true || false,
            'DatabaseName' => '<string>',
            'EventsPollInterval' => <integer>,
            'ExecuteTimeout' => <integer>,
            'MaxFileSize' => <integer>,
            'ParallelLoadThreads' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'ServerTimezone' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
            'TargetDbType' => 'specific-database|multiple-databases',
            'Username' => '<string>',
        ],
        'NeptuneSettings' => [
            'ErrorRetryDuration' => <integer>,
            'IamAuthEnabled' => true || false,
            'MaxFileSize' => <integer>,
            'MaxRetryCount' => <integer>,
            'S3BucketFolder' => '<string>',
            'S3BucketName' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
        ],
        'OracleSettings' => [
            'AccessAlternateDirectly' => true || false,
            'AddSupplementalLogging' => true || false,
            'AdditionalArchivedLogDestId' => <integer>,
            'AllowSelectNestedTables' => true || false,
            'ArchivedLogDestId' => <integer>,
            'ArchivedLogsOnly' => true || false,
            'AsmPassword' => '<string>',
            'AsmServer' => '<string>',
            'AsmUser' => '<string>',
            'AuthenticationMethod' => 'password|kerberos',
            'CharLengthSemantics' => 'default|char|byte',
            'ConvertTimestampWithZoneToUTC' => true || false,
            'DatabaseName' => '<string>',
            'DirectPathNoLog' => true || false,
            'DirectPathParallelLoad' => true || false,
            'EnableHomogenousTablespace' => true || false,
            'ExtraArchivedLogDestIds' => [<integer>, ...],
            'FailTasksOnLobTruncation' => true || false,
            'NumberDatatypeScale' => <integer>,
            'OpenTransactionWindow' => <integer>,
            'OraclePathPrefix' => '<string>',
            'ParallelAsmReadThreads' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'ReadAheadBlocks' => <integer>,
            'ReadTableSpaceName' => true || false,
            'ReplacePathPrefix' => true || false,
            'RetryInterval' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerOracleAsmAccessRoleArn' => '<string>',
            'SecretsManagerOracleAsmSecretId' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'SecurityDbEncryption' => '<string>',
            'SecurityDbEncryptionName' => '<string>',
            'ServerName' => '<string>',
            'SpatialDataOptionToGeoJsonFunctionName' => '<string>',
            'StandbyDelayTime' => <integer>,
            'TrimSpaceInChar' => true || false,
            'UseAlternateFolderForOnline' => true || false,
            'UseBFile' => true || false,
            'UseDirectPathFullLoad' => true || false,
            'UseLogminerReader' => true || false,
            'UsePathPrefix' => '<string>',
            'Username' => '<string>',
        ],
        'Port' => <integer>,
        'PostgreSQLSettings' => [
            'AfterConnectScript' => '<string>',
            'AuthenticationMethod' => 'password|iam',
            'BabelfishDatabaseName' => '<string>',
            'CaptureDdls' => true || false,
            'DatabaseMode' => 'default|babelfish',
            'DatabaseName' => '<string>',
            'DdlArtifactsSchema' => '<string>',
            'DisableUnicodeSourceFilter' => true || false,
            'ExecuteTimeout' => <integer>,
            'FailTasksOnLobTruncation' => true || false,
            'HeartbeatEnable' => true || false,
            'HeartbeatFrequency' => <integer>,
            'HeartbeatSchema' => '<string>',
            'MapBooleanAsBoolean' => true || false,
            'MapJsonbAsClob' => true || false,
            'MapLongVarcharAs' => 'wstring|clob|nclob',
            'MaxFileSize' => <integer>,
            'Password' => '<string>',
            'PluginName' => 'no-preference|test-decoding|pglogical',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
            'SlotName' => '<string>',
            'TrimSpaceInChar' => true || false,
            'Username' => '<string>',
        ],
        'RedisSettings' => [
            'AuthPassword' => '<string>',
            'AuthType' => 'none|auth-role|auth-token',
            'AuthUserName' => '<string>',
            'Port' => <integer>,
            'ServerName' => '<string>',
            'SslCaCertificateArn' => '<string>',
            'SslSecurityProtocol' => 'plaintext|ssl-encryption',
        ],
        'RedshiftSettings' => [
            'AcceptAnyDate' => true || false,
            'AfterConnectScript' => '<string>',
            'BucketFolder' => '<string>',
            'BucketName' => '<string>',
            'CaseSensitiveNames' => true || false,
            'CompUpdate' => true || false,
            'ConnectionTimeout' => <integer>,
            'DatabaseName' => '<string>',
            'DateFormat' => '<string>',
            'EmptyAsNull' => true || false,
            'EncryptionMode' => 'sse-s3|sse-kms',
            'ExplicitIds' => true || false,
            'FileTransferUploadStreams' => <integer>,
            'LoadTimeout' => <integer>,
            'MapBooleanAsBoolean' => true || false,
            'MaxFileSize' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'RemoveQuotes' => true || false,
            'ReplaceChars' => '<string>',
            'ReplaceInvalidChars' => '<string>',
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'ServerSideEncryptionKmsKeyId' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
            'TimeFormat' => '<string>',
            'TrimBlanks' => true || false,
            'TruncateColumns' => true || false,
            'Username' => '<string>',
            'WriteBufferSize' => <integer>,
        ],
        'S3Settings' => [
            'AddColumnName' => true || false,
            'AddTrailingPaddingCharacter' => true || false,
            'BucketFolder' => '<string>',
            'BucketName' => '<string>',
            'CannedAclForObjects' => 'none|private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control',
            'CdcInsertsAndUpdates' => true || false,
            'CdcInsertsOnly' => true || false,
            'CdcMaxBatchInterval' => <integer>,
            'CdcMinFileSize' => <integer>,
            'CdcPath' => '<string>',
            'CompressionType' => 'none|gzip',
            'CsvDelimiter' => '<string>',
            'CsvNoSupValue' => '<string>',
            'CsvNullValue' => '<string>',
            'CsvRowDelimiter' => '<string>',
            'DataFormat' => 'csv|parquet',
            'DataPageSize' => <integer>,
            'DatePartitionDelimiter' => 'SLASH|UNDERSCORE|DASH|NONE',
            'DatePartitionEnabled' => true || false,
            'DatePartitionSequence' => 'YYYYMMDD|YYYYMMDDHH|YYYYMM|MMYYYYDD|DDMMYYYY',
            'DatePartitionTimezone' => '<string>',
            'DictPageSizeLimit' => <integer>,
            'EnableStatistics' => true || false,
            'EncodingType' => 'plain|plain-dictionary|rle-dictionary',
            'EncryptionMode' => 'sse-s3|sse-kms',
            'ExpectedBucketOwner' => '<string>',
            'ExternalTableDefinition' => '<string>',
            'GlueCatalogGeneration' => true || false,
            'IgnoreHeaderRows' => <integer>,
            'IncludeOpForFullLoad' => true || false,
            'MaxFileSize' => <integer>,
            'ParquetTimestampInMillisecond' => true || false,
            'ParquetVersion' => 'parquet-1-0|parquet-2-0',
            'PreserveTransactions' => true || false,
            'Rfc4180' => true || false,
            'RowGroupLength' => <integer>,
            'ServerSideEncryptionKmsKeyId' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
            'TimestampColumnName' => '<string>',
            'UseCsvNoSupValue' => true || false,
            'UseTaskStartTimeForFullLoadTimestamp' => true || false,
        ],
        'ServerName' => '<string>',
        'ServiceAccessRoleArn' => '<string>',
        'SslMode' => 'none|require|verify-ca|verify-full',
        'Status' => '<string>',
        'SybaseSettings' => [
            'DatabaseName' => '<string>',
            'Password' => '<string>',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'Username' => '<string>',
        ],
        'TimestreamSettings' => [
            'CdcInsertsAndUpdates' => true || false,
            'DatabaseName' => '<string>',
            'EnableMagneticStoreWrites' => true || false,
            'MagneticDuration' => <integer>,
            'MemoryDuration' => <integer>,
        ],
        'Username' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

Examples

Example 1: Delete Endpoint

Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.

$result = $client->deleteEndpoint([
    'EndpointArn' => 'arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM',
]);

Result syntax:

[
    'Endpoint' => [
        'EndpointArn' => 'arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM',
        'EndpointIdentifier' => 'test-endpoint-1',
        'EndpointType' => 'source',
        'EngineName' => 'mysql',
        'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
        'Port' => 3306,
        'ServerName' => 'mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com',
        'Status' => 'active',
        'Username' => 'username',
    ],
]

DeleteEventSubscription

$result = $client->deleteEventSubscription([/* ... */]);
$promise = $client->deleteEventSubscriptionAsync([/* ... */]);

Deletes an DMS event subscription.

Parameter Syntax

$result = $client->deleteEventSubscription([
    'SubscriptionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

DeleteFleetAdvisorCollector

$result = $client->deleteFleetAdvisorCollector([/* ... */]);
$promise = $client->deleteFleetAdvisorCollectorAsync([/* ... */]);

End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

Deletes the specified Fleet Advisor collector.

Parameter Syntax

$result = $client->deleteFleetAdvisorCollector([
    'CollectorReferencedId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

CollectorNotFoundFault:

The specified collector doesn't exist.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

DeleteFleetAdvisorDatabases

$result = $client->deleteFleetAdvisorDatabases([/* ... */]);
$promise = $client->deleteFleetAdvisorDatabasesAsync([/* ... */]);

End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

Deletes the specified Fleet Advisor collector databases.

Parameter Syntax

$result = $client->deleteFleetAdvisorDatabases([
    'DatabaseIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DatabaseIds' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidOperationFault:

The action or operation requested isn't valid.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

DeleteInstanceProfile

$result = $client->deleteInstanceProfile([/* ... */]);
$promise = $client->deleteInstanceProfileAsync([/* ... */]);

Deletes the specified instance profile.

Required permissions: dms:DeleteInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameter Syntax

$result = $client->deleteInstanceProfile([
    'InstanceProfileIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'InstanceProfile' => [
        'AvailabilityZone' => '<string>',
        'Description' => '<string>',
        'InstanceProfileArn' => '<string>',
        'InstanceProfileCreationTime' => <DateTime>,
        'InstanceProfileName' => '<string>',
        'KmsKeyArn' => '<string>',
        'NetworkType' => '<string>',
        'PubliclyAccessible' => true || false,
        'SubnetGroupIdentifier' => '<string>',
        'VpcSecurityGroups' => ['<string>', ...],
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

FailedDependencyFault:

A dependency threw an exception.

Examples

Example 1: Delete an instance profile

The following example deletes an instance profile identified by its ARN.

$result = $client->deleteInstanceProfile([
    'InstanceProfileIdentifier' => 'arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS',
]);

Result syntax:

[
    'InstanceProfile' => [
        'Description' => 'Example instance profile for documentation',
        'InstanceProfileArn' => 'arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS',
        'InstanceProfileCreationTime' => ,
        'InstanceProfileName' => 'example-instance-profile',
        'KmsKeyArn' => 'arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
        'NetworkType' => 'IPV4',
        'PubliclyAccessible' => ,
        'SubnetGroupIdentifier' => 'example-replication-subnet-group',
        'VpcSecurityGroups' => [
            'sg-0123456789abcdef0',
        ],
    ],
]

DeleteMigrationProject

$result = $client->deleteMigrationProject([/* ... */]);
$promise = $client->deleteMigrationProjectAsync([/* ... */]);

Deletes the specified migration project.

Required permissions: dms:DeleteMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameter Syntax

$result = $client->deleteMigrationProject([
    'MigrationProjectIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'MigrationProject' => [
        'Description' => '<string>',
        'InstanceProfileArn' => '<string>',
        'InstanceProfileName' => '<string>',
        'MigrationProjectArn' => '<string>',
        'MigrationProjectCreationTime' => <DateTime>,
        'MigrationProjectName' => '<string>',
        'SchemaConversionApplicationAttributes' => [
            'S3BucketPath' => '<string>',
            'S3BucketRoleArn' => '<string>',
        ],
        'SourceDataProviderDescriptors' => [
            [
                'DataProviderArn' => '<string>',
                'DataProviderName' => '<string>',
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
            ],
            // ...
        ],
        'TargetDataProviderDescriptors' => [
            [
                'DataProviderArn' => '<string>',
                'DataProviderName' => '<string>',
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
            ],
            // ...
        ],
        'TransformationRules' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceNotFoundFault:

The resource could not be found.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

FailedDependencyFault:

A dependency threw an exception.

Examples

Example 1: Delete a migration project

The following example deletes a migration project identified by its ARN.

$result = $client->deleteMigrationProject([
    'MigrationProjectIdentifier' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
]);

Result syntax:

[
    'MigrationProject' => [
        'Description' => 'Example migration project for documentation',
        'InstanceProfileArn' => 'arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS',
        'InstanceProfileName' => 'example-instance-profile',
        'MigrationProjectArn' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
        'MigrationProjectCreationTime' => ,
        'MigrationProjectName' => 'example-migration-project',
        'SchemaConversionApplicationAttributes' => [
            'S3BucketPath' => 's3://amzn-s3-demo-bucket',
            'S3BucketRoleArn' => 'arn:aws:iam::111122223333:role/example-s3-access-role',
        ],
        'SourceDataProviderDescriptors' => [
            [
                'DataProviderArn' => 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS',
                'DataProviderName' => 'example-data-provider',
                'SecretsManagerAccessRoleArn' => 'arn:aws:iam::111122223333:role/example-secrets-manager-role',
                'SecretsManagerSecretId' => 'arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3',
            ],
        ],
        'TargetDataProviderDescriptors' => [
            [
                'DataProviderArn' => 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS',
                'DataProviderName' => 'example-data-provider',
                'SecretsManagerAccessRoleArn' => 'arn:aws:iam::111122223333:role/example-secrets-manager-role',
                'SecretsManagerSecretId' => 'arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3',
            ],
        ],
        'TransformationRules' => '{"rules":[{"rule-type":"transformation","rule-id":"1","rule-name":"1","rule-target":"schema","rule-action":"rename","object-locator":{"schema-name":"ExampleSchema"},"value":"TargetSchema"}]}',
    ],
]

DeleteReplicationConfig

$result = $client->deleteReplicationConfig([/* ... */]);
$promise = $client->deleteReplicationConfigAsync([/* ... */]);

Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all replications that use this configuration. You can't delete the configuration for an DMS Serverless replication that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.

Parameter Syntax

$result = $client->deleteReplicationConfig([
    'ReplicationConfigArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ReplicationConfig' => [
        'ComputeConfig' => [
            'AvailabilityZone' => '<string>',
            'DnsNameServers' => '<string>',
            'KmsKeyId' => '<string>',
            'MaxCapacityUnits' => <integer>,
            'MinCapacityUnits' => <integer>,
            'MultiAZ' => true || false,
            'PreferredMaintenanceWindow' => '<string>',
            'ReplicationSubnetGroupId' => '<string>',
            'VpcSecurityGroupIds' => ['<string>', ...],
        ],
        'IsReadOnly' => true || false,
        'ReplicationConfigArn' => '<string>',
        'ReplicationConfigCreateTime' => <DateTime>,
        'ReplicationConfigIdentifier' => '<string>',
        'ReplicationConfigUpdateTime' => <DateTime>,
        'ReplicationSettings' => '<string>',
        'ReplicationType' => 'full-load|cdc|full-load-and-cdc',
        'SourceEndpointArn' => '<string>',
        'SupplementalSettings' => '<string>',
        'TableMappings' => '<string>',
        'TargetEndpointArn' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

DeleteReplicationInstance

$result = $client->deleteReplicationInstance([/* ... */]);
$promise = $client->deleteReplicationInstanceAsync([/* ... */]);

Deletes the specified replication instance.

Parameter Syntax

$result = $client->deleteReplicationInstance([
    'ReplicationInstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ReplicationInstance' => [
        'AllocatedStorage' => <integer>,
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'DnsNameServers' => '<string>',
        'EngineVersion' => '<string>',
        'FreeUntil' => <DateTime>,
        'InstanceCreateTime' => <DateTime>,
        'KerberosAuthenticationSettings' => [
            'KeyCacheSecretIamArn' => '<string>',
            'KeyCacheSecretId' => '<string>',
            'Krb5FileContents' => '<string>',
        ],
        'KmsKeyId' => '<string>',
        'MultiAZ' => true || false,
        'NetworkType' => '<string>',
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'EngineVersion' => '<string>',
            'MultiAZ' => true || false,
            'NetworkType' => '<string>',
            'ReplicationInstanceClass' => '<string>',
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReplicationInstanceArn' => '<string>',
        'ReplicationInstanceClass' => '<string>',
        'ReplicationInstanceIdentifier' => '<string>',
        'ReplicationInstanceIpv6Addresses' => ['<string>', ...],
        'ReplicationInstancePrivateIpAddress' => '<string>',
        'ReplicationInstancePrivateIpAddresses' => ['<string>', ...],
        'ReplicationInstancePublicIpAddress' => '<string>',
        'ReplicationInstancePublicIpAddresses' => ['<string>', ...],
        'ReplicationInstanceStatus' => '<string>',
        'ReplicationSubnetGroup' => [
            'IsReadOnly' => true || false,
            'ReplicationSubnetGroupDescription' => '<string>',
            'ReplicationSubnetGroupIdentifier' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'SupportedNetworkTypes' => ['<string>', ...],
            'VpcId' => '<string>',
        ],
        'SecondaryAvailabilityZone' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

ResourceNotFoundFault:

The resource could not be found.

Examples

Example 1: Delete Replication Instance

Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.

$result = $client->deleteReplicationInstance([
    'ReplicationInstanceArn' => 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
]);

Result syntax:

[
    'ReplicationInstance' => [
        'AllocatedStorage' => 5,
        'AutoMinorVersionUpgrade' => 1,
        'EngineVersion' => '1.5.0',
        'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
        'PendingModifiedValues' => [
        ],
        'PreferredMaintenanceWindow' => 'sun:06:00-sun:14:00',
        'PubliclyAccessible' => 1,
        'ReplicationInstanceArn' => 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
        'ReplicationInstanceClass' => 'dms.t2.micro',
        'ReplicationInstanceIdentifier' => 'test-rep-1',
        'ReplicationInstanceStatus' => 'creating',
        'ReplicationSubnetGroup' => [
            'ReplicationSubnetGroupDescription' => 'default',
            'ReplicationSubnetGroupIdentifier' => 'default',
            'SubnetGroupStatus' => 'Complete',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1d',
                    ],
                    'SubnetIdentifier' => 'subnet-f6dd91af',
                    'SubnetStatus' => 'Active',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1b',
                    ],
                    'SubnetIdentifier' => 'subnet-3605751d',
                    'SubnetStatus' => 'Active',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1c',
                    ],
                    'SubnetIdentifier' => 'subnet-c2daefb5',
                    'SubnetStatus' => 'Active',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-east-1e',
                    ],
                    'SubnetIdentifier' => 'subnet-85e90cb8',
                    'SubnetStatus' => 'Active',
                ],
            ],
            'VpcId' => 'vpc-6741a603',
        ],
    ],
]

DeleteReplicationSubnetGroup

$result = $client->deleteReplicationSubnetGroup([/* ... */]);
$promise = $client->deleteReplicationSubnetGroupAsync([/* ... */]);

Deletes a subnet group.

Parameter Syntax

$result = $client->deleteReplicationSubnetGroup([
    'ReplicationSubnetGroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

ResourceNotFoundFault:

The resource could not be found.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

Examples

Example 1: Delete Replication Subnet Group

Deletes a replication subnet group.

$result = $client->deleteReplicationSubnetGroup([
    'ReplicationSubnetGroupIdentifier' => 'us-west-2ab-vpc-215ds366',
]);

Result syntax:

[
]

DeleteReplicationTask

$result = $client->deleteReplicationTask([/* ... */]);
$promise = $client->deleteReplicationTaskAsync([/* ... */]);

Deletes the specified replication task.

Parameter Syntax

$result = $client->deleteReplicationTask([
    'ReplicationTaskArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ReplicationTask' => [
        'CdcStartPosition' => '<string>',
        'CdcStopPosition' => '<string>',
        'LastFailureMessage' => '<string>',
        'MigrationType' => 'full-load|cdc|full-load-and-cdc',
        'RecoveryCheckpoint' => '<string>',
        'ReplicationInstanceArn' => '<string>',
        'ReplicationTaskArn' => '<string>',
        'ReplicationTaskCreationDate' => <DateTime>,
        'ReplicationTaskIdentifier' => '<string>',
        'ReplicationTaskSettings' => '<string>',
        'ReplicationTaskStartDate' => <DateTime>,
        'ReplicationTaskStats' => [
            'ElapsedTimeMillis' => <integer>,
            'FreshStartDate' => <DateTime>,
            'FullLoadFinishDate' => <DateTime>,
            'FullLoadProgressPercent' => <integer>,
            'FullLoadStartDate' => <DateTime>,
            'StartDate' => <DateTime>,
            'StopDate' => <DateTime>,
            'TablesErrored' => <integer>,
            'TablesLoaded' => <integer>,
            'TablesLoading' => <integer>,
            'TablesQueued' => <integer>,
        ],
        'SourceEndpointArn' => '<string>',
        'Status' => '<string>',
        'StopReason' => '<string>',
        'TableMappings' => '<string>',
        'TargetEndpointArn' => '<string>',
        'TargetReplicationInstanceArn' => '<string>',
        'TaskData' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

Examples

Example 1: Delete Replication Task

Deletes the specified replication task.

$result = $client->deleteReplicationTask([
    'ReplicationTaskArn' => 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
]);

Result syntax:

[
    'ReplicationTask' => [
        'MigrationType' => 'full-load',
        'ReplicationInstanceArn' => 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
        'ReplicationTaskArn' => 'arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM',
        'ReplicationTaskCreationDate' => ,
        'ReplicationTaskIdentifier' => 'task1',
        'ReplicationTaskSettings' => '{"TargetMetadata":{"TargetSchema":"","SupportLobs":true,"FullLobMode":true,"LobChunkSize":64,"LimitedSizeLobMode":false,"LobMaxSize":0},"FullLoadSettings":{"FullLoadEnabled":true,"ApplyChangesEnabled":false,"TargetTablePrepMode":"DROP_AND_CREATE","CreatePkAfterFullLoad":false,"StopTaskCachedChangesApplied":false,"StopTaskCachedChangesNotApplied":false,"ResumeEnabled":false,"ResumeMinTableSize":100000,"ResumeOnlyClusteredPKTables":true,"MaxFullLoadSubTasks":8,"TransactionConsistencyTimeout":600,"CommitRate":10000},"Logging":{"EnableLogging":false}}',
        'SourceEndpointArn' => 'arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE',
        'Status' => 'creating',
        'TableMappings' => 'file://mappingfile.json',
        'TargetEndpointArn' => 'arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E',
    ],
]

DeleteReplicationTaskAssessmentRun

$result = $client->deleteReplicationTaskAssessmentRun([/* ... */]);
$promise = $client->deleteReplicationTaskAssessmentRunAsync([/* ... */]);

Deletes the record of a single premigration assessment run.

This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.

Parameter Syntax

$result = $client->deleteReplicationTaskAssessmentRun([
    'ReplicationTaskAssessmentRunArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ReplicationTaskAssessmentRun' => [
        'AssessmentProgress' => [
            'IndividualAssessmentCompletedCount' => <integer>,
            'IndividualAssessmentCount' => <integer>,
        ],
        'AssessmentRunName' => '<string>',
        'IsLatestTaskAssessmentRun' => true || false,
        'LastFailureMessage' => '<string>',
        'ReplicationTaskArn' => '<string>',
        'ReplicationTaskAssessmentRunArn' => '<string>',
        'ReplicationTaskAssessmentRunCreationDate' => <DateTime>,
        'ResultEncryptionMode' => '<string>',
        'ResultKmsKeyArn' => '<string>',
        'ResultLocationBucket' => '<string>',
        'ResultLocationFolder' => '<string>',
        'ResultStatistic' => [
            'Cancelled' => <integer>,
            'Error' => <integer>,
            'Failed' => <integer>,
            'Passed' => <integer>,
            'Skipped' => <integer>,
            'Warning' => <integer>,
        ],
        'ServiceAccessRoleArn' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

DescribeAccountAttributes

$result = $client->describeAccountAttributes([/* ... */]);
$promise = $client->describeAccountAttributesAsync([/* ... */]);

Lists all of the DMS attributes for a customer account. These attributes include DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region.

This command does not take any parameters.

Parameter Syntax

$result = $client->describeAccountAttributes([
]);

Parameter Details

Result Syntax

[
    'AccountQuotas' => [
        [
            'AccountQuotaName' => '<string>',
            'Max' => <integer>,
            'Used' => <integer>,
        ],
        // ...
    ],
    'UniqueAccountIdentifier' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

Examples

Example 1: Describe acount attributes

Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This operation does not take any parameters.

$result = $client->describeAccountAttributes([
]);

Result syntax:

[
    'AccountQuotas' => [
        [
            'AccountQuotaName' => 'ReplicationInstances',
            'Max' => 20,
            'Used' => 0,
        ],
        [
            'AccountQuotaName' => 'AllocatedStorage',
            'Max' => 20,
            'Used' => 0,
        ],
        [
            'AccountQuotaName' => 'Endpoints',
            'Max' => 20,
            'Used' => 0,
        ],
    ],
]

DescribeApplicableIndividualAssessments

$result = $client->describeApplicableIndividualAssessments([/* ... */]);
$promise = $client->describeApplicableIndividualAssessmentsAsync([/* ... */]);

Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.

If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run.

To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task.

If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.

Parameter Syntax

$result = $client->describeApplicableIndividualAssessments([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'MigrationType' => 'full-load|cdc|full-load-and-cdc',
    'ReplicationConfigArn' => '<string>',
    'ReplicationInstanceArn' => '<string>',
    'ReplicationTaskArn' => '<string>',
    'SourceEngineName' => '<string>',
    'TargetEngineName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'IndividualAssessmentNames' => ['<string>', ...],
    'Marker' => '<string>',
]

Result Details

Errors

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

ResourceNotFoundFault:

The resource could not be found.

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

DescribeCertificates

$result = $client->describeCertificates([/* ... */]);
$promise = $client->describeCertificatesAsync([/* ... */]);

Provides a description of the certificate.

Parameter Syntax

$result = $client->describeCertificates([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Certificates' => [
        [
            'CertificateArn' => '<string>',
            'CertificateCreationDate' => <DateTime>,
            'CertificateIdentifier' => '<string>',
            'CertificateOwner' => '<string>',
            'CertificatePem' => '<string>',
            'CertificateWallet' => <string || resource || Psr\Http\Message\StreamInterface>,
            'KeyLength' => <integer>,
            'KmsKeyId' => '<string>',
            'SigningAlgorithm' => '<string>',
            'ValidFromDate' => <DateTime>,
            'ValidToDate' => <DateTime>,
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

Examples

Example 1: Describe certificates

Provides a description of the certificate.

$result = $client->describeCertificates([
    'Filters' => [
        [
            'Name' => 'string',
            'Values' => [
                'string',
                'string',
            ],
        ],
    ],
    'Marker' => '',
    'MaxRecords' => 123,
]);

Result syntax:

[
    'Certificates' => [
    ],
    'Marker' => '',
]

DescribeConnections

$result = $client->describeConnections([/* ... */]);
$promise = $client->describeConnectionsAsync([/* ... */]);

Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

Parameter Syntax

$result = $client->describeConnections([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Connections' => [
        [
            'EndpointArn' => '<string>',
            'EndpointIdentifier' => '<string>',
            'LastFailureMessage' => '<string>',
            'ReplicationInstanceArn' => '<string>',
            'ReplicationInstanceIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

Examples

Example 1: Describe connections

Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

$result = $client->describeConnections([
    'Filters' => [
        [
            'Name' => 'string',
            'Values' => [
                'string',
                'string',
            ],
        ],
    ],
    'Marker' => '',
    'MaxRecords' => 123,
]);

Result syntax:

[
    'Connections' => [
        [
            'EndpointArn' => 'arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE',
            'EndpointIdentifier' => 'testsrc1',
            'ReplicationInstanceArn' => 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
            'ReplicationInstanceIdentifier' => 'test',
            'Status' => 'successful',
        ],
    ],
    'Marker' => '',
]

DescribeConversionConfiguration

$result = $client->describeConversionConfiguration([/* ... */]);
$promise = $client->describeConversionConfigurationAsync([/* ... */]);

Returns configuration parameters for a schema conversion project.

Required permissions: dms:DescribeConversionConfiguration. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameter Syntax

$result = $client->describeConversionConfiguration([
    'MigrationProjectIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConversionConfiguration' => '<string>',
    'MigrationProjectIdentifier' => '<string>',
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

Examples

Example 1: Retrieving conversion configuration for a migration project

The following example retrieves the conversion configuration for a migration project.

$result = $client->describeConversionConfiguration([
    'MigrationProjectIdentifier' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
]);

Result syntax:

[
    'ConversionConfiguration' => '{"Common project settings":{"ShowSeverityLevelInSql":"CRITICAL","EnableGenAiConversion":false},"MSSQL_TO_AURORA_POSTGRESQL":{"ConvertProceduresToFunction":true,"UniqueIndexGeneration":true,"CaseSensitivityNames":false},"Conversion version":{"MSSQL_TO_AURORA_POSTGRESQL_target_engine_version":"15"}}',
    'MigrationProjectIdentifier' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
]

DescribeDataMigrations

$result = $client->describeDataMigrations([/* ... */]);
$promise = $client->describeDataMigrationsAsync([/* ... */]);

Returns information about data migrations.

Parameter Syntax

$result = $client->describeDataMigrations([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'WithoutSettings' => true || false,
    'WithoutStatistics' => true || false,
]);

Parameter Details

Result Syntax

[
    'DataMigrations' => [
        [
            'DataMigrationArn' => '<string>',
            'DataMigrationCidrBlocks' => ['<string>', ...],
            'DataMigrationCreateTime' => <DateTime>,
            'DataMigrationEndTime' => <DateTime>,
            'DataMigrationName' => '<string>',
            'DataMigrationSettings' => [
                'CloudwatchLogsEnabled' => true || false,
                'NumberOfJobs' => <integer>,
                'SelectionRules' => '<string>',
            ],
            'DataMigrationStartTime' => <DateTime>,
            'DataMigrationStatistics' => [
                'CDCLatency' => <integer>,
                'ElapsedTimeMillis' => <integer>,
                'FullLoadPercentage' => <integer>,
                'StartTime' => <DateTime>,
                'StopTime' => <DateTime>,
                'TablesErrored' => <integer>,
                'TablesLoaded' => <integer>,
                'TablesLoading' => <integer>,
                'TablesQueued' => <integer>,
            ],
            'DataMigrationStatus' => '<string>',
            'DataMigrationType' => 'full-load|cdc|full-load-and-cdc',
            'LastFailureMessage' => '<string>',
            'MigrationProjectArn' => '<string>',
            'PublicIpAddresses' => ['<string>', ...],
            'ServiceAccessRoleArn' => '<string>',
            'SourceDataSettings' => [
                [
                    'CDCStartPosition' => '<string>',
                    'CDCStartTime' => <DateTime>,
                    'CDCStopTime' => <DateTime>,
                    'SlotName' => '<string>',
                ],
                // ...
            ],
            'StopReason' => '<string>',
            'TargetDataSettings' => [
                [
                    'TablePreparationMode' => 'drop-tables-on-target|truncate|do-nothing',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

ResourceNotFoundFault:

The resource could not be found.

FailedDependencyFault:

A dependency threw an exception.

DescribeDataProviders

$result = $client->describeDataProviders([/* ... */]);
$promise = $client->describeDataProvidersAsync([/* ... */]);

Returns a paginated list of data providers for your account in the current region.

Required permissions: dms:ListDataProviders. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameter Syntax

$result = $client->describeDataProviders([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'DataProviders' => [
        [
            'DataProviderArn' => '<string>',
            'DataProviderCreationTime' => <DateTime>,
            'DataProviderName' => '<string>',
            'Description' => '<string>',
            'Engine' => '<string>',
            'Settings' => [
                'DocDbSettings' => [
                    'CertificateArn' => '<string>',
                    'DatabaseName' => '<string>',
                    'Port' => <integer>,
                    'ServerName' => '<string>',
                    'SslMode' => 'none|require|verify-ca|verify-full',
                ],
                'IbmDb2LuwSettings' => [
                    'CertificateArn' => '<string>',
                    'DatabaseName' => '<string>',
                    'EncryptionAlgorithm' => <integer>,
                    'Port' => <integer>,
                    'S3AccessRoleArn' => '<string>',
                    'S3Path' => '<string>',
                    'SecurityMechanism' => <integer>,
                    'ServerName' => '<string>',
                    'SslMode' => 'none|require|verify-ca|verify-full',
                ],
                'IbmDb2zOsSettings' => [
                    'CertificateArn' => '<string>',
                    'DatabaseName' => '<string>',
                    'Port' => <integer>,
                    'S3AccessRoleArn' => '<string>',
                    'S3Path' => '<string>',
                    'ServerName' => '<string>',
                    'SslMode' => 'none|require|verify-ca|verify-full',
                ],
                'MariaDbSettings' => [
                    'CertificateArn' => '<string>',
                    'Port' => <integer>,
                    'S3AccessRoleArn' => '<string>',
                    'S3Path' => '<string>',
                    'ServerName' => '<string>',
                    'SslMode' => 'none|require|verify-ca|verify-full',
                ],
                'MicrosoftSqlServerSettings' => [
                    'CertificateArn' => '<string>',
                    'DatabaseName' => '<string>',
                    'Port' => <integer>,
                    'S3AccessRoleArn' => '<string>',
                    'S3Path' => '<string>',
                    'ServerName' => '<string>',
                    'SslMode' => 'none|require|verify-ca|verify-full',
                ],
                'MongoDbSettings' => [
                    'AuthMechanism' => 'default|mongodb_cr|scram_sha_1',
                    'AuthSource' => '<string>',
                    'AuthType' => 'no|password',
                    'CertificateArn' => '<string>',
                    'DatabaseName' => '<string>',
                    'Port' => <integer>,
                    'ServerName' => '<string>',
                    'SslMode' => 'none|require|verify-ca|verify-full',
                ],
                'MySqlSettings' => [
                    'CertificateArn' => '<string>',
                    'Port' => <integer>,
                    'S3AccessRoleArn' => '<string>',
                    'S3Path' => '<string>',
                    'ServerName' => '<string>',
                    'SslMode' => 'none|require|verify-ca|verify-full',
                ],
                'OracleSettings' => [
                    'AsmServer' => '<string>',
                    'CertificateArn' => '<string>',
                    'DatabaseName' => '<string>',
                    'Port' => <integer>,
                    'S3AccessRoleArn' => '<string>',
                    'S3Path' => '<string>',
                    'SecretsManagerOracleAsmAccessRoleArn' => '<string>',
                    'SecretsManagerOracleAsmSecretId' => '<string>',
                    'SecretsManagerSecurityDbEncryptionAccessRoleArn' => '<string>',
                    'SecretsManagerSecurityDbEncryptionSecretId' => '<string>',
                    'ServerName' => '<string>',
                    'SslMode' => 'none|require|verify-ca|verify-full',
                ],
                'PostgreSqlSettings' => [
                    'CertificateArn' => '<string>',
                    'DatabaseName' => '<string>',
                    'Port' => <integer>,
                    'S3AccessRoleArn' => '<string>',
                    'S3Path' => '<string>',
                    'ServerName' => '<string>',
                    'SslMode' => 'none|require|verify-ca|verify-full',
                ],
                'RedshiftSettings' => [
                    'DatabaseName' => '<string>',
                    'Port' => <integer>,
                    'S3AccessRoleArn' => '<string>',
                    'S3Path' => '<string>',
                    'ServerName' => '<string>',
                ],
                'SybaseAseSettings' => [
                    'CertificateArn' => '<string>',
                    'DatabaseName' => '<string>',
                    'EncryptPassword' => true || false,
                    'Port' => <integer>,
                    'ServerName' => '<string>',
                    'SslMode' => 'none|require|verify-ca|verify-full',
                ],
            ],
            'Virtual' => true || false,
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

AccessDeniedFault:

DMS was denied access to the endpoint. Check that the role is correctly configured.

FailedDependencyFault:

A dependency threw an exception.

Examples

Example 1: Describe data providers with a filter

The following example retrieves the details of a data provider identified by its ARN.

$result = $client->describeDataProviders([
    'Filters' => [
        [
            'Name' => 'data-provider-identifier',
            'Values' => [
                'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS',
            ],
        ],
    ],
]);

Result syntax:

[
    'DataProviders' => [
        [
            'DataProviderArn' => 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS',
            'DataProviderCreationTime' => ,
            'DataProviderName' => 'example-data-provider',
            'Description' => 'Example data provider for documentation',
            'Engine' => 'sqlserver',
            'Settings' => [
                'MicrosoftSqlServerSettings' => [
                    'CertificateArn' => 'arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS',
                    'DatabaseName' => 'ExampleDatabase',
                    'Port' => 1433,
                    'ServerName' => 'example-source-server.us-east-1.rds.amazonaws.com',
                    'SslMode' => 'verify-full',
                ],
            ],
        ],
    ],
]

DescribeEndpointSettings

$result = $client->describeEndpointSettings([/* ... */]);
$promise = $client->describeEndpointSettingsAsync([/* ... */]);

Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.

Parameter Syntax

$result = $client->describeEndpointSettings([
    'EngineName' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'EndpointSettings' => [
        [
            'Applicability' => '<string>',
            'DefaultValue' => '<string>',
            'EnumValues' => ['<string>', ...],
            'IntValueMax' => <integer>,
            'IntValueMin' => <integer>,
            'Name' => '<string>',
            'Sensitive' => true || false,
            'Type' => 'string|boolean|integer|enum',
            'Units' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

DescribeEndpointTypes

$result = $client->describeEndpointTypes([/* ... */]);
$promise = $client->describeEndpointTypesAsync([/* ... */]);

Returns information about the type of endpoints available.

Parameter Syntax

$result = $client->describeEndpointTypes([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'SupportedEndpointTypes' => [
        [
            'EndpointType' => 'source|target',
            'EngineDisplayName' => '<string>',
            'EngineName' => '<string>',
            'ReplicationInstanceEngineMinimumVersion' => '<string>',
            'SupportsCDC' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

Examples

Example 1: Describe endpoint types

Returns information about the type of endpoints available.

$result = $client->describeEndpointTypes([
    'Filters' => [
        [
            'Name' => 'string',
            'Values' => [
                'string',
                'string',
            ],
        ],
    ],
    'Marker' => '',
    'MaxRecords' => 123,
]);

Result syntax:

[
    'Marker' => '',
    'SupportedEndpointTypes' => [
    ],
]

DescribeEndpoints

$result = $client->describeEndpoints([/* ... */]);
$promise = $client->describeEndpointsAsync([/* ... */]);

Returns information about the endpoints for your account in the current region.

Parameter Syntax

$result = $client->describeEndpoints([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Endpoints' => [
        [
            'CertificateArn' => '<string>',
            'DatabaseName' => '<string>',
            'DmsTransferSettings' => [
                'BucketName' => '<string>',
                'ServiceAccessRoleArn' => '<string>',
            ],
            'DocDbSettings' => [
                'DatabaseName' => '<string>',
                'DocsToInvestigate' => <integer>,
                'ExtractDocId' => true || false,
                'KmsKeyId' => '<string>',
                'NestingLevel' => 'none|one',
                'Password' => '<string>',
                'Port' => <integer>,
                'ReplicateShardCollections' => true || false,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                'UseUpdateLookUp' => true || false,
                'Username' => '<string>',
            ],
            'DynamoDbSettings' => [
                'ServiceAccessRoleArn' => '<string>',
            ],
            'ElasticsearchSettings' => [
                'EndpointUri' => '<string>',
                'ErrorRetryDuration' => <integer>,
                'FullLoadErrorPercentage' => <integer>,
                'ServiceAccessRoleArn' => '<string>',
                'UseNewMappingType' => true || false,
            ],
            'EndpointArn' => '<string>',
            'EndpointIdentifier' => '<string>',
            'EndpointType' => 'source|target',
            'EngineDisplayName' => '<string>',
            'EngineName' => '<string>',
            'ExternalId' => '<string>',
            'ExternalTableDefinition' => '<string>',
            'ExtraConnectionAttributes' => '<string>',
            'GcpMySQLSettings' => [
                'AfterConnectScript' => '<string>',
                'CleanSourceMetadataOnMismatch' => true || false,
                'DatabaseName' => '<string>',
                'EventsPollInterval' => <integer>,
                'MaxFileSize' => <integer>,
                'ParallelLoadThreads' => <integer>,
                'Password' => '<string>',
                'Port' => <integer>,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                'ServerTimezone' => '<string>',
                'TargetDbType' => 'specific-database|multiple-databases',
                'Username' => '<string>',
            ],
            'IBMDb2Settings' => [
                'CurrentLsn' => '<string>',
                'DatabaseName' => '<string>',
                'KeepCsvFiles' => true || false,
                'LoadTimeout' => <integer>,
                'MaxFileSize' => <integer>,
                'MaxKBytesPerRead' => <integer>,
                'Password' => '<string>',
                'Port' => <integer>,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                'SetDataCaptureChanges' => true || false,
                'Username' => '<string>',
                'WriteBufferSize' => <integer>,
            ],
            'IsReadOnly' => true || false,
            'KafkaSettings' => [
                'Broker' => '<string>',
                'IncludeControlDetails' => true || false,
                'IncludeNullAndEmpty' => true || false,
                'IncludePartitionValue' => true || false,
                'IncludeTableAlterOperations' => true || false,
                'IncludeTransactionDetails' => true || false,
                'MessageFormat' => 'json|json-unformatted',
                'MessageMaxBytes' => <integer>,
                'NoHexPrefix' => true || false,
                'PartitionIncludeSchemaTable' => true || false,
                'SaslMechanism' => 'scram-sha-512|plain',
                'SaslPassword' => '<string>',
                'SaslUsername' => '<string>',
                'SecurityProtocol' => 'plaintext|ssl-authentication|ssl-encryption|sasl-ssl',
                'SslCaCertificateArn' => '<string>',
                'SslClientCertificateArn' => '<string>',
                'SslClientKeyArn' => '<string>',
                'SslClientKeyPassword' => '<string>',
                'SslEndpointIdentificationAlgorithm' => 'none|https',
                'Topic' => '<string>',
                'UseLargeIntegerValue' => true || false,
            ],
            'KinesisSettings' => [
                'IncludeControlDetails' => true || false,
                'IncludeNullAndEmpty' => true || false,
                'IncludePartitionValue' => true || false,
                'IncludeTableAlterOperations' => true || false,
                'IncludeTransactionDetails' => true || false,
                'MessageFormat' => 'json|json-unformatted',
                'NoHexPrefix' => true || false,
                'PartitionIncludeSchemaTable' => true || false,
                'ServiceAccessRoleArn' => '<string>',
                'StreamArn' => '<string>',
                'UseLargeIntegerValue' => true || false,
            ],
            'KmsKeyId' => '<string>',
            'LakehouseSettings' => [
                'Arn' => '<string>',
            ],
            'MicrosoftSQLServerSettings' => [
                'AuthenticationMethod' => 'password|kerberos',
                'BcpPacketSize' => <integer>,
                'ControlTablesFileGroup' => '<string>',
                'DatabaseName' => '<string>',
                'ForceLobLookup' => true || false,
                'Password' => '<string>',
                'Port' => <integer>,
                'QuerySingleAlwaysOnNode' => true || false,
                'ReadBackupOnly' => true || false,
                'SafeguardPolicy' => 'rely-on-sql-server-replication-agent|exclusive-automatic-truncation|shared-automatic-truncation',
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                'TlogAccessMode' => 'BackupOnly|PreferBackup|PreferTlog|TlogOnly',
                'TrimSpaceInChar' => true || false,
                'UseBcpFullLoad' => true || false,
                'UseThirdPartyBackupDevice' => true || false,
                'Username' => '<string>',
            ],
            'MongoDbSettings' => [
                'AuthMechanism' => 'default|mongodb_cr|scram_sha_1',
                'AuthSource' => '<string>',
                'AuthType' => 'no|password',
                'DatabaseName' => '<string>',
                'DocsToInvestigate' => '<string>',
                'ExtractDocId' => '<string>',
                'KmsKeyId' => '<string>',
                'NestingLevel' => 'none|one',
                'Password' => '<string>',
                'Port' => <integer>,
                'ReplicateShardCollections' => true || false,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                'UseUpdateLookUp' => true || false,
                'Username' => '<string>',
            ],
            'MySQLSettings' => [
                'AfterConnectScript' => '<string>',
                'AuthenticationMethod' => 'password|iam',
                'CleanSourceMetadataOnMismatch' => true || false,
                'DatabaseName' => '<string>',
                'EventsPollInterval' => <integer>,
                'ExecuteTimeout' => <integer>,
                'MaxFileSize' => <integer>,
                'ParallelLoadThreads' => <integer>,
                'Password' => '<string>',
                'Port' => <integer>,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                'ServerTimezone' => '<string>',
                'ServiceAccessRoleArn' => '<string>',
                'TargetDbType' => 'specific-database|multiple-databases',
                'Username' => '<string>',
            ],
            'NeptuneSettings' => [
                'ErrorRetryDuration' => <integer>,
                'IamAuthEnabled' => true || false,
                'MaxFileSize' => <integer>,
                'MaxRetryCount' => <integer>,
                'S3BucketFolder' => '<string>',
                'S3BucketName' => '<string>',
                'ServiceAccessRoleArn' => '<string>',
            ],
            'OracleSettings' => [
                'AccessAlternateDirectly' => true || false,
                'AddSupplementalLogging' => true || false,
                'AdditionalArchivedLogDestId' => <integer>,
                'AllowSelectNestedTables' => true || false,
                'ArchivedLogDestId' => <integer>,
                'ArchivedLogsOnly' => true || false,
                'AsmPassword' => '<string>',
                'AsmServer' => '<string>',
                'AsmUser' => '<string>',
                'AuthenticationMethod' => 'password|kerberos',
                'CharLengthSemantics' => 'default|char|byte',
                'ConvertTimestampWithZoneToUTC' => true || false,
                'DatabaseName' => '<string>',
                'DirectPathNoLog' => true || false,
                'DirectPathParallelLoad' => true || false,
                'EnableHomogenousTablespace' => true || false,
                'ExtraArchivedLogDestIds' => [<integer>, ...],
                'FailTasksOnLobTruncation' => true || false,
                'NumberDatatypeScale' => <integer>,
                'OpenTransactionWindow' => <integer>,
                'OraclePathPrefix' => '<string>',
                'ParallelAsmReadThreads' => <integer>,
                'Password' => '<string>',
                'Port' => <integer>,
                'ReadAheadBlocks' => <integer>,
                'ReadTableSpaceName' => true || false,
                'ReplacePathPrefix' => true || false,
                'RetryInterval' => <integer>,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerOracleAsmAccessRoleArn' => '<string>',
                'SecretsManagerOracleAsmSecretId' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'SecurityDbEncryption' => '<string>',
                'SecurityDbEncryptionName' => '<string>',
                'ServerName' => '<string>',
                'SpatialDataOptionToGeoJsonFunctionName' => '<string>',
                'StandbyDelayTime' => <integer>,
                'TrimSpaceInChar' => true || false,
                'UseAlternateFolderForOnline' => true || false,
                'UseBFile' => true || false,
                'UseDirectPathFullLoad' => true || false,
                'UseLogminerReader' => true || false,
                'UsePathPrefix' => '<string>',
                'Username' => '<string>',
            ],
            'Port' => <integer>,
            'PostgreSQLSettings' => [
                'AfterConnectScript' => '<string>',
                'AuthenticationMethod' => 'password|iam',
                'BabelfishDatabaseName' => '<string>',
                'CaptureDdls' => true || false,
                'DatabaseMode' => 'default|babelfish',
                'DatabaseName' => '<string>',
                'DdlArtifactsSchema' => '<string>',
                'DisableUnicodeSourceFilter' => true || false,
                'ExecuteTimeout' => <integer>,
                'FailTasksOnLobTruncation' => true || false,
                'HeartbeatEnable' => true || false,
                'HeartbeatFrequency' => <integer>,
                'HeartbeatSchema' => '<string>',
                'MapBooleanAsBoolean' => true || false,
                'MapJsonbAsClob' => true || false,
                'MapLongVarcharAs' => 'wstring|clob|nclob',
                'MaxFileSize' => <integer>,
                'Password' => '<string>',
                'PluginName' => 'no-preference|test-decoding|pglogical',
                'Port' => <integer>,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                'ServiceAccessRoleArn' => '<string>',
                'SlotName' => '<string>',
                'TrimSpaceInChar' => true || false,
                'Username' => '<string>',
            ],
            'RedisSettings' => [
                'AuthPassword' => '<string>',
                'AuthType' => 'none|auth-role|auth-token',
                'AuthUserName' => '<string>',
                'Port' => <integer>,
                'ServerName' => '<string>',
                'SslCaCertificateArn' => '<string>',
                'SslSecurityProtocol' => 'plaintext|ssl-encryption',
            ],
            'RedshiftSettings' => [
                'AcceptAnyDate' => true || false,
                'AfterConnectScript' => '<string>',
                'BucketFolder' => '<string>',
                'BucketName' => '<string>',
                'CaseSensitiveNames' => true || false,
                'CompUpdate' => true || false,
                'ConnectionTimeout' => <integer>,
                'DatabaseName' => '<string>',
                'DateFormat' => '<string>',
                'EmptyAsNull' => true || false,
                'EncryptionMode' => 'sse-s3|sse-kms',
                'ExplicitIds' => true || false,
                'FileTransferUploadStreams' => <integer>,
                'LoadTimeout' => <integer>,
                'MapBooleanAsBoolean' => true || false,
                'MaxFileSize' => <integer>,
                'Password' => '<string>',
                'Port' => <integer>,
                'RemoveQuotes' => true || false,
                'ReplaceChars' => '<string>',
                'ReplaceInvalidChars' => '<string>',
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                'ServerSideEncryptionKmsKeyId' => '<string>',
                'ServiceAccessRoleArn' => '<string>',
                'TimeFormat' => '<string>',
                'TrimBlanks' => true || false,
                'TruncateColumns' => true || false,
                'Username' => '<string>',
                'WriteBufferSize' => <integer>,
            ],
            'S3Settings' => [
                'AddColumnName' => true || false,
                'AddTrailingPaddingCharacter' => true || false,
                'BucketFolder' => '<string>',
                'BucketName' => '<string>',
                'CannedAclForObjects' => 'none|private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control',
                'CdcInsertsAndUpdates' => true || false,
                'CdcInsertsOnly' => true || false,
                'CdcMaxBatchInterval' => <integer>,
                'CdcMinFileSize' => <integer>,
                'CdcPath' => '<string>',
                'CompressionType' => 'none|gzip',
                'CsvDelimiter' => '<string>',
                'CsvNoSupValue' => '<string>',
                'CsvNullValue' => '<string>',
                'CsvRowDelimiter' => '<string>',
                'DataFormat' => 'csv|parquet',
                'DataPageSize' => <integer>,
                'DatePartitionDelimiter' => 'SLASH|UNDERSCORE|DASH|NONE',
                'DatePartitionEnabled' => true || false,
                'DatePartitionSequence' => 'YYYYMMDD|YYYYMMDDHH|YYYYMM|MMYYYYDD|DDMMYYYY',
                'DatePartitionTimezone' => '<string>',
                'DictPageSizeLimit' => <integer>,
                'EnableStatistics' => true || false,
                'EncodingType' => 'plain|plain-dictionary|rle-dictionary',
                'EncryptionMode' => 'sse-s3|sse-kms',
                'ExpectedBucketOwner' => '<string>',
                'ExternalTableDefinition' => '<string>',
                'GlueCatalogGeneration' => true || false,
                'IgnoreHeaderRows' => <integer>,
                'IncludeOpForFullLoad' => true || false,
                'MaxFileSize' => <integer>,
                'ParquetTimestampInMillisecond' => true || false,
                'ParquetVersion' => 'parquet-1-0|parquet-2-0',
                'PreserveTransactions' => true || false,
                'Rfc4180' => true || false,
                'RowGroupLength' => <integer>,
                'ServerSideEncryptionKmsKeyId' => '<string>',
                'ServiceAccessRoleArn' => '<string>',
                'TimestampColumnName' => '<string>',
                'UseCsvNoSupValue' => true || false,
                'UseTaskStartTimeForFullLoadTimestamp' => true || false,
            ],
            'ServerName' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
            'SslMode' => 'none|require|verify-ca|verify-full',
            'Status' => '<string>',
            'SybaseSettings' => [
                'DatabaseName' => '<string>',
                'Password' => '<string>',
                'Port' => <integer>,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                'Username' => '<string>',
            ],
            'TimestreamSettings' => [
                'CdcInsertsAndUpdates' => true || false,
                'DatabaseName' => '<string>',
                'EnableMagneticStoreWrites' => true || false,
                'MagneticDuration' => <integer>,
                'MemoryDuration' => <integer>,
            ],
            'Username' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

Examples

Example 1: Describe endpoints

Returns information about the endpoints for your account in the current region.

$result = $client->describeEndpoints([
    'Filters' => [
        [
            'Name' => 'string',
            'Values' => [
                'string',
                'string',
            ],
        ],
    ],
    'Marker' => '',
    'MaxRecords' => 123,
]);

Result syntax:

[
    'Endpoints' => [
    ],
    'Marker' => '',
]

DescribeEngineVersions

$result = $client->describeEngineVersions([/* ... */]);
$promise = $client->describeEngineVersionsAsync([/* ... */]);

Returns information about the replication instance versions used in the project.

Parameter Syntax

$result = $client->describeEngineVersions([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'EngineVersions' => [
        [
            'AutoUpgradeDate' => <DateTime>,
            'AvailableUpgrades' => ['<string>', ...],
            'DeprecationDate' => <DateTime>,
            'ForceUpgradeDate' => <DateTime>,
            'LaunchDate' => <DateTime>,
            'Lifecycle' => '<string>',
            'ReleaseStatus' => 'beta|prod',
            'Version' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

DescribeEventCategories

$result = $client->describeEventCategories([/* ... */]);
$promise = $client->describeEventCategoriesAsync([/* ... */]);

Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the Database Migration Service User Guide.

Parameter Syntax

$result = $client->describeEventCategories([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'SourceType' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventCategoryGroupList' => [
        [
            'EventCategories' => ['<string>', ...],
            'SourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeEventSubscriptions

$result = $client->describeEventSubscriptions([/* ... */]);
$promise = $client->describeEventSubscriptionsAsync([/* ... */]);

Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify SubscriptionName, this action lists the description for that subscription.

Parameter Syntax

$result = $client->describeEventSubscriptions([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SubscriptionName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventSubscriptionsList' => [
        [
            'CustSubscriptionId' => '<string>',
            'CustomerAwsId' => '<string>',
            'Enabled' => true || false,
            'EventCategoriesList' => ['<string>', ...],
            'SnsTopicArn' => '<string>',
            'SourceIdsList' => ['<string>', ...],
            'SourceType' => '<string>',
            'Status' => '<string>',
            'SubscriptionCreationTime' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

ResourceNotFoundFault:

The resource could not be found.

DescribeEvents

$result = $client->describeEvents([/* ... */]);
$promise = $client->describeEventsAsync([/* ... */]);

Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.

Parameter Syntax

$result = $client->describeEvents([
    'Duration' => <integer>,
    'EndTime' => <integer || string || DateTime>,
    'EventCategories' => ['<string>', ...],
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SourceIdentifier' => '<string>',
    'SourceType' => 'replication-instance',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'Events' => [
        [
            'Date' => <DateTime>,
            'EventCategories' => ['<string>', ...],
            'Message' => '<string>',
            'SourceIdentifier' => '<string>',
            'SourceType' => 'replication-instance',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

DescribeExtensionPackAssociations

$result = $client->describeExtensionPackAssociations([/* ... */]);
$promise = $client->describeExtensionPackAssociationsAsync([/* ... */]);

Returns a paginated list of extension pack installation requests for a migration project, initiated by StartExtensionPackAssociation.

Required permissions: dms:ListExtensionPacks. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameter Syntax

$result = $client->describeExtensionPackAssociations([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'MigrationProjectIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'Requests' => [
        [
            'Error' => [
                'defaultErrorDetails' => [
                    'Message' => '<string>',
                ],
            ],
            'ExportSqlDetails' => [
                'ObjectURL' => '<string>',
                'S3ObjectKey' => '<string>',
            ],
            'MigrationProjectArn' => '<string>',
            'Progress' => [
                'ProcessedObject' => [
                    'EndpointType' => '<string>',
                    'Name' => '<string>',
                    'Type' => '<string>',
                ],
                'ProgressPercent' => <float>,
                'ProgressStep' => '<string>',
                'TotalObjects' => <integer>,
            ],
            'RequestIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

Examples

Example 1: Retrieve the status of extension pack associations

The following example retrieves the status of operations that apply an extension pack to the target database, identified by their request IDs.

$result = $client->describeExtensionPackAssociations([
    'Filters' => [
        [
            'Name' => 'request-id',
            'Values' => [
                'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
                'a1b2c3d4-5678-90ab-cdef-EXAMPLE22222',
                'a1b2c3d4-5678-90ab-cdef-EXAMPLE33333',
            ],
        ],
    ],
    'MigrationProjectIdentifier' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
]);

Result syntax:

[
    'Requests' => [
        [
            'MigrationProjectArn' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
            'RequestIdentifier' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
            'Status' => 'SUCCESS',
        ],
        [
            'MigrationProjectArn' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
            'Progress' => [
                'ProgressPercent' => 50,
                'ProgressStep' => 'IN_PROGRESS',
            ],
            'RequestIdentifier' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE22222',
            'Status' => 'IN_PROGRESS',
        ],
        [
            'Error' => [
                'defaultErrorDetails' => [
                    'Message' => 'The database user in your target secret does not have sufficient privileges. Grant the required privileges and try again.',
                ],
            ],
            'MigrationProjectArn' => 'arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS',
            'RequestIdentifier' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE33333',
            'Status' => 'FAILED',
        ],
    ],
]

DescribeFleetAdvisorCollectors

$result = $client->describeFleetAdvisorCollectors([/* ... */]);
$promise = $client->describeFleetAdvisorCollectorsAsync([/* ... */]);

End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

Returns a list of the Fleet Advisor collectors in your account.

Parameter Syntax

$result = $client->describeFleetAdvisorCollectors([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Collectors' => [
        [
            'CollectorHealthCheck' => [
                'CollectorStatus' => 'UNREGISTERED|ACTIVE',
                'LocalCollectorS3Access' => true || false,
                'WebCollectorGrantedRoleBasedAccess' => true || false,
                'WebCollectorS3Access' => true || false,
            ],
            'CollectorName' => '<string>',
            'CollectorReferencedId' => '<string>',
            'CollectorVersion' => '<string>',
            'CreatedDate' => '<string>',
            'Description' => '<string>',
            'InventoryData' => [
                'NumberOfDatabases' => <integer>,
                'NumberOfSchemas' => <integer>,
            ],
            'LastDataReceived' => '<string>',
            'ModifiedDate' => '<string>',
            'RegisteredDate' => '<string>',
            'S3BucketName' => '<string>',
            'ServiceAccessRoleArn' => '<string>',
            'VersionStatus' => 'UP_TO_DATE|OUTDATED|UNSUPPORTED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

DescribeFleetAdvisorDatabases

$result = $client->describeFleetAdvisorDatabases([/* ... */]);
$promise = $client->describeFleetAdvisorDatabasesAsync([/* ... */]);

End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

Returns a list of Fleet Advisor databases in your account.

Parameter Syntax

$result = $client->describeFleetAdvisorDatabases([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Databases' => [
        [
            'Collectors' => [
                [
                    'CollectorName' => '<string>',
                    'CollectorReferencedId' => '<string>',
                ],
                // ...
            ],
            'DatabaseId' => '<string>',
            'DatabaseName' => '<string>',
            'IpAddress' => '<string>',
            'NumberOfSchemas' => <integer>,
            'Server' => [
                'IpAddress' => '<string>',
                'ServerId' => '<string>',
                'ServerName' => '<string>',
            ],
            'SoftwareDetails' => [
                'Engine' => '<string>',
                'EngineEdition' => '<string>',
                'EngineVersion' => '<string>',
                'OsArchitecture' => <integer>,
                'ServicePack' => '<string>',
                'SupportLevel' => '<string>',
                'Tooltip' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidResourceStateFault:

The resource is in a state that prevents it from being used for database migration.

DescribeFleetAdvisorLsaAnalysis

$result = $client->describeFleetAdvisorLsaAnalysis([/* ... */]);
$promise = $client->describeFleetAdvisorLsaAnalysisAsync([/* ... */]);

End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors.

Parameter Syntax

$result = $client->describeFleetAdvisorLsaAnalysis([
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Analysis' => [
        [
            'LsaAnalysisId' => '<string>',
            'Status' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details