2018/07/09 - AWS Database Migration Service - 6 updated api methods
Changes Added support for DmsTransfer endpoint type and support for re-validate option in table reload API.
{'DmsTransferSettings': {'BucketName': 'string',
'ServiceAccessRoleArn': 'string'}}
Response {'Endpoint': {'DmsTransferSettings': {'BucketName': 'string',
'ServiceAccessRoleArn': 'string'}}}
Creates an endpoint using the provided settings.
See also: AWS API Documentation
Request Syntax
client.create_endpoint(
EndpointIdentifier='string',
EndpointType='source'|'target',
EngineName='string',
Username='string',
Password='string',
ServerName='string',
Port=123,
DatabaseName='string',
ExtraConnectionAttributes='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
CertificateArn='string',
SslMode='none'|'require'|'verify-ca'|'verify-full',
ServiceAccessRoleArn='string',
ExternalTableDefinition='string',
DynamoDbSettings={
'ServiceAccessRoleArn': 'string'
},
S3Settings={
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip'
},
DmsTransferSettings={
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
MongoDbSettings={
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string'
}
)
string
[REQUIRED]
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
string
[REQUIRED]
The type of endpoint.
string
[REQUIRED]
The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.
string
The user name to be used to login to the endpoint database.
string
The password to be used to login to the endpoint database.
string
The name of the server where the endpoint database resides.
integer
The port used by the endpoint database.
string
The name of the endpoint database.
string
Additional attributes associated with the connection.
string
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
list
Tags to be added to the endpoint.
(dict) --
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
string
The Amazon Resource Name (ARN) for the certificate.
string
The SSL mode to use for the SSL connection.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
string
The Amazon Resource Name (ARN) for the service access role you want to use to create the endpoint.
string
The external table definition.
dict
Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.
ServiceAccessRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) used by the service access IAM role.
dict
Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. The default is a comma.
BucketFolder (string) --
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
BucketName (string) --
The name of the S3 bucket.
CompressionType (string) --
An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
dict
The settings in JSON format for the DMS Transfer type source endpoint.
Attributes include:
serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
bucketName - The name of the S3 bucket to use.
compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
JSON syntax:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
ServiceAccessRoleArn (string) --
The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --
The name of the S3 bucket to use.
dict
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using MongoDB as a Target for AWS Database Migration Service.
Username (string) --
The user name you use to access the MongoDB source endpoint.
Password (string) --
The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --
The name of the server on the MongoDB source endpoint.
Port (integer) --
The port value for the MongoDB source endpoint.
DatabaseName (string) --
The database name on the MongoDB source endpoint.
AuthType (string) --
The authentication type you use to access the MongoDB source endpoint.
Valid values: NO, PASSWORD
When NO is selected, user name and password parameters are not used and can be empty.
AuthMechanism (string) --
The authentication mechanism you use to access the MongoDB source endpoint.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
Default value is false.
DocsToInvestigate (string) --
Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
Must be a positive value greater than 0. Default value is 1000.
AuthSource (string) --
The MongoDB database name. This attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
dict
Response Syntax
{
'Endpoint': {
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': 'string',
'EngineDisplayName': 'string',
'Username': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'ExtraConnectionAttributes': 'string',
'Status': 'string',
'KmsKeyId': 'string',
'EndpointArn': 'string',
'CertificateArn': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'ExternalId': 'string',
'DynamoDbSettings': {
'ServiceAccessRoleArn': 'string'
},
'S3Settings': {
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip'
},
'DmsTransferSettings': {
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
'MongoDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string'
}
}
}
Response Structure
(dict) --
Endpoint (dict) --
The endpoint that was created.
EndpointIdentifier (string) --
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
EndpointType (string) --
The type of endpoint.
EngineName (string) --
The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
EngineDisplayName (string) --
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
Username (string) --
The user name used to connect to the endpoint.
ServerName (string) --
The name of the server at the endpoint.
Port (integer) --
The port value used to access the endpoint.
DatabaseName (string) --
The name of the database at the endpoint.
ExtraConnectionAttributes (string) --
Additional connection attributes used to connect to the endpoint.
Status (string) --
The status of the endpoint.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
EndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
CertificateArn (string) --
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
SslMode (string) --
The SSL mode used to connect to the endpoint.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
ExternalId (string) --
Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
DynamoDbSettings (dict) --
The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
S3Settings (dict) --
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. The default is a comma.
BucketFolder (string) --
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
BucketName (string) --
The name of the S3 bucket.
CompressionType (string) --
An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
DmsTransferSettings (dict) --
The settings in JSON format for the DMS Transfer type source endpoint.
Attributes include:
serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
bucketName - The name of the S3 bucket to use.
compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
JSON syntax:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
ServiceAccessRoleArn (string) --
The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --
The name of the S3 bucket to use.
MongoDbSettings (dict) --
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
Username (string) --
The user name you use to access the MongoDB source endpoint.
Password (string) --
The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --
The name of the server on the MongoDB source endpoint.
Port (integer) --
The port value for the MongoDB source endpoint.
DatabaseName (string) --
The database name on the MongoDB source endpoint.
AuthType (string) --
The authentication type you use to access the MongoDB source endpoint.
Valid values: NO, PASSWORD
When NO is selected, user name and password parameters are not used and can be empty.
AuthMechanism (string) --
The authentication mechanism you use to access the MongoDB source endpoint.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
Default value is false.
DocsToInvestigate (string) --
Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
Must be a positive value greater than 0. Default value is 1000.
AuthSource (string) --
The MongoDB database name. This attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
{'Endpoint': {'DmsTransferSettings': {'BucketName': 'string',
'ServiceAccessRoleArn': 'string'}}}
Deletes the specified endpoint.
Note
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
See also: AWS API Documentation
Request Syntax
client.delete_endpoint(
EndpointArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
dict
Response Syntax
{
'Endpoint': {
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': 'string',
'EngineDisplayName': 'string',
'Username': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'ExtraConnectionAttributes': 'string',
'Status': 'string',
'KmsKeyId': 'string',
'EndpointArn': 'string',
'CertificateArn': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'ExternalId': 'string',
'DynamoDbSettings': {
'ServiceAccessRoleArn': 'string'
},
'S3Settings': {
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip'
},
'DmsTransferSettings': {
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
'MongoDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string'
}
}
}
Response Structure
(dict) --
Endpoint (dict) --
The endpoint that was deleted.
EndpointIdentifier (string) --
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
EndpointType (string) --
The type of endpoint.
EngineName (string) --
The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
EngineDisplayName (string) --
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
Username (string) --
The user name used to connect to the endpoint.
ServerName (string) --
The name of the server at the endpoint.
Port (integer) --
The port value used to access the endpoint.
DatabaseName (string) --
The name of the database at the endpoint.
ExtraConnectionAttributes (string) --
Additional connection attributes used to connect to the endpoint.
Status (string) --
The status of the endpoint.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
EndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
CertificateArn (string) --
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
SslMode (string) --
The SSL mode used to connect to the endpoint.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
ExternalId (string) --
Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
DynamoDbSettings (dict) --
The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
S3Settings (dict) --
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. The default is a comma.
BucketFolder (string) --
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
BucketName (string) --
The name of the S3 bucket.
CompressionType (string) --
An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
DmsTransferSettings (dict) --
The settings in JSON format for the DMS Transfer type source endpoint.
Attributes include:
serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
bucketName - The name of the S3 bucket to use.
compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
JSON syntax:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
ServiceAccessRoleArn (string) --
The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --
The name of the S3 bucket to use.
MongoDbSettings (dict) --
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
Username (string) --
The user name you use to access the MongoDB source endpoint.
Password (string) --
The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --
The name of the server on the MongoDB source endpoint.
Port (integer) --
The port value for the MongoDB source endpoint.
DatabaseName (string) --
The database name on the MongoDB source endpoint.
AuthType (string) --
The authentication type you use to access the MongoDB source endpoint.
Valid values: NO, PASSWORD
When NO is selected, user name and password parameters are not used and can be empty.
AuthMechanism (string) --
The authentication mechanism you use to access the MongoDB source endpoint.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
Default value is false.
DocsToInvestigate (string) --
Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
Must be a positive value greater than 0. Default value is 1000.
AuthSource (string) --
The MongoDB database name. This attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
{'Endpoints': {'DmsTransferSettings': {'BucketName': 'string',
'ServiceAccessRoleArn': 'string'}}}
Returns information about the endpoints for your account in the current region.
See also: AWS API Documentation
Request Syntax
client.describe_endpoints(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
list
Filters applied to the describe action.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
(dict) --
Name (string) -- [REQUIRED]
The name of the filter.
Values (list) -- [REQUIRED]
The filter value.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'Endpoints': [
{
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': 'string',
'EngineDisplayName': 'string',
'Username': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'ExtraConnectionAttributes': 'string',
'Status': 'string',
'KmsKeyId': 'string',
'EndpointArn': 'string',
'CertificateArn': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'ExternalId': 'string',
'DynamoDbSettings': {
'ServiceAccessRoleArn': 'string'
},
'S3Settings': {
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip'
},
'DmsTransferSettings': {
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
'MongoDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Endpoints (list) --
Endpoint description.
(dict) --
EndpointIdentifier (string) --
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
EndpointType (string) --
The type of endpoint.
EngineName (string) --
The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
EngineDisplayName (string) --
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
Username (string) --
The user name used to connect to the endpoint.
ServerName (string) --
The name of the server at the endpoint.
Port (integer) --
The port value used to access the endpoint.
DatabaseName (string) --
The name of the database at the endpoint.
ExtraConnectionAttributes (string) --
Additional connection attributes used to connect to the endpoint.
Status (string) --
The status of the endpoint.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
EndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
CertificateArn (string) --
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
SslMode (string) --
The SSL mode used to connect to the endpoint.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
ExternalId (string) --
Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
DynamoDbSettings (dict) --
The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
S3Settings (dict) --
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. The default is a comma.
BucketFolder (string) --
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
BucketName (string) --
The name of the S3 bucket.
CompressionType (string) --
An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
DmsTransferSettings (dict) --
The settings in JSON format for the DMS Transfer type source endpoint.
Attributes include:
serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
bucketName - The name of the S3 bucket to use.
compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
JSON syntax:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
ServiceAccessRoleArn (string) --
The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --
The name of the S3 bucket to use.
MongoDbSettings (dict) --
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
Username (string) --
The user name you use to access the MongoDB source endpoint.
Password (string) --
The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --
The name of the server on the MongoDB source endpoint.
Port (integer) --
The port value for the MongoDB source endpoint.
DatabaseName (string) --
The database name on the MongoDB source endpoint.
AuthType (string) --
The authentication type you use to access the MongoDB source endpoint.
Valid values: NO, PASSWORD
When NO is selected, user name and password parameters are not used and can be empty.
AuthMechanism (string) --
The authentication mechanism you use to access the MongoDB source endpoint.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
Default value is false.
DocsToInvestigate (string) --
Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
Must be a positive value greater than 0. Default value is 1000.
AuthSource (string) --
The MongoDB database name. This attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
{'TableStatistics': {'ValidationStateDetails': 'string'}}
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
See also: AWS API Documentation
Request Syntax
client.describe_table_statistics(
ReplicationTaskArn='string',
MaxRecords=123,
Marker='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 500.
string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
list
Filters applied to the describe table statistics action.
Valid filter names: schema-name | table-name | table-state
A combination of filters creates an AND condition where each record matches all specified filters.
(dict) --
Name (string) -- [REQUIRED]
The name of the filter.
Values (list) -- [REQUIRED]
The filter value.
(string) --
dict
Response Syntax
{
'ReplicationTaskArn': 'string',
'TableStatistics': [
{
'SchemaName': 'string',
'TableName': 'string',
'Inserts': 123,
'Deletes': 123,
'Updates': 123,
'Ddls': 123,
'FullLoadRows': 123,
'FullLoadCondtnlChkFailedRows': 123,
'FullLoadErrorRows': 123,
'LastUpdateTime': datetime(2015, 1, 1),
'TableState': 'string',
'ValidationPendingRecords': 123,
'ValidationFailedRecords': 123,
'ValidationSuspendedRecords': 123,
'ValidationState': 'string',
'ValidationStateDetails': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.
TableStatistics (list) --
The table statistics.
(dict) --
SchemaName (string) --
The schema name.
TableName (string) --
The name of the table.
Inserts (integer) --
The number of insert actions performed on a table.
Deletes (integer) --
The number of delete actions performed on a table.
Updates (integer) --
The number of update actions performed on a table.
Ddls (integer) --
The Data Definition Language (DDL) used to build and modify the structure of your tables.
FullLoadRows (integer) --
The number of rows added during the Full Load operation.
FullLoadCondtnlChkFailedRows (integer) --
The number of rows that failed conditional checks during the Full Load operation (valid only for DynamoDB as a target migrations).
FullLoadErrorRows (integer) --
The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).
LastUpdateTime (datetime) --
The last time the table was updated.
TableState (string) --
The state of the tables described.
Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded
ValidationPendingRecords (integer) --
The number of records that have yet to be validated.
ValidationFailedRecords (integer) --
The number of records that failed validation.
ValidationSuspendedRecords (integer) --
The number of records that could not be validated.
ValidationState (string) --
The validation state of the table.
The parameter can have the following values
Not enabled—Validation is not enabled for the table in the migration task.
Pending records—Some records in the table are waiting for validation.
Mismatched records—Some records in the table do not match between the source and target.
Suspended records—Some records in the table could not be validated.
No primary key—The table could not be validated because it had no primary key.
Table error—The table was not validated because it was in an error state and some data was not migrated.
Validated—All rows in the table were validated. If the table is updated, the status can change from Validated.
Error—The table could not be validated because of an unexpected error.
ValidationStateDetails (string) --
Additional details about the state of validation.
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
{'DmsTransferSettings': {'BucketName': 'string',
'ServiceAccessRoleArn': 'string'}}
Response {'Endpoint': {'DmsTransferSettings': {'BucketName': 'string',
'ServiceAccessRoleArn': 'string'}}}
Modifies the specified endpoint.
See also: AWS API Documentation
Request Syntax
client.modify_endpoint(
EndpointArn='string',
EndpointIdentifier='string',
EndpointType='source'|'target',
EngineName='string',
Username='string',
Password='string',
ServerName='string',
Port=123,
DatabaseName='string',
ExtraConnectionAttributes='string',
CertificateArn='string',
SslMode='none'|'require'|'verify-ca'|'verify-full',
ServiceAccessRoleArn='string',
ExternalTableDefinition='string',
DynamoDbSettings={
'ServiceAccessRoleArn': 'string'
},
S3Settings={
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip'
},
DmsTransferSettings={
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
MongoDbSettings={
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
string
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
string
The type of endpoint.
string
The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
string
The user name to be used to login to the endpoint database.
string
The password to be used to login to the endpoint database.
string
The name of the server where the endpoint database resides.
integer
The port used by the endpoint database.
string
The name of the endpoint database.
string
Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
string
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
string
The SSL mode to be used.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
string
The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.
string
The external table definition.
dict
Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.
ServiceAccessRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) used by the service access IAM role.
dict
Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. The default is a comma.
BucketFolder (string) --
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
BucketName (string) --
The name of the S3 bucket.
CompressionType (string) --
An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
dict
The settings in JSON format for the DMS Transfer type source endpoint.
Attributes include:
serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
BucketName - The name of the S3 bucket to use.
compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
JSON syntax:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
ServiceAccessRoleArn (string) --
The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --
The name of the S3 bucket to use.
dict
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.
Username (string) --
The user name you use to access the MongoDB source endpoint.
Password (string) --
The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --
The name of the server on the MongoDB source endpoint.
Port (integer) --
The port value for the MongoDB source endpoint.
DatabaseName (string) --
The database name on the MongoDB source endpoint.
AuthType (string) --
The authentication type you use to access the MongoDB source endpoint.
Valid values: NO, PASSWORD
When NO is selected, user name and password parameters are not used and can be empty.
AuthMechanism (string) --
The authentication mechanism you use to access the MongoDB source endpoint.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
Default value is false.
DocsToInvestigate (string) --
Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
Must be a positive value greater than 0. Default value is 1000.
AuthSource (string) --
The MongoDB database name. This attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
dict
Response Syntax
{
'Endpoint': {
'EndpointIdentifier': 'string',
'EndpointType': 'source'|'target',
'EngineName': 'string',
'EngineDisplayName': 'string',
'Username': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'ExtraConnectionAttributes': 'string',
'Status': 'string',
'KmsKeyId': 'string',
'EndpointArn': 'string',
'CertificateArn': 'string',
'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'ExternalId': 'string',
'DynamoDbSettings': {
'ServiceAccessRoleArn': 'string'
},
'S3Settings': {
'ServiceAccessRoleArn': 'string',
'ExternalTableDefinition': 'string',
'CsvRowDelimiter': 'string',
'CsvDelimiter': 'string',
'BucketFolder': 'string',
'BucketName': 'string',
'CompressionType': 'none'|'gzip'
},
'DmsTransferSettings': {
'ServiceAccessRoleArn': 'string',
'BucketName': 'string'
},
'MongoDbSettings': {
'Username': 'string',
'Password': 'string',
'ServerName': 'string',
'Port': 123,
'DatabaseName': 'string',
'AuthType': 'no'|'password',
'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
'NestingLevel': 'none'|'one',
'ExtractDocId': 'string',
'DocsToInvestigate': 'string',
'AuthSource': 'string',
'KmsKeyId': 'string'
}
}
}
Response Structure
(dict) --
Endpoint (dict) --
The modified endpoint.
EndpointIdentifier (string) --
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
EndpointType (string) --
The type of endpoint.
EngineName (string) --
The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.
EngineDisplayName (string) --
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
Username (string) --
The user name used to connect to the endpoint.
ServerName (string) --
The name of the server at the endpoint.
Port (integer) --
The port value used to access the endpoint.
DatabaseName (string) --
The name of the database at the endpoint.
ExtraConnectionAttributes (string) --
Additional connection attributes used to connect to the endpoint.
Status (string) --
The status of the endpoint.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
EndpointArn (string) --
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
CertificateArn (string) --
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
SslMode (string) --
The SSL mode used to connect to the endpoint.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
The default value is none.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
ExternalId (string) --
Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
DynamoDbSettings (dict) --
The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
S3Settings (dict) --
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
ServiceAccessRoleArn (string) --
The Amazon Resource Name (ARN) used by the service access IAM role.
ExternalTableDefinition (string) --
The external table definition.
CsvRowDelimiter (string) --
The delimiter used to separate rows in the source files. The default is a carriage return (n).
CsvDelimiter (string) --
The delimiter used to separate columns in the source files. The default is a comma.
BucketFolder (string) --
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
BucketName (string) --
The name of the S3 bucket.
CompressionType (string) --
An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
DmsTransferSettings (dict) --
The settings in JSON format for the DMS Transfer type source endpoint.
Attributes include:
serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
bucketName - The name of the S3 bucket to use.
compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
JSON syntax:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
ServiceAccessRoleArn (string) --
The IAM role that has permission to access the Amazon S3 bucket.
BucketName (string) --
The name of the S3 bucket to use.
MongoDbSettings (dict) --
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
Username (string) --
The user name you use to access the MongoDB source endpoint.
Password (string) --
The password for the user account you use to access the MongoDB source endpoint.
ServerName (string) --
The name of the server on the MongoDB source endpoint.
Port (integer) --
The port value for the MongoDB source endpoint.
DatabaseName (string) --
The database name on the MongoDB source endpoint.
AuthType (string) --
The authentication type you use to access the MongoDB source endpoint.
Valid values: NO, PASSWORD
When NO is selected, user name and password parameters are not used and can be empty.
AuthMechanism (string) --
The authentication mechanism you use to access the MongoDB source endpoint.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
NestingLevel (string) --
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
ExtractDocId (string) --
Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
Default value is false.
DocsToInvestigate (string) --
Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
Must be a positive value greater than 0. Default value is 1000.
AuthSource (string) --
The MongoDB database name. This attribute is not used when authType=NO .
The default is admin.
KmsKeyId (string) --
The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
{'ReloadOption': 'data-reload | validate-only'}
Reloads the target database table with the source data.
See also: AWS API Documentation
Request Syntax
client.reload_tables(
ReplicationTaskArn='string',
TablesToReload=[
{
'SchemaName': 'string',
'TableName': 'string'
},
],
ReloadOption='data-reload'|'validate-only'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication task.
list
[REQUIRED]
The name and schema of the table to be reloaded.
(dict) --
SchemaName (string) --
The schema name of the table to be reloaded.
TableName (string) --
The table name of the table to be reloaded.
string
Options for reload. Specify data-reload to reload the data and re-validate it if validation is enabled. Specify validate-only to re-validate the table. This option applies only when validation is enabled for the task.
Valid values: data-reload, validate-only
Default value is data-reload.
dict
Response Syntax
{
'ReplicationTaskArn': 'string'
}
Response Structure
(dict) --
ReplicationTaskArn (string) --
The Amazon Resource Name (ARN) of the replication task.