2023/08/03 - AWS Database Migration Service - 27 new api methods
Changes The release makes public API for DMS Schema Conversion feature.
Deletes the specified data provider.
Note
All migration projects associated with the data provider must be deleted or modified before you can delete the data provider.
See also: AWS API Documentation
Request Syntax
client.delete_data_provider(
DataProviderIdentifier='string'
)
string
[REQUIRED]
The identifier of the data provider to delete.
dict
Response Syntax
{
'DataProvider': {
'DataProviderName': 'string',
'DataProviderArn': 'string',
'DataProviderCreationTime': datetime(2015, 1, 1),
'Description': 'string',
'Engine': 'string',
'Settings': {
'PostgreSqlSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'MySqlSettings': {
'ServerName': 'string',
'Port': 123,
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'OracleSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string',
'AsmServer': 'string',
'SecretsManagerOracleAsmSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerSecurityDbEncryptionSecretId': 'string',
'SecretsManagerSecurityDbEncryptionAccessRoleArn': 'string'
},
'MicrosoftSqlServerSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
}
}
}
}
Response Structure
(dict) --
DataProvider (dict) --
The data provider that was deleted.
DataProviderName (string) --
The name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the data provider.
DataProviderCreationTime (datetime) --
The time the data provider was created.
Description (string) --
A description of the data provider. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
Engine (string) --
The type of database engine for the data provider. Valid values include "aurora" , "aurora_postgresql" , "mysql" , "oracle" , "postgres" , and "sqlserver" . A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
Settings (dict) --
The settings in JSON format for a data provider.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: PostgreSqlSettings, MySqlSettings, OracleSettings, MicrosoftSqlServerSettings. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
PostgreSqlSettings (dict) --
Provides information that defines a PostgreSQL data provider.
ServerName (string) --
The name of the PostgreSQL server.
Port (integer) --
The port value for the PostgreSQL data provider.
DatabaseName (string) --
The database name on the PostgreSQL data provider.
SslMode (string) --
The SSL mode used to connect to the PostgreSQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
MySqlSettings (dict) --
Provides information that defines a MySQL data provider.
ServerName (string) --
The name of the MySQL server.
Port (integer) --
The port value for the MySQL data provider.
SslMode (string) --
The SSL mode used to connect to the MySQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
OracleSettings (dict) --
Provides information that defines an Oracle data provider.
ServerName (string) --
The name of the Oracle server.
Port (integer) --
The port value for the Oracle data provider.
DatabaseName (string) --
The database name on the Oracle data provider.
SslMode (string) --
The SSL mode used to connect to the Oracle data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
AsmServer (string) --
The address of your Oracle Automatic Storage Management (ASM) server. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
SecretsManagerOracleAsmSecretId (string) --
The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.
Required only if your data provider uses the Oracle ASM server.
SecretsManagerOracleAsmAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.
SecretsManagerSecurityDbEncryptionSecretId (string) --
The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.
SecretsManagerSecurityDbEncryptionAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.
MicrosoftSqlServerSettings (dict) --
Provides information that defines a Microsoft SQL Server data provider.
ServerName (string) --
The name of the Microsoft SQL Server server.
Port (integer) --
The port value for the Microsoft SQL Server data provider.
DatabaseName (string) --
The database name on the Microsoft SQL Server data provider.
SslMode (string) --
The SSL mode used to connect to the Microsoft SQL Server data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Modifies the specified migration project using the provided parameters.
Note
The migration project must be closed before you can modify it.
See also: AWS API Documentation
Request Syntax
client.modify_migration_project(
MigrationProjectIdentifier='string',
MigrationProjectName='string',
SourceDataProviderDescriptors=[
{
'DataProviderIdentifier': 'string',
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string'
},
],
TargetDataProviderDescriptors=[
{
'DataProviderIdentifier': 'string',
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string'
},
],
InstanceProfileIdentifier='string',
TransformationRules='string',
Description='string',
SchemaConversionApplicationAttributes={
'S3BucketPath': 'string',
'S3BucketRoleArn': 'string'
}
)
string
[REQUIRED]
The identifier of the migration project. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
string
A user-friendly name for the migration project.
list
Information about the source data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.
(dict) --
Information about a data provider.
DataProviderIdentifier (string) -- [REQUIRED]
The name or Amazon Resource Name (ARN) of the data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
list
Information about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.
(dict) --
Information about a data provider.
DataProviderIdentifier (string) -- [REQUIRED]
The name or Amazon Resource Name (ARN) of the data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
string
The name or Amazon Resource Name (ARN) for the instance profile.
string
The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
string
A user-friendly description of the migration project.
dict
The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
S3BucketPath (string) --
The path for the Amazon S3 bucket that the application uses for exporting assessment reports.
S3BucketRoleArn (string) --
The ARN for the role the application uses to access its Amazon S3 bucket.
dict
Response Syntax
{
'MigrationProject': {
'MigrationProjectName': 'string',
'MigrationProjectArn': 'string',
'MigrationProjectCreationTime': datetime(2015, 1, 1),
'SourceDataProviderDescriptors': [
{
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'DataProviderName': 'string',
'DataProviderArn': 'string'
},
],
'TargetDataProviderDescriptors': [
{
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'DataProviderName': 'string',
'DataProviderArn': 'string'
},
],
'InstanceProfileArn': 'string',
'InstanceProfileName': 'string',
'TransformationRules': 'string',
'Description': 'string',
'SchemaConversionApplicationAttributes': {
'S3BucketPath': 'string',
'S3BucketRoleArn': 'string'
}
}
}
Response Structure
(dict) --
MigrationProject (dict) --
The migration project that was modified.
MigrationProjectName (string) --
The name of the migration project.
MigrationProjectArn (string) --
The ARN string that uniquely identifies the migration project.
MigrationProjectCreationTime (datetime) --
The time when the migration project was created.
SourceDataProviderDescriptors (list) --
Information about the source data provider, including the name or ARN, and Secrets Manager parameters.
(dict) --
Information about a data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
DataProviderName (string) --
The user-friendly name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) of the data provider.
TargetDataProviderDescriptors (list) --
Information about the target data provider, including the name or ARN, and Secrets Manager parameters.
(dict) --
Information about a data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
DataProviderName (string) --
The user-friendly name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) of the data provider.
InstanceProfileArn (string) --
The Amazon Resource Name (ARN) of the instance profile for your migration project.
InstanceProfileName (string) --
The name of the associated instance profile.
TransformationRules (string) --
The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
Description (string) --
A user-friendly description of the migration project.
SchemaConversionApplicationAttributes (dict) --
The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
S3BucketPath (string) --
The path for the Amazon S3 bucket that the application uses for exporting assessment reports.
S3BucketRoleArn (string) --
The ARN for the role the application uses to access its Amazon S3 bucket.
Returns a paginated list of data providers for your account in the current region.
See also: AWS API Documentation
Request Syntax
client.describe_data_providers(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to the data providers described in the form of key-value pairs.
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
string
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
dict
Response Syntax
{
'Marker': 'string',
'DataProviders': [
{
'DataProviderName': 'string',
'DataProviderArn': 'string',
'DataProviderCreationTime': datetime(2015, 1, 1),
'Description': 'string',
'Engine': 'string',
'Settings': {
'PostgreSqlSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'MySqlSettings': {
'ServerName': 'string',
'Port': 123,
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'OracleSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string',
'AsmServer': 'string',
'SecretsManagerOracleAsmSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerSecurityDbEncryptionSecretId': 'string',
'SecretsManagerSecurityDbEncryptionAccessRoleArn': 'string'
},
'MicrosoftSqlServerSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
}
}
},
]
}
Response Structure
(dict) --
Marker (string) --
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
DataProviders (list) --
A description of data providers.
(dict) --
Provides information that defines a data provider.
DataProviderName (string) --
The name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the data provider.
DataProviderCreationTime (datetime) --
The time the data provider was created.
Description (string) --
A description of the data provider. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
Engine (string) --
The type of database engine for the data provider. Valid values include "aurora" , "aurora_postgresql" , "mysql" , "oracle" , "postgres" , and "sqlserver" . A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
Settings (dict) --
The settings in JSON format for a data provider.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: PostgreSqlSettings, MySqlSettings, OracleSettings, MicrosoftSqlServerSettings. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
PostgreSqlSettings (dict) --
Provides information that defines a PostgreSQL data provider.
ServerName (string) --
The name of the PostgreSQL server.
Port (integer) --
The port value for the PostgreSQL data provider.
DatabaseName (string) --
The database name on the PostgreSQL data provider.
SslMode (string) --
The SSL mode used to connect to the PostgreSQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
MySqlSettings (dict) --
Provides information that defines a MySQL data provider.
ServerName (string) --
The name of the MySQL server.
Port (integer) --
The port value for the MySQL data provider.
SslMode (string) --
The SSL mode used to connect to the MySQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
OracleSettings (dict) --
Provides information that defines an Oracle data provider.
ServerName (string) --
The name of the Oracle server.
Port (integer) --
The port value for the Oracle data provider.
DatabaseName (string) --
The database name on the Oracle data provider.
SslMode (string) --
The SSL mode used to connect to the Oracle data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
AsmServer (string) --
The address of your Oracle Automatic Storage Management (ASM) server. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
SecretsManagerOracleAsmSecretId (string) --
The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.
Required only if your data provider uses the Oracle ASM server.
SecretsManagerOracleAsmAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.
SecretsManagerSecurityDbEncryptionSecretId (string) --
The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.
SecretsManagerSecurityDbEncryptionAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.
MicrosoftSqlServerSettings (dict) --
Provides information that defines a Microsoft SQL Server data provider.
ServerName (string) --
The name of the Microsoft SQL Server server.
Port (integer) --
The port value for the Microsoft SQL Server data provider.
DatabaseName (string) --
The database name on the Microsoft SQL Server data provider.
SslMode (string) --
The SSL mode used to connect to the Microsoft SQL Server data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file.
See also: AWS API Documentation
Request Syntax
client.export_metadata_model_assessment(
MigrationProjectIdentifier='string',
SelectionRules='string',
FileName='string',
AssessmentReportTypes=[
'pdf'|'csv',
]
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
string
[REQUIRED]
A value that specifies the database objects to assess.
string
The name of the assessment file to create in your Amazon S3 bucket.
list
The file format of the assessment file.
(string) --
dict
Response Syntax
{
'PdfReport': {
'S3ObjectKey': 'string',
'ObjectURL': 'string'
},
'CsvReport': {
'S3ObjectKey': 'string',
'ObjectURL': 'string'
}
}
Response Structure
(dict) --
PdfReport (dict) --
The Amazon S3 details for an assessment exported in PDF format.
S3ObjectKey (string) --
The object key for the object containing the exported metadata model assessment.
ObjectURL (string) --
The URL for the object containing the exported metadata model assessment.
CsvReport (dict) --
The Amazon S3 details for an assessment exported in CSV format.
S3ObjectKey (string) --
The object key for the object containing the exported metadata model assessment.
ObjectURL (string) --
The URL for the object containing the exported metadata model assessment.
Creates a database migration assessment report by assessing the migration complexity for your source database. A database migration assessment report summarizes all of the schema conversion tasks. It also details the action items for database objects that can't be converted to the database engine of your target database instance.
See also: AWS API Documentation
Request Syntax
client.start_metadata_model_assessment(
MigrationProjectIdentifier='string',
SelectionRules='string'
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
string
[REQUIRED]
A value that specifies the database objects to assess.
dict
Response Syntax
{
'RequestIdentifier': 'string'
}
Response Structure
(dict) --
RequestIdentifier (string) --
The identifier for the assessment operation.
Returns a paginated list of instance profiles for your account in the current region.
See also: AWS API Documentation
Request Syntax
client.describe_instance_profiles(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to the instance profiles described in the form of key-value pairs.
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
string
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
dict
Response Syntax
{
'Marker': 'string',
'InstanceProfiles': [
{
'InstanceProfileArn': 'string',
'AvailabilityZone': 'string',
'KmsKeyArn': 'string',
'PubliclyAccessible': True|False,
'NetworkType': 'string',
'InstanceProfileName': 'string',
'Description': 'string',
'InstanceProfileCreationTime': datetime(2015, 1, 1),
'SubnetGroupIdentifier': 'string',
'VpcSecurityGroups': [
'string',
]
},
]
}
Response Structure
(dict) --
Marker (string) --
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
InstanceProfiles (list) --
A description of instance profiles.
(dict) --
Provides information that defines an instance profile.
InstanceProfileArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
AvailabilityZone (string) --
The Availability Zone where the instance profile runs.
KmsKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true .
NetworkType (string) --
Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
InstanceProfileName (string) --
The user-friendly name for the instance profile.
Description (string) --
A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
InstanceProfileCreationTime (datetime) --
The time the instance profile was created.
SubnetGroupIdentifier (string) --
The identifier of the subnet group that is associated with the instance profile.
VpcSecurityGroups (list) --
The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
(string) --
Modifies the specified schema conversion configuration using the provided parameters.
See also: AWS API Documentation
Request Syntax
client.modify_conversion_configuration(
MigrationProjectIdentifier='string',
ConversionConfiguration='string'
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
string
[REQUIRED]
The new conversion configuration.
dict
Response Syntax
{
'MigrationProjectIdentifier': 'string'
}
Response Structure
(dict) --
MigrationProjectIdentifier (string) --
The name or Amazon Resource Name (ARN) of the modified configuration.
Modifies the specified instance profile using the provided parameters.
Note
All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile.
See also: AWS API Documentation
Request Syntax
client.modify_instance_profile(
InstanceProfileIdentifier='string',
AvailabilityZone='string',
KmsKeyArn='string',
PubliclyAccessible=True|False,
NetworkType='string',
InstanceProfileName='string',
Description='string',
SubnetGroupIdentifier='string',
VpcSecurityGroups=[
'string',
]
)
string
[REQUIRED]
The identifier of the instance profile. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
string
The Availability Zone where the instance profile runs.
string
The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
boolean
Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true .
string
Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
string
A user-friendly name for the instance profile.
string
A user-friendly description for the instance profile.
string
A subnet group to associate with the instance profile.
list
Specifies the VPC security groups to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
(string) --
dict
Response Syntax
{
'InstanceProfile': {
'InstanceProfileArn': 'string',
'AvailabilityZone': 'string',
'KmsKeyArn': 'string',
'PubliclyAccessible': True|False,
'NetworkType': 'string',
'InstanceProfileName': 'string',
'Description': 'string',
'InstanceProfileCreationTime': datetime(2015, 1, 1),
'SubnetGroupIdentifier': 'string',
'VpcSecurityGroups': [
'string',
]
}
}
Response Structure
(dict) --
InstanceProfile (dict) --
The instance profile that was modified.
InstanceProfileArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
AvailabilityZone (string) --
The Availability Zone where the instance profile runs.
KmsKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true .
NetworkType (string) --
Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
InstanceProfileName (string) --
The user-friendly name for the instance profile.
Description (string) --
A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
InstanceProfileCreationTime (datetime) --
The time the instance profile was created.
SubnetGroupIdentifier (string) --
The identifier of the subnet group that is associated with the instance profile.
VpcSecurityGroups (list) --
The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
(string) --
Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database.
See also: AWS API Documentation
Request Syntax
client.create_data_provider(
DataProviderName='string',
Description='string',
Engine='string',
Settings={
'PostgreSqlSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'MySqlSettings': {
'ServerName': 'string',
'Port': 123,
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'OracleSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string',
'AsmServer': 'string',
'SecretsManagerOracleAsmSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerSecurityDbEncryptionSecretId': 'string',
'SecretsManagerSecurityDbEncryptionAccessRoleArn': 'string'
},
'MicrosoftSqlServerSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
}
},
Tags=[
{
'Key': 'string',
'Value': 'string',
'ResourceArn': 'string'
},
]
)
string
A user-friendly name for the data provider.
string
A user-friendly description of the data provider.
string
[REQUIRED]
The type of database engine for the data provider. Valid values include "aurora" , "aurora_postgresql" , "mysql" , "oracle" , "postgres" , and "sqlserver" . A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
dict
[REQUIRED]
The settings in JSON format for a data provider.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: PostgreSqlSettings, MySqlSettings, OracleSettings, MicrosoftSqlServerSettings.
PostgreSqlSettings (dict) --
Provides information that defines a PostgreSQL data provider.
ServerName (string) --
The name of the PostgreSQL server.
Port (integer) --
The port value for the PostgreSQL data provider.
DatabaseName (string) --
The database name on the PostgreSQL data provider.
SslMode (string) --
The SSL mode used to connect to the PostgreSQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
MySqlSettings (dict) --
Provides information that defines a MySQL data provider.
ServerName (string) --
The name of the MySQL server.
Port (integer) --
The port value for the MySQL data provider.
SslMode (string) --
The SSL mode used to connect to the MySQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
OracleSettings (dict) --
Provides information that defines an Oracle data provider.
ServerName (string) --
The name of the Oracle server.
Port (integer) --
The port value for the Oracle data provider.
DatabaseName (string) --
The database name on the Oracle data provider.
SslMode (string) --
The SSL mode used to connect to the Oracle data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
AsmServer (string) --
The address of your Oracle Automatic Storage Management (ASM) server. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
SecretsManagerOracleAsmSecretId (string) --
The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.
Required only if your data provider uses the Oracle ASM server.
SecretsManagerOracleAsmAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.
SecretsManagerSecurityDbEncryptionSecretId (string) --
The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.
SecretsManagerSecurityDbEncryptionAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.
MicrosoftSqlServerSettings (dict) --
Provides information that defines a Microsoft SQL Server data provider.
ServerName (string) --
The name of the Microsoft SQL Server server.
Port (integer) --
The port value for the Microsoft SQL Server data provider.
DatabaseName (string) --
The database name on the Microsoft SQL Server data provider.
SslMode (string) --
The SSL mode used to connect to the Microsoft SQL Server data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
list
One or more tags to be assigned to the data provider.
(dict) --
A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:
AddTagsToResource
ListTagsForResource
RemoveTagsFromResource
Key (string) --
A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
ResourceArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
dict
Response Syntax
{
'DataProvider': {
'DataProviderName': 'string',
'DataProviderArn': 'string',
'DataProviderCreationTime': datetime(2015, 1, 1),
'Description': 'string',
'Engine': 'string',
'Settings': {
'PostgreSqlSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'MySqlSettings': {
'ServerName': 'string',
'Port': 123,
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'OracleSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string',
'AsmServer': 'string',
'SecretsManagerOracleAsmSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerSecurityDbEncryptionSecretId': 'string',
'SecretsManagerSecurityDbEncryptionAccessRoleArn': 'string'
},
'MicrosoftSqlServerSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
}
}
}
}
Response Structure
(dict) --
DataProvider (dict) --
The data provider that was created.
DataProviderName (string) --
The name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the data provider.
DataProviderCreationTime (datetime) --
The time the data provider was created.
Description (string) --
A description of the data provider. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
Engine (string) --
The type of database engine for the data provider. Valid values include "aurora" , "aurora_postgresql" , "mysql" , "oracle" , "postgres" , and "sqlserver" . A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
Settings (dict) --
The settings in JSON format for a data provider.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: PostgreSqlSettings, MySqlSettings, OracleSettings, MicrosoftSqlServerSettings. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
PostgreSqlSettings (dict) --
Provides information that defines a PostgreSQL data provider.
ServerName (string) --
The name of the PostgreSQL server.
Port (integer) --
The port value for the PostgreSQL data provider.
DatabaseName (string) --
The database name on the PostgreSQL data provider.
SslMode (string) --
The SSL mode used to connect to the PostgreSQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
MySqlSettings (dict) --
Provides information that defines a MySQL data provider.
ServerName (string) --
The name of the MySQL server.
Port (integer) --
The port value for the MySQL data provider.
SslMode (string) --
The SSL mode used to connect to the MySQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
OracleSettings (dict) --
Provides information that defines an Oracle data provider.
ServerName (string) --
The name of the Oracle server.
Port (integer) --
The port value for the Oracle data provider.
DatabaseName (string) --
The database name on the Oracle data provider.
SslMode (string) --
The SSL mode used to connect to the Oracle data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
AsmServer (string) --
The address of your Oracle Automatic Storage Management (ASM) server. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
SecretsManagerOracleAsmSecretId (string) --
The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.
Required only if your data provider uses the Oracle ASM server.
SecretsManagerOracleAsmAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.
SecretsManagerSecurityDbEncryptionSecretId (string) --
The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.
SecretsManagerSecurityDbEncryptionAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.
MicrosoftSqlServerSettings (dict) --
Provides information that defines a Microsoft SQL Server data provider.
ServerName (string) --
The name of the Microsoft SQL Server server.
Port (integer) --
The port value for the Microsoft SQL Server data provider.
DatabaseName (string) --
The database name on the Microsoft SQL Server data provider.
SslMode (string) --
The SSL mode used to connect to the Microsoft SQL Server data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Applies the extension pack to your target database. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.
See also: AWS API Documentation
Request Syntax
client.start_extension_pack_association(
MigrationProjectIdentifier='string'
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
dict
Response Syntax
{
'RequestIdentifier': 'string'
}
Response Structure
(dict) --
RequestIdentifier (string) --
The identifier for the request operation.
Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.
See also: AWS API Documentation
Request Syntax
client.start_metadata_model_export_as_script(
MigrationProjectIdentifier='string',
SelectionRules='string',
Origin='SOURCE'|'TARGET',
FileName='string'
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
string
[REQUIRED]
A value that specifies the database objects to export.
string
[REQUIRED]
Whether to export the metadata model from the source or the target.
string
The name of the model file to create in the Amazon S3 bucket.
dict
Response Syntax
{
'RequestIdentifier': 'string'
}
Response Structure
(dict) --
RequestIdentifier (string) --
The identifier for the export operation.
Returns a paginated list of metadata model exports.
See also: AWS API Documentation
Request Syntax
client.describe_metadata_model_exports_as_script(
MigrationProjectIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
list
Filters applied to the metadata model exports described in the form of key-value pairs.
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
string
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
dict
Response Syntax
{
'Marker': 'string',
'Requests': [
{
'Status': 'string',
'RequestIdentifier': 'string',
'MigrationProjectArn': 'string',
'Error': {
'defaultErrorDetails': {
'Message': 'string'
}
},
'ExportSqlDetails': {
'S3ObjectKey': 'string',
'ObjectURL': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Requests (list) --
A paginated list of metadata model exports.
(dict) --
Provides information about a schema conversion action.
Status (string) --
The schema conversion action status.
RequestIdentifier (string) --
The identifier for the schema conversion action.
MigrationProjectArn (string) --
The migration project ARN.
Error (dict) --
Provides error information about a project.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: defaultErrorDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
defaultErrorDetails (dict) --
Error information about a project.
Message (string) --
The error message.
ExportSqlDetails (dict) --
Provides information about a metadata model assessment exported to SQL.
S3ObjectKey (string) --
The Amazon S3 object key for the object containing the exported metadata model assessment.
ObjectURL (string) --
The URL for the object containing the exported metadata model assessment.
Returns a paginated list of metadata model imports.
See also: AWS API Documentation
Request Syntax
client.describe_metadata_model_imports(
MigrationProjectIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
list
Filters applied to the metadata model imports described in the form of key-value pairs.
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
string
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
integer
A paginated list of metadata model imports.
dict
Response Syntax
{
'Marker': 'string',
'Requests': [
{
'Status': 'string',
'RequestIdentifier': 'string',
'MigrationProjectArn': 'string',
'Error': {
'defaultErrorDetails': {
'Message': 'string'
}
},
'ExportSqlDetails': {
'S3ObjectKey': 'string',
'ObjectURL': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Requests (list) --
A paginated list of metadata model imports.
(dict) --
Provides information about a schema conversion action.
Status (string) --
The schema conversion action status.
RequestIdentifier (string) --
The identifier for the schema conversion action.
MigrationProjectArn (string) --
The migration project ARN.
Error (dict) --
Provides error information about a project.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: defaultErrorDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
defaultErrorDetails (dict) --
Error information about a project.
Message (string) --
The error message.
ExportSqlDetails (dict) --
Provides information about a metadata model assessment exported to SQL.
S3ObjectKey (string) --
The Amazon S3 object key for the object containing the exported metadata model assessment.
ObjectURL (string) --
The URL for the object containing the exported metadata model assessment.
Returns configuration parameters for a schema conversion project.
See also: AWS API Documentation
Request Syntax
client.describe_conversion_configuration(
MigrationProjectIdentifier='string'
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) for the schema conversion project to describe.
dict
Response Syntax
{
'MigrationProjectIdentifier': 'string',
'ConversionConfiguration': 'string'
}
Response Structure
(dict) --
MigrationProjectIdentifier (string) --
The name or Amazon Resource Name (ARN) for the schema conversion project.
ConversionConfiguration (string) --
The configuration parameters for the schema conversion project.
Loads the metadata for all the dependent database objects of the parent object.
This operation uses your project's Amazon S3 bucket as a metadata cache to improve performance.
See also: AWS API Documentation
Request Syntax
client.start_metadata_model_import(
MigrationProjectIdentifier='string',
SelectionRules='string',
Origin='SOURCE'|'TARGET',
Refresh=True|False
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
string
[REQUIRED]
A value that specifies the database objects to import.
string
[REQUIRED]
Whether to load metadata to the source or target database.
boolean
If true , DMS loads metadata for the specified objects from the source database.
dict
Response Syntax
{
'RequestIdentifier': 'string'
}
Response Structure
(dict) --
RequestIdentifier (string) --
The identifier for the import operation.
Creates the migration project using the specified parameters.
You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider.
See also: AWS API Documentation
Request Syntax
client.create_migration_project(
MigrationProjectName='string',
SourceDataProviderDescriptors=[
{
'DataProviderIdentifier': 'string',
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string'
},
],
TargetDataProviderDescriptors=[
{
'DataProviderIdentifier': 'string',
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string'
},
],
InstanceProfileIdentifier='string',
TransformationRules='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string',
'ResourceArn': 'string'
},
],
SchemaConversionApplicationAttributes={
'S3BucketPath': 'string',
'S3BucketRoleArn': 'string'
}
)
string
A user-friendly name for the migration project.
list
[REQUIRED]
Information about the source data provider, including the name, ARN, and Secrets Manager parameters.
(dict) --
Information about a data provider.
DataProviderIdentifier (string) -- [REQUIRED]
The name or Amazon Resource Name (ARN) of the data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
list
[REQUIRED]
Information about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.
(dict) --
Information about a data provider.
DataProviderIdentifier (string) -- [REQUIRED]
The name or Amazon Resource Name (ARN) of the data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
string
[REQUIRED]
The identifier of the associated instance profile. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
string
The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
string
A user-friendly description of the migration project.
list
One or more tags to be assigned to the migration project.
(dict) --
A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:
AddTagsToResource
ListTagsForResource
RemoveTagsFromResource
Key (string) --
A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
ResourceArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
dict
The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
S3BucketPath (string) --
The path for the Amazon S3 bucket that the application uses for exporting assessment reports.
S3BucketRoleArn (string) --
The ARN for the role the application uses to access its Amazon S3 bucket.
dict
Response Syntax
{
'MigrationProject': {
'MigrationProjectName': 'string',
'MigrationProjectArn': 'string',
'MigrationProjectCreationTime': datetime(2015, 1, 1),
'SourceDataProviderDescriptors': [
{
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'DataProviderName': 'string',
'DataProviderArn': 'string'
},
],
'TargetDataProviderDescriptors': [
{
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'DataProviderName': 'string',
'DataProviderArn': 'string'
},
],
'InstanceProfileArn': 'string',
'InstanceProfileName': 'string',
'TransformationRules': 'string',
'Description': 'string',
'SchemaConversionApplicationAttributes': {
'S3BucketPath': 'string',
'S3BucketRoleArn': 'string'
}
}
}
Response Structure
(dict) --
MigrationProject (dict) --
The migration project that was created.
MigrationProjectName (string) --
The name of the migration project.
MigrationProjectArn (string) --
The ARN string that uniquely identifies the migration project.
MigrationProjectCreationTime (datetime) --
The time when the migration project was created.
SourceDataProviderDescriptors (list) --
Information about the source data provider, including the name or ARN, and Secrets Manager parameters.
(dict) --
Information about a data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
DataProviderName (string) --
The user-friendly name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) of the data provider.
TargetDataProviderDescriptors (list) --
Information about the target data provider, including the name or ARN, and Secrets Manager parameters.
(dict) --
Information about a data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
DataProviderName (string) --
The user-friendly name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) of the data provider.
InstanceProfileArn (string) --
The Amazon Resource Name (ARN) of the instance profile for your migration project.
InstanceProfileName (string) --
The name of the associated instance profile.
TransformationRules (string) --
The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
Description (string) --
A user-friendly description of the migration project.
SchemaConversionApplicationAttributes (dict) --
The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
S3BucketPath (string) --
The path for the Amazon S3 bucket that the application uses for exporting assessment reports.
S3BucketRoleArn (string) --
The ARN for the role the application uses to access its Amazon S3 bucket.
Returns a paginated list of extension pack associations for the specified migration project. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.
See also: AWS API Documentation
Request Syntax
client.describe_extension_pack_associations(
MigrationProjectIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) for the migration project.
list
Filters applied to the extension pack associations described in the form of key-value pairs.
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
string
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
dict
Response Syntax
{
'Marker': 'string',
'Requests': [
{
'Status': 'string',
'RequestIdentifier': 'string',
'MigrationProjectArn': 'string',
'Error': {
'defaultErrorDetails': {
'Message': 'string'
}
},
'ExportSqlDetails': {
'S3ObjectKey': 'string',
'ObjectURL': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Requests (list) --
A paginated list of extension pack associations for the specified migration project.
(dict) --
Provides information about a schema conversion action.
Status (string) --
The schema conversion action status.
RequestIdentifier (string) --
The identifier for the schema conversion action.
MigrationProjectArn (string) --
The migration project ARN.
Error (dict) --
Provides error information about a project.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: defaultErrorDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
defaultErrorDetails (dict) --
Error information about a project.
Message (string) --
The error message.
ExportSqlDetails (dict) --
Provides information about a metadata model assessment exported to SQL.
S3ObjectKey (string) --
The Amazon S3 object key for the object containing the exported metadata model assessment.
ObjectURL (string) --
The URL for the object containing the exported metadata model assessment.
Converts your source database objects to a format compatible with the target database.
See also: AWS API Documentation
Request Syntax
client.start_metadata_model_conversion(
MigrationProjectIdentifier='string',
SelectionRules='string'
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
string
[REQUIRED]
A value that specifies the database objects to convert.
dict
Response Syntax
{
'RequestIdentifier': 'string'
}
Response Structure
(dict) --
RequestIdentifier (string) --
The identifier for the conversion operation.
Deletes the specified migration project.
Note
The migration project must be closed before you can delete it.
See also: AWS API Documentation
Request Syntax
client.delete_migration_project(
MigrationProjectIdentifier='string'
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the migration project to delete.
dict
Response Syntax
{
'MigrationProject': {
'MigrationProjectName': 'string',
'MigrationProjectArn': 'string',
'MigrationProjectCreationTime': datetime(2015, 1, 1),
'SourceDataProviderDescriptors': [
{
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'DataProviderName': 'string',
'DataProviderArn': 'string'
},
],
'TargetDataProviderDescriptors': [
{
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'DataProviderName': 'string',
'DataProviderArn': 'string'
},
],
'InstanceProfileArn': 'string',
'InstanceProfileName': 'string',
'TransformationRules': 'string',
'Description': 'string',
'SchemaConversionApplicationAttributes': {
'S3BucketPath': 'string',
'S3BucketRoleArn': 'string'
}
}
}
Response Structure
(dict) --
MigrationProject (dict) --
The migration project that was deleted.
MigrationProjectName (string) --
The name of the migration project.
MigrationProjectArn (string) --
The ARN string that uniquely identifies the migration project.
MigrationProjectCreationTime (datetime) --
The time when the migration project was created.
SourceDataProviderDescriptors (list) --
Information about the source data provider, including the name or ARN, and Secrets Manager parameters.
(dict) --
Information about a data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
DataProviderName (string) --
The user-friendly name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) of the data provider.
TargetDataProviderDescriptors (list) --
Information about the target data provider, including the name or ARN, and Secrets Manager parameters.
(dict) --
Information about a data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
DataProviderName (string) --
The user-friendly name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) of the data provider.
InstanceProfileArn (string) --
The Amazon Resource Name (ARN) of the instance profile for your migration project.
InstanceProfileName (string) --
The name of the associated instance profile.
TransformationRules (string) --
The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
Description (string) --
A user-friendly description of the migration project.
SchemaConversionApplicationAttributes (dict) --
The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
S3BucketPath (string) --
The path for the Amazon S3 bucket that the application uses for exporting assessment reports.
S3BucketRoleArn (string) --
The ARN for the role the application uses to access its Amazon S3 bucket.
Modifies the specified data provider using the provided settings.
Note
You must remove the data provider from all migration projects before you can modify it.
See also: AWS API Documentation
Request Syntax
client.modify_data_provider(
DataProviderIdentifier='string',
DataProviderName='string',
Description='string',
Engine='string',
ExactSettings=True|False,
Settings={
'PostgreSqlSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'MySqlSettings': {
'ServerName': 'string',
'Port': 123,
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'OracleSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string',
'AsmServer': 'string',
'SecretsManagerOracleAsmSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerSecurityDbEncryptionSecretId': 'string',
'SecretsManagerSecurityDbEncryptionAccessRoleArn': 'string'
},
'MicrosoftSqlServerSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
}
}
)
string
[REQUIRED]
The identifier of the data provider. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
string
The name of the data provider.
string
A user-friendly description of the data provider.
string
The type of database engine for the data provider. Valid values include "aurora" , "aurora_postgresql" , "mysql" , "oracle" , "postgres" , and "sqlserver" . A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
boolean
If this attribute is Y, the current call to ModifyDataProvider replaces all existing data provider settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyDataProvider does two things:
It replaces any data provider settings that already exist with new values, for settings with the same names.
It creates new data provider settings that you specify in the call, for settings with different names.
dict
The settings in JSON format for a data provider.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: PostgreSqlSettings, MySqlSettings, OracleSettings, MicrosoftSqlServerSettings.
PostgreSqlSettings (dict) --
Provides information that defines a PostgreSQL data provider.
ServerName (string) --
The name of the PostgreSQL server.
Port (integer) --
The port value for the PostgreSQL data provider.
DatabaseName (string) --
The database name on the PostgreSQL data provider.
SslMode (string) --
The SSL mode used to connect to the PostgreSQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
MySqlSettings (dict) --
Provides information that defines a MySQL data provider.
ServerName (string) --
The name of the MySQL server.
Port (integer) --
The port value for the MySQL data provider.
SslMode (string) --
The SSL mode used to connect to the MySQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
OracleSettings (dict) --
Provides information that defines an Oracle data provider.
ServerName (string) --
The name of the Oracle server.
Port (integer) --
The port value for the Oracle data provider.
DatabaseName (string) --
The database name on the Oracle data provider.
SslMode (string) --
The SSL mode used to connect to the Oracle data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
AsmServer (string) --
The address of your Oracle Automatic Storage Management (ASM) server. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
SecretsManagerOracleAsmSecretId (string) --
The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.
Required only if your data provider uses the Oracle ASM server.
SecretsManagerOracleAsmAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.
SecretsManagerSecurityDbEncryptionSecretId (string) --
The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.
SecretsManagerSecurityDbEncryptionAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.
MicrosoftSqlServerSettings (dict) --
Provides information that defines a Microsoft SQL Server data provider.
ServerName (string) --
The name of the Microsoft SQL Server server.
Port (integer) --
The port value for the Microsoft SQL Server data provider.
DatabaseName (string) --
The database name on the Microsoft SQL Server data provider.
SslMode (string) --
The SSL mode used to connect to the Microsoft SQL Server data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
dict
Response Syntax
{
'DataProvider': {
'DataProviderName': 'string',
'DataProviderArn': 'string',
'DataProviderCreationTime': datetime(2015, 1, 1),
'Description': 'string',
'Engine': 'string',
'Settings': {
'PostgreSqlSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'MySqlSettings': {
'ServerName': 'string',
'Port': 123,
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
},
'OracleSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string',
'AsmServer': 'string',
'SecretsManagerOracleAsmSecretId': 'string',
'SecretsManagerOracleAsmAccessRoleArn': 'string',
'SecretsManagerSecurityDbEncryptionSecretId': 'string',
'SecretsManagerSecurityDbEncryptionAccessRoleArn': 'string'
},
'MicrosoftSqlServerSettings': {
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'CertificateArn': 'string'
}
}
}
}
Response Structure
(dict) --
DataProvider (dict) --
The data provider that was modified.
DataProviderName (string) --
The name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the data provider.
DataProviderCreationTime (datetime) --
The time the data provider was created.
Description (string) --
A description of the data provider. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
Engine (string) --
The type of database engine for the data provider. Valid values include "aurora" , "aurora_postgresql" , "mysql" , "oracle" , "postgres" , and "sqlserver" . A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
Settings (dict) --
The settings in JSON format for a data provider.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: PostgreSqlSettings, MySqlSettings, OracleSettings, MicrosoftSqlServerSettings. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
PostgreSqlSettings (dict) --
Provides information that defines a PostgreSQL data provider.
ServerName (string) --
The name of the PostgreSQL server.
Port (integer) --
The port value for the PostgreSQL data provider.
DatabaseName (string) --
The database name on the PostgreSQL data provider.
SslMode (string) --
The SSL mode used to connect to the PostgreSQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
MySqlSettings (dict) --
Provides information that defines a MySQL data provider.
ServerName (string) --
The name of the MySQL server.
Port (integer) --
The port value for the MySQL data provider.
SslMode (string) --
The SSL mode used to connect to the MySQL data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
OracleSettings (dict) --
Provides information that defines an Oracle data provider.
ServerName (string) --
The name of the Oracle server.
Port (integer) --
The port value for the Oracle data provider.
DatabaseName (string) --
The database name on the Oracle data provider.
SslMode (string) --
The SSL mode used to connect to the Oracle data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
AsmServer (string) --
The address of your Oracle Automatic Storage Management (ASM) server. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
SecretsManagerOracleAsmSecretId (string) --
The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.
Required only if your data provider uses the Oracle ASM server.
SecretsManagerOracleAsmAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.
SecretsManagerSecurityDbEncryptionSecretId (string) --
The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.
SecretsManagerSecurityDbEncryptionAccessRoleArn (string) --
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.
MicrosoftSqlServerSettings (dict) --
Provides information that defines a Microsoft SQL Server data provider.
ServerName (string) --
The name of the Microsoft SQL Server server.
Port (integer) --
The port value for the Microsoft SQL Server data provider.
DatabaseName (string) --
The database name on the Microsoft SQL Server data provider.
SslMode (string) --
The SSL mode used to connect to the Microsoft SQL Server data provider. The default value is none .
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Returns a paginated list of metadata model conversions for a migration project.
See also: AWS API Documentation
Request Syntax
client.describe_metadata_model_conversions(
MigrationProjectIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
list
Filters applied to the metadata model conversions described in the form of key-value pairs.
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
string
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
dict
Response Syntax
{
'Marker': 'string',
'Requests': [
{
'Status': 'string',
'RequestIdentifier': 'string',
'MigrationProjectArn': 'string',
'Error': {
'defaultErrorDetails': {
'Message': 'string'
}
},
'ExportSqlDetails': {
'S3ObjectKey': 'string',
'ObjectURL': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Requests (list) --
A paginated list of metadata model conversions.
(dict) --
Provides information about a schema conversion action.
Status (string) --
The schema conversion action status.
RequestIdentifier (string) --
The identifier for the schema conversion action.
MigrationProjectArn (string) --
The migration project ARN.
Error (dict) --
Provides error information about a project.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: defaultErrorDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
defaultErrorDetails (dict) --
Error information about a project.
Message (string) --
The error message.
ExportSqlDetails (dict) --
Provides information about a metadata model assessment exported to SQL.
S3ObjectKey (string) --
The Amazon S3 object key for the object containing the exported metadata model assessment.
ObjectURL (string) --
The URL for the object containing the exported metadata model assessment.
Returns a paginated list of metadata model assessments for your account in the current region.
See also: AWS API Documentation
Request Syntax
client.describe_metadata_model_assessments(
MigrationProjectIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the migration project.
list
Filters applied to the metadata model assessments described in the form of key-value pairs.
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
string
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
dict
Response Syntax
{
'Marker': 'string',
'Requests': [
{
'Status': 'string',
'RequestIdentifier': 'string',
'MigrationProjectArn': 'string',
'Error': {
'defaultErrorDetails': {
'Message': 'string'
}
},
'ExportSqlDetails': {
'S3ObjectKey': 'string',
'ObjectURL': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Requests (list) --
A paginated list of metadata model assessments for the specified migration project.
(dict) --
Provides information about a schema conversion action.
Status (string) --
The schema conversion action status.
RequestIdentifier (string) --
The identifier for the schema conversion action.
MigrationProjectArn (string) --
The migration project ARN.
Error (dict) --
Provides error information about a project.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: defaultErrorDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
defaultErrorDetails (dict) --
Error information about a project.
Message (string) --
The error message.
ExportSqlDetails (dict) --
Provides information about a metadata model assessment exported to SQL.
S3ObjectKey (string) --
The Amazon S3 object key for the object containing the exported metadata model assessment.
ObjectURL (string) --
The URL for the object containing the exported metadata model assessment.
Returns a paginated list of migration projects for your account in the current region.
See also: AWS API Documentation
Request Syntax
client.describe_migration_projects(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to the migration projects described in the form of key-value pairs.
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
string
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
dict
Response Syntax
{
'Marker': 'string',
'MigrationProjects': [
{
'MigrationProjectName': 'string',
'MigrationProjectArn': 'string',
'MigrationProjectCreationTime': datetime(2015, 1, 1),
'SourceDataProviderDescriptors': [
{
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'DataProviderName': 'string',
'DataProviderArn': 'string'
},
],
'TargetDataProviderDescriptors': [
{
'SecretsManagerSecretId': 'string',
'SecretsManagerAccessRoleArn': 'string',
'DataProviderName': 'string',
'DataProviderArn': 'string'
},
],
'InstanceProfileArn': 'string',
'InstanceProfileName': 'string',
'TransformationRules': 'string',
'Description': 'string',
'SchemaConversionApplicationAttributes': {
'S3BucketPath': 'string',
'S3BucketRoleArn': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
MigrationProjects (list) --
A description of migration projects.
(dict) --
Provides information that defines a migration project.
MigrationProjectName (string) --
The name of the migration project.
MigrationProjectArn (string) --
The ARN string that uniquely identifies the migration project.
MigrationProjectCreationTime (datetime) --
The time when the migration project was created.
SourceDataProviderDescriptors (list) --
Information about the source data provider, including the name or ARN, and Secrets Manager parameters.
(dict) --
Information about a data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
DataProviderName (string) --
The user-friendly name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) of the data provider.
TargetDataProviderDescriptors (list) --
Information about the target data provider, including the name or ARN, and Secrets Manager parameters.
(dict) --
Information about a data provider.
SecretsManagerSecretId (string) --
The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
SecretsManagerAccessRoleArn (string) --
The ARN of the role used to access Amazon Web Services Secrets Manager.
DataProviderName (string) --
The user-friendly name of the data provider.
DataProviderArn (string) --
The Amazon Resource Name (ARN) of the data provider.
InstanceProfileArn (string) --
The Amazon Resource Name (ARN) of the instance profile for your migration project.
InstanceProfileName (string) --
The name of the associated instance profile.
TransformationRules (string) --
The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
Description (string) --
A user-friendly description of the migration project.
SchemaConversionApplicationAttributes (dict) --
The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
S3BucketPath (string) --
The path for the Amazon S3 bucket that the application uses for exporting assessment reports.
S3BucketRoleArn (string) --
The ARN for the role the application uses to access its Amazon S3 bucket.
Deletes the specified instance profile.
Note
All migration projects associated with the instance profile must be deleted or modified before you can delete the instance profile.
See also: AWS API Documentation
Request Syntax
client.delete_instance_profile(
InstanceProfileIdentifier='string'
)
string
[REQUIRED]
The identifier of the instance profile to delete.
dict
Response Syntax
{
'InstanceProfile': {
'InstanceProfileArn': 'string',
'AvailabilityZone': 'string',
'KmsKeyArn': 'string',
'PubliclyAccessible': True|False,
'NetworkType': 'string',
'InstanceProfileName': 'string',
'Description': 'string',
'InstanceProfileCreationTime': datetime(2015, 1, 1),
'SubnetGroupIdentifier': 'string',
'VpcSecurityGroups': [
'string',
]
}
}
Response Structure
(dict) --
InstanceProfile (dict) --
The instance profile that was deleted.
InstanceProfileArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
AvailabilityZone (string) --
The Availability Zone where the instance profile runs.
KmsKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true .
NetworkType (string) --
Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
InstanceProfileName (string) --
The user-friendly name for the instance profile.
Description (string) --
A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
InstanceProfileCreationTime (datetime) --
The time the instance profile was created.
SubnetGroupIdentifier (string) --
The identifier of the subnet group that is associated with the instance profile.
VpcSecurityGroups (list) --
The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
(string) --
Returns a paginated list of metadata model exports.
See also: AWS API Documentation
Request Syntax
client.describe_metadata_model_exports_to_target(
MigrationProjectIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
list
Filters applied to the metadata model exports described in the form of key-value pairs.
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
string
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
dict
Response Syntax
{
'Marker': 'string',
'Requests': [
{
'Status': 'string',
'RequestIdentifier': 'string',
'MigrationProjectArn': 'string',
'Error': {
'defaultErrorDetails': {
'Message': 'string'
}
},
'ExportSqlDetails': {
'S3ObjectKey': 'string',
'ObjectURL': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Requests (list) --
A paginated list of metadata model exports.
(dict) --
Provides information about a schema conversion action.
Status (string) --
The schema conversion action status.
RequestIdentifier (string) --
The identifier for the schema conversion action.
MigrationProjectArn (string) --
The migration project ARN.
Error (dict) --
Provides error information about a project.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: defaultErrorDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
defaultErrorDetails (dict) --
Error information about a project.
Message (string) --
The error message.
ExportSqlDetails (dict) --
Provides information about a metadata model assessment exported to SQL.
S3ObjectKey (string) --
The Amazon S3 object key for the object containing the exported metadata model assessment.
ObjectURL (string) --
The URL for the object containing the exported metadata model assessment.
Applies converted database objects to your target database.
See also: AWS API Documentation
Request Syntax
client.start_metadata_model_export_to_target(
MigrationProjectIdentifier='string',
SelectionRules='string',
OverwriteExtensionPack=True|False
)
string
[REQUIRED]
The migration project name or Amazon Resource Name (ARN).
string
[REQUIRED]
A value that specifies the database objects to export.
boolean
Whether to overwrite the migration project extension pack. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.
dict
Response Syntax
{
'RequestIdentifier': 'string'
}
Response Structure
(dict) --
RequestIdentifier (string) --
The identifier for the export operation.
Creates the instance profile using the specified parameters.
See also: AWS API Documentation
Request Syntax
client.create_instance_profile(
AvailabilityZone='string',
KmsKeyArn='string',
PubliclyAccessible=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string',
'ResourceArn': 'string'
},
],
NetworkType='string',
InstanceProfileName='string',
Description='string',
SubnetGroupIdentifier='string',
VpcSecurityGroups=[
'string',
]
)
string
The Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your data provider is created, for examplem us-east-1d .
string
The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
boolean
Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true .
list
One or more tags to be assigned to the instance profile.
(dict) --
A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:
AddTagsToResource
ListTagsForResource
RemoveTagsFromResource
Key (string) --
A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
ResourceArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
string
Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
string
A user-friendly name for the instance profile.
string
A user-friendly description of the instance profile.
string
A subnet group to associate with the instance profile.
list
Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
(string) --
dict
Response Syntax
{
'InstanceProfile': {
'InstanceProfileArn': 'string',
'AvailabilityZone': 'string',
'KmsKeyArn': 'string',
'PubliclyAccessible': True|False,
'NetworkType': 'string',
'InstanceProfileName': 'string',
'Description': 'string',
'InstanceProfileCreationTime': datetime(2015, 1, 1),
'SubnetGroupIdentifier': 'string',
'VpcSecurityGroups': [
'string',
]
}
}
Response Structure
(dict) --
InstanceProfile (dict) --
The instance profile that was created.
InstanceProfileArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
AvailabilityZone (string) --
The Availability Zone where the instance profile runs.
KmsKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true .
NetworkType (string) --
Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
InstanceProfileName (string) --
The user-friendly name for the instance profile.
Description (string) --
A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
InstanceProfileCreationTime (datetime) --
The time the instance profile was created.
SubnetGroupIdentifier (string) --
The identifier of the subnet group that is associated with the instance profile.
VpcSecurityGroups (list) --
The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
(string) --