AWS Database Migration Service 2016-01-01

AddTagsToResource

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

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.

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([/* ... */]);

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([/* ... */]);

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.

CancelReplicationTaskAssessmentRun

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ReplicationTaskAssessmentRun' => [
        'AssessmentProgress' => [
            'IndividualAssessmentCompletedCount' => <integer>,
            'IndividualAssessmentCount' => <integer>,
        ],
        'AssessmentRunName' => '<string>',
        'LastFailureMessage' => '<string>',
        'ReplicationTaskArn' => '<string>',
        'ReplicationTaskAssessmentRunArn' => '<string>',
        'ReplicationTaskAssessmentRunCreationDate' => <DateTime>,
        'ResultEncryptionMode' => '<string>',
        'ResultKmsKeyArn' => '<string>',
        'ResultLocationBucket' => '<string>',
        'ResultLocationFolder' => '<string>',
        '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.

CreateEndpoint

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

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>,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        '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>',
        'MaxKBytesPerRead' => <integer>,
        'Password' => '<string>',
        'Port' => <integer>,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        'SetDataCaptureChanges' => true || false,
        'Username' => '<string>',
    ],
    '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>',
        'Topic' => '<string>',
    ],
    '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>',
    ],
    'KmsKeyId' => '<string>',
    'MicrosoftSQLServerSettings' => [
        '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>,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<string>',
        'Username' => '<string>',
    ],
    'MySQLSettings' => [
        '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>',
    ],
    '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>',
        '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>,
        '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>',
        'CaptureDdls' => true || false,
        'DatabaseName' => '<string>',
        'DdlArtifactsSchema' => '<string>',
        'ExecuteTimeout' => <integer>,
        'FailTasksOnLobTruncation' => true || false,
        'HeartbeatEnable' => true || false,
        'HeartbeatFrequency' => <integer>,
        'HeartbeatSchema' => '<string>',
        'MapBooleanAsBoolean' => true || false,
        'MaxFileSize' => <integer>,
        'Password' => '<string>',
        'PluginName' => 'no-preference|test-decoding|pglogical',
        'Port' => <integer>,
        'SecretsManagerAccessRoleArn' => '<string>',
        'SecretsManagerSecretId' => '<string>',
        'ServerName' => '<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>',
        ],
        // ...
    ],
    '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>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            '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>',
            'MaxKBytesPerRead' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'SetDataCaptureChanges' => true || false,
            'Username' => '<string>',
        ],
        '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>',
            'Topic' => '<string>',
        ],
        '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>',
        ],
        'KmsKeyId' => '<string>',
        'MicrosoftSQLServerSettings' => [
            '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>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'Username' => '<string>',
        ],
        'MySQLSettings' => [
            '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>',
        ],
        '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>',
            '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>,
            '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>',
            'CaptureDdls' => true || false,
            'DatabaseName' => '<string>',
            'DdlArtifactsSchema' => '<string>',
            'ExecuteTimeout' => <integer>,
            'FailTasksOnLobTruncation' => true || false,
            'HeartbeatEnable' => true || false,
            'HeartbeatFrequency' => <integer>,
            'HeartbeatSchema' => '<string>',
            'MapBooleanAsBoolean' => true || false,
            'MaxFileSize' => <integer>,
            'Password' => '<string>',
            'PluginName' => 'no-preference|test-decoding|pglogical',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<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>',
        ],
        '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([/* ... */]);

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([/* ... */]);

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.

CreateReplicationInstance

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

Parameter Syntax

$result = $client->createReplicationInstance([
    'AllocatedStorage' => <integer>,
    'AutoMinorVersionUpgrade' => true || false,
    'AvailabilityZone' => '<string>',
    'DnsNameServers' => '<string>',
    'EngineVersion' => '<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>,
        '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' => [
            '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 is invalid.

• 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([/* ... */]);

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' => [
        '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 is invalid.

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([/* ... */]);

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([/* ... */]);

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>,
        '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([/* ... */]);

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' => [
    ],
]

DeleteEndpoint

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

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>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            '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>',
            'MaxKBytesPerRead' => <integer>,
            'Password' => '<string>',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'SetDataCaptureChanges' => true || false,
            'Username' => '<string>',
        ],
        '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>',
            'Topic' => '<string>',
        ],
        '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>',
        ],
        'KmsKeyId' => '<string>',
        'MicrosoftSQLServerSettings' => [
            '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>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<string>',
            'Username' => '<string>',
        ],
        'MySQLSettings' => [
            '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>',
        ],
        '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>',
            '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>,
            '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>',
            'CaptureDdls' => true || false,
            'DatabaseName' => '<string>',
            'DdlArtifactsSchema' => '<string>',
            'ExecuteTimeout' => <integer>,
            'FailTasksOnLobTruncation' => true || false,
            'HeartbeatEnable' => true || false,
            'HeartbeatFrequency' => <integer>,
            'HeartbeatSchema' => '<string>',
            'MapBooleanAsBoolean' => true || false,
            'MaxFileSize' => <integer>,
            'Password' => '<string>',
            'PluginName' => 'no-preference|test-decoding|pglogical',
            'Port' => <integer>,
            'SecretsManagerAccessRoleArn' => '<string>',
            'SecretsManagerSecretId' => '<string>',
            'ServerName' => '<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>',
        ],
        '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([/* ... */]);

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.

DeleteFleetAdvisorCollector

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

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.

DeleteFleetAdvisorDatabases

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

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.

DeleteReplicationInstance

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

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>,
        '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' => [
            '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([/* ... */]);

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.

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([/* ... */]);

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ReplicationTaskAssessmentRun' => [
        'AssessmentProgress' => [
            'IndividualAssessmentCompletedCount' => <integer>,
            'IndividualAssessmentCount' => <integer>,
        ],
        'AssessmentRunName' => '<string>',
        'LastFailureMessage' => '<string>',
        'ReplicationTaskArn' => '<string>',
        'ReplicationTaskAssessmentRunArn' => '<string>',
        'ReplicationTaskAssessmentRunCreationDate' => <DateTime>,
        'ResultEncryptionMode' => '<string>',
        'ResultKmsKeyArn' => '<string>',
        'ResultLocationBucket' => '<string>',
        'ResultLocationFolder' => '<string>',
        '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([/* ... */]);

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([/* ... */]);

Parameter Syntax

$result = $client->describeApplicableIndividualAssessments([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'MigrationType' => 'full-load|cdc|full-load-and-cdc',
    '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([/* ... */]);

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>,
            '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([/* ... */]);

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' => '',
]

DescribeEndpointSettings

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

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([/* ... */]);

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([/* ... */]);

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>,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                '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>',
                'MaxKBytesPerRead' => <integer>,
                'Password' => '<string>',
                'Port' => <integer>,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                'SetDataCaptureChanges' => true || false,
                'Username' => '<string>',
            ],
            '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>',
                'Topic' => '<string>',
            ],
            '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>',
            ],
            'KmsKeyId' => '<string>',
            'MicrosoftSQLServerSettings' => [
                '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>,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<string>',
                'Username' => '<string>',
            ],
            'MySQLSettings' => [
                '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>',
            ],
            '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>',
                '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>,
                '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>',
                'CaptureDdls' => true || false,
                'DatabaseName' => '<string>',
                'DdlArtifactsSchema' => '<string>',
                'ExecuteTimeout' => <integer>,
                'FailTasksOnLobTruncation' => true || false,
                'HeartbeatEnable' => true || false,
                'HeartbeatFrequency' => <integer>,
                'HeartbeatSchema' => '<string>',
                'MapBooleanAsBoolean' => true || false,
                'MaxFileSize' => <integer>,
                'Password' => '<string>',
                'PluginName' => 'no-preference|test-decoding|pglogical',
                'Port' => <integer>,
                'SecretsManagerAccessRoleArn' => '<string>',
                'SecretsManagerSecretId' => '<string>',
                'ServerName' => '<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>',
            ],
            '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' => '',
]

DescribeEventCategories

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

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([/* ... */]);

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([/* ... */]);

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.

DescribeFleetAdvisorCollectors

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

Parameter Syntax

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

Parameter Details