DatabaseMigrationService

Client

class DatabaseMigrationService.Client

A low-level client representing AWS Database Migration Service:

client = session.create_client('dms')

These are the available methods:

add_tags_to_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.add_tags_to_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be added to. AWS DMS resources include a replication instance, endpoint, and a replication task.

  • Tags (list) --

    [REQUIRED]

    The tag to be assigned to the DMS resource.

    • (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}_.:/=+\-]*)$").

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_endpoint(**kwargs)

Creates an endpoint using the provided settings.

See also: AWS API Documentation

Request Syntax

response = 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'
    },
    KinesisSettings={
        'StreamArn': 'string',
        'MessageFormat': 'json',
        'ServiceAccessRoleArn': 'string'
    },
    ElasticsearchSettings={
        'ServiceAccessRoleArn': 'string',
        'EndpointUri': 'string',
        'FullLoadErrorPercentage': 123,
        'ErrorRetryDuration': 123
    }
)
Parameters
  • EndpointIdentifier (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.

  • EndpointType (string) --

    [REQUIRED]

    The type of endpoint.

  • EngineName (string) --

    [REQUIRED]

    The type of engine for the endpoint. Valid values, depending on the EndPointType value, include mysql , oracle , postgres , mariadb , aurora , aurora-postgresql , redshift , s3 , db2 , azuredb , sybase , dynamodb , mongodb , and sqlserver .

  • Username (string) -- The user name to be used to log in to the endpoint database.
  • Password (string) -- The password to be used to log in to the endpoint database.
  • ServerName (string) -- The name of the server where the endpoint database resides.
  • Port (integer) -- The port used by the endpoint database.
  • DatabaseName (string) -- The name of the endpoint database.
  • ExtraConnectionAttributes (string) -- Additional attributes associated with the connection.
  • KmsKeyId (string) -- The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  • Tags (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}_.:/=+\-]*)$").

  • CertificateArn (string) -- The Amazon Resource Name (ARN) for the certificate.
  • SslMode (string) -- The Secure Sockets Layer (SSL) mode to use for the SSL connection. The 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) for the service access role that you want to use to create the endpoint.
  • ExternalTableDefinition (string) -- The external table definition.
  • DynamoDbSettings (dict) --

    Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.

    • ServiceAccessRoleArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) used by the service access IAM role.

  • S3Settings (dict) --

    Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

    • 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 of source endpoint.

    Possible attributes include the following:

    • 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. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

    Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

    JSON syntax for these attributes is as follows: { "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) --

    Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

    • 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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

  • KinesisSettings (dict) --

    Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see `Using Object Mapping to Migrate Data to a Kinesis Data Stream <http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping >`__ in the AWS Database Migration User Guide.

    • StreamArn (string) --

      The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

    • MessageFormat (string) --

      The output format for the records created on the endpoint. The message format is JSON .

    • ServiceAccessRoleArn (string) --

      The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

  • ElasticsearchSettings (dict) --

    Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.

    • ServiceAccessRoleArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) used by service to access the IAM role.

    • EndpointUri (string) -- [REQUIRED]

      The endpoint for the ElasticSearch cluster.

    • FullLoadErrorPercentage (integer) --

      The maximum percentage of records that can fail to be written before a full load operation stops.

    • ErrorRetryDuration (integer) --

      The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

Return type

dict

Returns

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'
        },
        'KinesisSettings': {
            'StreamArn': 'string',
            'MessageFormat': 'json',
            'ServiceAccessRoleArn': 'string'
        },
        'ElasticsearchSettings': {
            'ServiceAccessRoleArn': 'string',
            'EndpointUri': 'string',
            'FullLoadErrorPercentage': 123,
            'ErrorRetryDuration': 123
        }
    }
}

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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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 of source endpoint.

        Possible attributes include the following:

        • 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. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

        Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

        JSON syntax for these attributes is as follows: { "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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

      • KinesisSettings (dict) --

        The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.

        • StreamArn (string) --

          The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

        • MessageFormat (string) --

          The output format for the records created on the endpoint. The message format is JSON .

        • ServiceAccessRoleArn (string) --

          The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

      • ElasticsearchSettings (dict) --

        The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

        • ServiceAccessRoleArn (string) --

          The Amazon Resource Name (ARN) used by service to access the IAM role.

        • EndpointUri (string) --

          The endpoint for the ElasticSearch cluster.

        • FullLoadErrorPercentage (integer) --

          The maximum percentage of records that can fail to be written before a full load operation stops.

        • ErrorRetryDuration (integer) --

          The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

create_event_subscription(**kwargs)

Creates an AWS DMS event notification subscription.

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

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

See also: AWS API Documentation

Request Syntax

response = client.create_event_subscription(
    SubscriptionName='string',
    SnsTopicArn='string',
    SourceType='string',
    EventCategories=[
        'string',
    ],
    SourceIds=[
        'string',
    ],
    Enabled=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • SubscriptionName (string) --

    [REQUIRED]

    The name of the AWS DMS event notification subscription.

    Constraints: The name must be less than 255 characters.

  • SnsTopicArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

  • SourceType (string) --

    The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance . If this value is not specified, all events are returned.

    Valid values: replication-instance | migration-task

  • EventCategories (list) --

    A list of event categories for a source type that you want to subscribe to. You can see a list of the categories for a given source type by calling the DescribeEventCategories action or in the topic Working with Events and Notifications in the AWS Database Migration Service User Guide.

    • (string) --
  • SourceIds (list) --

    The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

    • (string) --
  • Enabled (boolean) -- A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.
  • Tags (list) --

    A tag to be attached to the event subscription.

    • (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}_.:/=+\-]*)$").

Return type

dict

Returns

Response Syntax

{
    'EventSubscription': {
        'CustomerAwsId': 'string',
        'CustSubscriptionId': 'string',
        'SnsTopicArn': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string',
        'SourceType': 'string',
        'SourceIdsList': [
            'string',
        ],
        'EventCategoriesList': [
            'string',
        ],
        'Enabled': True|False
    }
}

Response Structure

  • (dict) --

    • EventSubscription (dict) --

      The event subscription that was created.

      • CustomerAwsId (string) --

        The AWS customer account associated with the AWS DMS event notification subscription.

      • CustSubscriptionId (string) --

        The AWS DMS event notification subscription Id.

      • SnsTopicArn (string) --

        The topic ARN of the AWS DMS event notification subscription.

      • Status (string) --

        The status of the AWS DMS event notification subscription.

        Constraints:

        Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

        The status "no-permission" indicates that AWS DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

      • SubscriptionCreationTime (string) --

        The time the RDS event notification subscription was created.

      • SourceType (string) --

        The type of AWS DMS resource that generates events.

        Valid values: replication-instance | replication-server | security-group | migration-task

      • SourceIdsList (list) --

        A list of source Ids for the event subscription.

        • (string) --
      • EventCategoriesList (list) --

        A lists of event categories.

        • (string) --
      • Enabled (boolean) --

        Boolean value that indicates if the event subscription is enabled.

create_replication_instance(**kwargs)

Creates the replication instance using the specified parameters.

See also: AWS API Documentation

Request Syntax

response = client.create_replication_instance(
    ReplicationInstanceIdentifier='string',
    AllocatedStorage=123,
    ReplicationInstanceClass='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    AvailabilityZone='string',
    ReplicationSubnetGroupIdentifier='string',
    PreferredMaintenanceWindow='string',
    MultiAZ=True|False,
    EngineVersion='string',
    AutoMinorVersionUpgrade=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    KmsKeyId='string',
    PubliclyAccessible=True|False,
    DnsNameServers='string'
)
Parameters
  • ReplicationInstanceIdentifier (string) --

    [REQUIRED]

    The replication instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: myrepinstance

  • AllocatedStorage (integer) -- The amount of storage (in gigabytes) to be initially allocated for the replication instance.
  • ReplicationInstanceClass (string) --

    [REQUIRED]

    The compute and memory capacity of the replication instance as specified by the replication instance class.

    Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

  • VpcSecurityGroupIds (list) --

    Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.

    • (string) --
  • AvailabilityZone (string) --

    The EC2 Availability Zone that the replication instance will be created in.

    Default: A random, system-chosen Availability Zone in the endpoint's region.

    Example: us-east-1d

  • ReplicationSubnetGroupIdentifier (string) -- A subnet group to associate with the replication instance.
  • PreferredMaintenanceWindow (string) --

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

  • MultiAZ (boolean) -- Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
  • EngineVersion (string) -- The engine version number of the replication instance.
  • AutoMinorVersionUpgrade (boolean) --

    Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.

    Default: true

  • Tags (list) --

    Tags to be associated with the replication instance.

    • (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}_.:/=+\-]*)$").

  • KmsKeyId (string) -- The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.
  • PubliclyAccessible (boolean) -- Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true .
  • DnsNameServers (string) -- A list of DNS name servers supported for the replication instance.
Return type

dict

Returns

Response Syntax

{
    'ReplicationInstance': {
        'ReplicationInstanceIdentifier': 'string',
        'ReplicationInstanceClass': 'string',
        'ReplicationInstanceStatus': 'string',
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'ReplicationSubnetGroup': {
            'ReplicationSubnetGroupIdentifier': 'string',
            'ReplicationSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': 'string'
                },
            ]
        },
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'ReplicationInstanceClass': 'string',
            'AllocatedStorage': 123,
            'MultiAZ': True|False,
            'EngineVersion': 'string'
        },
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'KmsKeyId': 'string',
        'ReplicationInstanceArn': 'string',
        'ReplicationInstancePublicIpAddress': 'string',
        'ReplicationInstancePrivateIpAddress': 'string',
        'ReplicationInstancePublicIpAddresses': [
            'string',
        ],
        'ReplicationInstancePrivateIpAddresses': [
            'string',
        ],
        'PubliclyAccessible': True|False,
        'SecondaryAvailabilityZone': 'string',
        'FreeUntil': datetime(2015, 1, 1),
        'DnsNameServers': 'string'
    }
}

Response Structure

  • (dict) --

    • ReplicationInstance (dict) --

      The replication instance that was created.

      • ReplicationInstanceIdentifier (string) --

        The replication instance identifier. This parameter is stored as a lowercase string.

        Constraints:

        • Must contain from 1 to 63 alphanumeric characters or hyphens.
        • First character must be a letter.
        • Cannot end with a hyphen or contain two consecutive hyphens.

        Example: myrepinstance

      • ReplicationInstanceClass (string) --

        The compute and memory capacity of the replication instance.

        Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

      • ReplicationInstanceStatus (string) --

        The status of the replication instance.

      • AllocatedStorage (integer) --

        The amount of storage (in gigabytes) that is allocated for the replication instance.

      • InstanceCreateTime (datetime) --

        The time the replication instance was created.

      • VpcSecurityGroups (list) --

        The VPC security group for the instance.

        • (dict) --

          • VpcSecurityGroupId (string) --

            The VPC security group Id.

          • Status (string) --

            The status of the VPC security group.

      • AvailabilityZone (string) --

        The Availability Zone for the instance.

      • ReplicationSubnetGroup (dict) --

        The subnet group for the replication instance.

        • ReplicationSubnetGroupIdentifier (string) --

          The identifier of the replication instance subnet group.

        • ReplicationSubnetGroupDescription (string) --

          The description of the replication subnet group.

        • VpcId (string) --

          The ID of the VPC.

        • SubnetGroupStatus (string) --

          The status of the subnet group.

        • Subnets (list) --

          The subnets that are in the subnet group.

          • (dict) --

            • SubnetIdentifier (string) --

              The subnet identifier.

            • SubnetAvailabilityZone (dict) --

              The Availability Zone of the subnet.

              • Name (string) --

                The name of the availability zone.

            • SubnetStatus (string) --

              The status of the subnet.

      • PreferredMaintenanceWindow (string) --

        The maintenance window times for the replication instance.

      • PendingModifiedValues (dict) --

        The pending modification values.

        • ReplicationInstanceClass (string) --

          The compute and memory capacity of the replication instance.

          Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

        • AllocatedStorage (integer) --

          The amount of storage (in gigabytes) that is allocated for the replication instance.

        • MultiAZ (boolean) --

          Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

        • EngineVersion (string) --

          The engine version number of the replication instance.

      • MultiAZ (boolean) --

        Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

      • EngineVersion (string) --

        The engine version number of the replication instance.

      • AutoMinorVersionUpgrade (boolean) --

        Boolean value indicating if minor version upgrades will be automatically applied to the instance.

      • KmsKeyId (string) --

        The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • ReplicationInstancePublicIpAddress (string) --

        The public IP address of the replication instance.

      • ReplicationInstancePrivateIpAddress (string) --

        The private IP address of the replication instance.

      • ReplicationInstancePublicIpAddresses (list) --

        The public IP address of the replication instance.

        • (string) --
      • ReplicationInstancePrivateIpAddresses (list) --

        The private IP address of the replication instance.

        • (string) --
      • PubliclyAccessible (boolean) --

        Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true .

      • SecondaryAvailabilityZone (string) --

        The availability zone of the standby replication instance in a Multi-AZ deployment.

      • FreeUntil (datetime) --

        The expiration date of the free replication instance that is part of the Free DMS program.

      • DnsNameServers (string) --

        The DNS name servers for the replication instance.

create_replication_subnet_group(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_replication_subnet_group(
    ReplicationSubnetGroupIdentifier='string',
    ReplicationSubnetGroupDescription='string',
    SubnetIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ReplicationSubnetGroupIdentifier (string) --

    [REQUIRED]

    The name for the replication subnet group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be "default".

    Example: mySubnetgroup

  • ReplicationSubnetGroupDescription (string) --

    [REQUIRED]

    The description for the subnet group.

  • SubnetIds (list) --

    [REQUIRED]

    The EC2 subnet IDs for the subnet group.

    • (string) --
  • Tags (list) --

    The tag to be assigned to the subnet group.

    • (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}_.:/=+\-]*)$").

Return type

dict

Returns

Response Syntax

{
    'ReplicationSubnetGroup': {
        'ReplicationSubnetGroupIdentifier': 'string',
        'ReplicationSubnetGroupDescription': 'string',
        'VpcId': 'string',
        'SubnetGroupStatus': 'string',
        'Subnets': [
            {
                'SubnetIdentifier': 'string',
                'SubnetAvailabilityZone': {
                    'Name': 'string'
                },
                'SubnetStatus': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ReplicationSubnetGroup (dict) --

      The replication subnet group that was created.

      • ReplicationSubnetGroupIdentifier (string) --

        The identifier of the replication instance subnet group.

      • ReplicationSubnetGroupDescription (string) --

        The description of the replication subnet group.

      • VpcId (string) --

        The ID of the VPC.

      • SubnetGroupStatus (string) --

        The status of the subnet group.

      • Subnets (list) --

        The subnets that are in the subnet group.

        • (dict) --

          • SubnetIdentifier (string) --

            The subnet identifier.

          • SubnetAvailabilityZone (dict) --

            The Availability Zone of the subnet.

            • Name (string) --

              The name of the availability zone.

          • SubnetStatus (string) --

            The status of the subnet.

create_replication_task(**kwargs)

Creates a replication task using the specified parameters.

See also: AWS API Documentation

Request Syntax

response = client.create_replication_task(
    ReplicationTaskIdentifier='string',
    SourceEndpointArn='string',
    TargetEndpointArn='string',
    ReplicationInstanceArn='string',
    MigrationType='full-load'|'cdc'|'full-load-and-cdc',
    TableMappings='string',
    ReplicationTaskSettings='string',
    CdcStartTime=datetime(2015, 1, 1),
    CdcStartPosition='string',
    CdcStopPosition='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ReplicationTaskIdentifier (string) --

    [REQUIRED]

    The replication task identifier.

    Constraints:

    • Must contain from 1 to 255 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.
  • SourceEndpointArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

  • TargetEndpointArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

  • ReplicationInstanceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication instance.

  • MigrationType (string) --

    [REQUIRED]

    The migration type.

  • TableMappings (string) --

    [REQUIRED]

    When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with "file://". When working with the DMS API, provide the JSON as the parameter value.

    For example, --table-mappings file://mappingfile.json

  • ReplicationTaskSettings (string) -- Settings for the task, such as target metadata settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration User Guide.
  • CdcStartTime (datetime) --

    Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

    Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

  • CdcStartPosition (string) --

    Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

    The value can be in date, checkpoint, or LSN/SCN format.

    Date Example: --cdc-start-position “2018-03-08T12:12:12”

    Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

    LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

  • CdcStopPosition (string) --

    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

    Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

    Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

  • Tags (list) --

    Tags to be added to the replication instance.

    • (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}_.:/=+\-]*)$").

Return type

dict

Returns

Response Syntax

{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123
        }
    }
}

Response Structure

  • (dict) --

    • ReplicationTask (dict) --

      The replication task that was created.

      • ReplicationTaskIdentifier (string) --

        The user-assigned replication task identifier or name.

        Constraints:

        • Must contain from 1 to 255 alphanumeric characters or hyphens.
        • First character must be a letter.
        • Cannot end with a hyphen or contain two consecutive hyphens.
      • SourceEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • TargetEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • MigrationType (string) --

        The type of migration.

      • TableMappings (string) --

        Table mappings specified in the task.

      • ReplicationTaskSettings (string) --

        The settings for the replication task.

      • Status (string) --

        The status of the replication task.

      • LastFailureMessage (string) --

        The last error (failure) message generated for the replication instance.

      • StopReason (string) --

        The reason the replication task was stopped.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        The date the replication task is scheduled to start.

      • CdcStartPosition (string) --

        Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

        The value can be in date, checkpoint, or LSN/SCN format.

        Date Example: --cdc-start-position “2018-03-08T12:12:12”

        Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

        LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

      • CdcStopPosition (string) --

        Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

        Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

        Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

      • RecoveryCheckpoint (string) --

        Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        The statistics for the task, including elapsed time, tables loaded, and table errors.

        • FullLoadProgressPercent (integer) --

          The percent complete for the full load migration task.

        • ElapsedTimeMillis (integer) --

          The elapsed time of the task, in milliseconds.

        • TablesLoaded (integer) --

          The number of tables loaded for this task.

        • TablesLoading (integer) --

          The number of tables currently loading for this task.

        • TablesQueued (integer) --

          The number of tables queued for this task.

        • TablesErrored (integer) --

          The number of errors that have occurred during this task.

delete_certificate(**kwargs)

Deletes the specified certificate.

See also: AWS API Documentation

Request Syntax

response = client.delete_certificate(
    CertificateArn='string'
)
Parameters
CertificateArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the deleted certificate.

Return type
dict
Returns
Response Syntax
{
    'Certificate': {
        'CertificateIdentifier': 'string',
        'CertificateCreationDate': datetime(2015, 1, 1),
        'CertificatePem': 'string',
        'CertificateWallet': b'bytes',
        'CertificateArn': 'string',
        'CertificateOwner': 'string',
        'ValidFromDate': datetime(2015, 1, 1),
        'ValidToDate': datetime(2015, 1, 1),
        'SigningAlgorithm': 'string',
        'KeyLength': 123
    }
}

Response Structure

  • (dict) --
    • Certificate (dict) --

      The Secure Sockets Layer (SSL) certificate.

      • CertificateIdentifier (string) --

        The customer-assigned name of the certificate. Valid characters are A-z and 0-9.

      • CertificateCreationDate (datetime) --

        The date that the certificate was created.

      • CertificatePem (string) --

        The contents of the .pem X.509 certificate file for the certificate.

      • CertificateWallet (bytes) --

        The location of the imported Oracle Wallet certificate for use with SSL.

      • CertificateArn (string) --

        The Amazon Resource Name (ARN) for the certificate.

      • CertificateOwner (string) --

        The owner of the certificate.

      • ValidFromDate (datetime) --

        The beginning date that the certificate is valid.

      • ValidToDate (datetime) --

        The final date that the certificate is valid.

      • SigningAlgorithm (string) --

        The signing algorithm for the certificate.

      • KeyLength (integer) --

        The key length of the cryptographic algorithm being used.

delete_endpoint(**kwargs)

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

response = client.delete_endpoint(
    EndpointArn='string'
)
Parameters
EndpointArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Return type
dict
Returns
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'
        },
        'KinesisSettings': {
            'StreamArn': 'string',
            'MessageFormat': 'json',
            'ServiceAccessRoleArn': 'string'
        },
        'ElasticsearchSettings': {
            'ServiceAccessRoleArn': 'string',
            'EndpointUri': 'string',
            'FullLoadErrorPercentage': 123,
            'ErrorRetryDuration': 123
        }
    }
}

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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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 of source endpoint.

        Possible attributes include the following:

        • 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. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

        Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

        JSON syntax for these attributes is as follows: { "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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

      • KinesisSettings (dict) --

        The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.

        • StreamArn (string) --

          The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

        • MessageFormat (string) --

          The output format for the records created on the endpoint. The message format is JSON .

        • ServiceAccessRoleArn (string) --

          The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

      • ElasticsearchSettings (dict) --

        The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

        • ServiceAccessRoleArn (string) --

          The Amazon Resource Name (ARN) used by service to access the IAM role.

        • EndpointUri (string) --

          The endpoint for the ElasticSearch cluster.

        • FullLoadErrorPercentage (integer) --

          The maximum percentage of records that can fail to be written before a full load operation stops.

        • ErrorRetryDuration (integer) --

          The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

delete_event_subscription(**kwargs)

Deletes an AWS DMS event subscription.

See also: AWS API Documentation

Request Syntax

response = client.delete_event_subscription(
    SubscriptionName='string'
)
Parameters
SubscriptionName (string) --

[REQUIRED]

The name of the DMS event notification subscription to be deleted.

Return type
dict
Returns
Response Syntax
{
    'EventSubscription': {
        'CustomerAwsId': 'string',
        'CustSubscriptionId': 'string',
        'SnsTopicArn': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string',
        'SourceType': 'string',
        'SourceIdsList': [
            'string',
        ],
        'EventCategoriesList': [
            'string',
        ],
        'Enabled': True|False
    }
}

Response Structure

  • (dict) --
    • EventSubscription (dict) --

      The event subscription that was deleted.

      • CustomerAwsId (string) --

        The AWS customer account associated with the AWS DMS event notification subscription.

      • CustSubscriptionId (string) --

        The AWS DMS event notification subscription Id.

      • SnsTopicArn (string) --

        The topic ARN of the AWS DMS event notification subscription.

      • Status (string) --

        The status of the AWS DMS event notification subscription.

        Constraints:

        Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

        The status "no-permission" indicates that AWS DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

      • SubscriptionCreationTime (string) --

        The time the RDS event notification subscription was created.

      • SourceType (string) --

        The type of AWS DMS resource that generates events.

        Valid values: replication-instance | replication-server | security-group | migration-task

      • SourceIdsList (list) --

        A list of source Ids for the event subscription.

        • (string) --
      • EventCategoriesList (list) --

        A lists of event categories.

        • (string) --
      • Enabled (boolean) --

        Boolean value that indicates if the event subscription is enabled.

delete_replication_instance(**kwargs)

Deletes the specified replication instance.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.delete_replication_instance(
    ReplicationInstanceArn='string'
)
Parameters
ReplicationInstanceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the replication instance to be deleted.

Return type
dict
Returns
Response Syntax
{
    'ReplicationInstance': {
        'ReplicationInstanceIdentifier': 'string',
        'ReplicationInstanceClass': 'string',
        'ReplicationInstanceStatus': 'string',
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'ReplicationSubnetGroup': {
            'ReplicationSubnetGroupIdentifier': 'string',
            'ReplicationSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': 'string'
                },
            ]
        },
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'ReplicationInstanceClass': 'string',
            'AllocatedStorage': 123,
            'MultiAZ': True|False,
            'EngineVersion': 'string'
        },
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'KmsKeyId': 'string',
        'ReplicationInstanceArn': 'string',
        'ReplicationInstancePublicIpAddress': 'string',
        'ReplicationInstancePrivateIpAddress': 'string',
        'ReplicationInstancePublicIpAddresses': [
            'string',
        ],
        'ReplicationInstancePrivateIpAddresses': [
            'string',
        ],
        'PubliclyAccessible': True|False,
        'SecondaryAvailabilityZone': 'string',
        'FreeUntil': datetime(2015, 1, 1),
        'DnsNameServers': 'string'
    }
}

Response Structure

  • (dict) --
    • ReplicationInstance (dict) --

      The replication instance that was deleted.

      • ReplicationInstanceIdentifier (string) --

        The replication instance identifier. This parameter is stored as a lowercase string.

        Constraints:

        • Must contain from 1 to 63 alphanumeric characters or hyphens.
        • First character must be a letter.
        • Cannot end with a hyphen or contain two consecutive hyphens.

        Example: myrepinstance

      • ReplicationInstanceClass (string) --

        The compute and memory capacity of the replication instance.

        Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

      • ReplicationInstanceStatus (string) --

        The status of the replication instance.

      • AllocatedStorage (integer) --

        The amount of storage (in gigabytes) that is allocated for the replication instance.

      • InstanceCreateTime (datetime) --

        The time the replication instance was created.

      • VpcSecurityGroups (list) --

        The VPC security group for the instance.

        • (dict) --
          • VpcSecurityGroupId (string) --

            The VPC security group Id.

          • Status (string) --

            The status of the VPC security group.

      • AvailabilityZone (string) --

        The Availability Zone for the instance.

      • ReplicationSubnetGroup (dict) --

        The subnet group for the replication instance.

        • ReplicationSubnetGroupIdentifier (string) --

          The identifier of the replication instance subnet group.

        • ReplicationSubnetGroupDescription (string) --

          The description of the replication subnet group.

        • VpcId (string) --

          The ID of the VPC.

        • SubnetGroupStatus (string) --

          The status of the subnet group.

        • Subnets (list) --

          The subnets that are in the subnet group.

          • (dict) --
            • SubnetIdentifier (string) --

              The subnet identifier.

            • SubnetAvailabilityZone (dict) --

              The Availability Zone of the subnet.

              • Name (string) --

                The name of the availability zone.

            • SubnetStatus (string) --

              The status of the subnet.

      • PreferredMaintenanceWindow (string) --

        The maintenance window times for the replication instance.

      • PendingModifiedValues (dict) --

        The pending modification values.

        • ReplicationInstanceClass (string) --

          The compute and memory capacity of the replication instance.

          Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

        • AllocatedStorage (integer) --

          The amount of storage (in gigabytes) that is allocated for the replication instance.

        • MultiAZ (boolean) --

          Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

        • EngineVersion (string) --

          The engine version number of the replication instance.

      • MultiAZ (boolean) --

        Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

      • EngineVersion (string) --

        The engine version number of the replication instance.

      • AutoMinorVersionUpgrade (boolean) --

        Boolean value indicating if minor version upgrades will be automatically applied to the instance.

      • KmsKeyId (string) --

        The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • ReplicationInstancePublicIpAddress (string) --

        The public IP address of the replication instance.

      • ReplicationInstancePrivateIpAddress (string) --

        The private IP address of the replication instance.

      • ReplicationInstancePublicIpAddresses (list) --

        The public IP address of the replication instance.

        • (string) --
      • ReplicationInstancePrivateIpAddresses (list) --

        The private IP address of the replication instance.

        • (string) --
      • PubliclyAccessible (boolean) --

        Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true .

      • SecondaryAvailabilityZone (string) --

        The availability zone of the standby replication instance in a Multi-AZ deployment.

      • FreeUntil (datetime) --

        The expiration date of the free replication instance that is part of the Free DMS program.

      • DnsNameServers (string) --

        The DNS name servers for the replication instance.

delete_replication_subnet_group(**kwargs)

Deletes a subnet group.

See also: AWS API Documentation

Request Syntax

response = client.delete_replication_subnet_group(
    ReplicationSubnetGroupIdentifier='string'
)
Parameters
ReplicationSubnetGroupIdentifier (string) --

[REQUIRED]

The subnet group name of the replication instance.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_replication_task(**kwargs)

Deletes the specified replication task.

See also: AWS API Documentation

Request Syntax

response = client.delete_replication_task(
    ReplicationTaskArn='string'
)
Parameters
ReplicationTaskArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the replication task to be deleted.

Return type
dict
Returns
Response Syntax
{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123
        }
    }
}

Response Structure

  • (dict) --
    • ReplicationTask (dict) --

      The deleted replication task.

      • ReplicationTaskIdentifier (string) --

        The user-assigned replication task identifier or name.

        Constraints:

        • Must contain from 1 to 255 alphanumeric characters or hyphens.
        • First character must be a letter.
        • Cannot end with a hyphen or contain two consecutive hyphens.
      • SourceEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • TargetEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • MigrationType (string) --

        The type of migration.

      • TableMappings (string) --

        Table mappings specified in the task.

      • ReplicationTaskSettings (string) --

        The settings for the replication task.

      • Status (string) --

        The status of the replication task.

      • LastFailureMessage (string) --

        The last error (failure) message generated for the replication instance.

      • StopReason (string) --

        The reason the replication task was stopped.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        The date the replication task is scheduled to start.

      • CdcStartPosition (string) --

        Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

        The value can be in date, checkpoint, or LSN/SCN format.

        Date Example: --cdc-start-position “2018-03-08T12:12:12”

        Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

        LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

      • CdcStopPosition (string) --

        Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

        Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

        Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

      • RecoveryCheckpoint (string) --

        Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        The statistics for the task, including elapsed time, tables loaded, and table errors.

        • FullLoadProgressPercent (integer) --

          The percent complete for the full load migration task.

        • ElapsedTimeMillis (integer) --

          The elapsed time of the task, in milliseconds.

        • TablesLoaded (integer) --

          The number of tables loaded for this task.

        • TablesLoading (integer) --

          The number of tables currently loading for this task.

        • TablesQueued (integer) --

          The number of tables queued for this task.

        • TablesErrored (integer) --

          The number of errors that have occurred during this task.

describe_account_attributes()

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

This command does not take any parameters.

See also: AWS API Documentation

Request Syntax

response = client.describe_account_attributes()
Return type
dict
Returns
Response Syntax
{
    'AccountQuotas': [
        {
            'AccountQuotaName': 'string',
            'Used': 123,
            'Max': 123
        },
    ]
}

Response Structure

  • (dict) --
    • AccountQuotas (list) --

      Account quota information.

      • (dict) --

        Describes a quota for an AWS account, for example, the number of replication instances allowed.

        • AccountQuotaName (string) --

          The name of the AWS DMS quota for this AWS account.

        • Used (integer) --

          The amount currently used toward the quota maximum.

        • Max (integer) --

          The maximum allowed value for the quota.

describe_certificates(**kwargs)

Provides a description of the certificate.

See also: AWS API Documentation

Request Syntax

response = client.describe_certificates(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters
  • Filters (list) --

    Filters applied to the certificate described in the form of key-value pairs.

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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: 10

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'Marker': 'string',
    'Certificates': [
        {
            'CertificateIdentifier': 'string',
            'CertificateCreationDate': datetime(2015, 1, 1),
            'CertificatePem': 'string',
            'CertificateWallet': b'bytes',
            'CertificateArn': 'string',
            'CertificateOwner': 'string',
            'ValidFromDate': datetime(2015, 1, 1),
            'ValidToDate': datetime(2015, 1, 1),
            'SigningAlgorithm': 'string',
            'KeyLength': 123
        },
    ]
}

Response Structure

  • (dict) --

    • Marker (string) --

      The pagination token.

    • Certificates (list) --

      The Secure Sockets Layer (SSL) certificates associated with the replication instance.

      • (dict) --

        The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.

        • CertificateIdentifier (string) --

          The customer-assigned name of the certificate. Valid characters are A-z and 0-9.

        • CertificateCreationDate (datetime) --

          The date that the certificate was created.

        • CertificatePem (string) --

          The contents of the .pem X.509 certificate file for the certificate.

        • CertificateWallet (bytes) --

          The location of the imported Oracle Wallet certificate for use with SSL.

        • CertificateArn (string) --

          The Amazon Resource Name (ARN) for the certificate.

        • CertificateOwner (string) --

          The owner of the certificate.

        • ValidFromDate (datetime) --

          The beginning date that the certificate is valid.

        • ValidToDate (datetime) --

          The final date that the certificate is valid.

        • SigningAlgorithm (string) --

          The signing algorithm for the certificate.

        • KeyLength (integer) --

          The key length of the cryptographic algorithm being used.

describe_connections(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_connections(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters
  • Filters (list) --

    The filters applied to the connection.

    Valid filter names: endpoint-arn | replication-instance-arn

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'Marker': 'string',
    'Connections': [
        {
            'ReplicationInstanceArn': 'string',
            'EndpointArn': 'string',
            'Status': 'string',
            'LastFailureMessage': 'string',
            'EndpointIdentifier': 'string',
            'ReplicationInstanceIdentifier': '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 .

    • Connections (list) --

      A description of the connections.

      • (dict) --

        • ReplicationInstanceArn (string) --

          The Amazon Resource Name (ARN) of the replication instance.

        • EndpointArn (string) --

          The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

        • Status (string) --

          The connection status.

        • LastFailureMessage (string) --

          The error message when the connection last failed.

        • EndpointIdentifier (string) --

          The identifier of the endpoint. 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.

        • ReplicationInstanceIdentifier (string) --

          The replication instance identifier. This parameter is stored as a lowercase string.

describe_endpoint_types(**kwargs)

Returns information about the type of endpoints available.

See also: AWS API Documentation

Request Syntax

response = client.describe_endpoint_types(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: engine-name | endpoint-type

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'Marker': 'string',
    'SupportedEndpointTypes': [
        {
            'EngineName': 'string',
            'SupportsCDC': True|False,
            'EndpointType': 'source'|'target',
            'EngineDisplayName': '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 .

    • SupportedEndpointTypes (list) --

      The type of endpoints that are supported.

      • (dict) --

        • 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.

        • SupportsCDC (boolean) --

          Indicates if Change Data Capture (CDC) is supported.

        • EndpointType (string) --

          The type of endpoint.

        • EngineDisplayName (string) --

          The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."

describe_endpoints(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_endpoints(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters
  • Filters (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) --
  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

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'
            },
            'KinesisSettings': {
                'StreamArn': 'string',
                'MessageFormat': 'json',
                'ServiceAccessRoleArn': 'string'
            },
            'ElasticsearchSettings': {
                'ServiceAccessRoleArn': 'string',
                'EndpointUri': 'string',
                'FullLoadErrorPercentage': 123,
                'ErrorRetryDuration': 123
            }
        },
    ]
}

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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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 of source endpoint.

          Possible attributes include the following:

          • 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. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

          Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

          JSON syntax for these attributes is as follows: { "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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

        • KinesisSettings (dict) --

          The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.

          • StreamArn (string) --

            The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

          • MessageFormat (string) --

            The output format for the records created on the endpoint. The message format is JSON .

          • ServiceAccessRoleArn (string) --

            The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

        • ElasticsearchSettings (dict) --

          The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

          • ServiceAccessRoleArn (string) --

            The Amazon Resource Name (ARN) used by service to access the IAM role.

          • EndpointUri (string) --

            The endpoint for the ElasticSearch cluster.

          • FullLoadErrorPercentage (integer) --

            The maximum percentage of records that can fail to be written before a full load operation stops.

          • ErrorRetryDuration (integer) --

            The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

describe_event_categories(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_event_categories(
    SourceType='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
Parameters
  • SourceType (string) --

    The type of AWS DMS resource that generates events.

    Valid values: replication-instance | migration-task

  • Filters (list) --

    Filters applied to the action.

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'EventCategoryGroupList': [
        {
            'SourceType': 'string',
            'EventCategories': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • EventCategoryGroupList (list) --

      A list of event categories.

      • (dict) --

        • SourceType (string) --

          The type of AWS DMS resource that generates events.

          Valid values: replication-instance | replication-server | security-group | migration-task

        • EventCategories (list) --

          A list of event categories for a SourceType that you want to subscribe to.

          • (string) --

describe_event_subscriptions(**kwargs)

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

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

See also: AWS API Documentation

Request Syntax

response = client.describe_event_subscriptions(
    SubscriptionName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters
  • SubscriptionName (string) -- The name of the AWS DMS event subscription to be described.
  • Filters (list) --

    Filters applied to the action.

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'Marker': 'string',
    'EventSubscriptionsList': [
        {
            'CustomerAwsId': 'string',
            'CustSubscriptionId': 'string',
            'SnsTopicArn': 'string',
            'Status': 'string',
            'SubscriptionCreationTime': 'string',
            'SourceType': 'string',
            'SourceIdsList': [
                'string',
            ],
            'EventCategoriesList': [
                'string',
            ],
            'Enabled': True|False
        },
    ]
}

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 .

    • EventSubscriptionsList (list) --

      A list of event subscriptions.

      • (dict) --

        • CustomerAwsId (string) --

          The AWS customer account associated with the AWS DMS event notification subscription.

        • CustSubscriptionId (string) --

          The AWS DMS event notification subscription Id.

        • SnsTopicArn (string) --

          The topic ARN of the AWS DMS event notification subscription.

        • Status (string) --

          The status of the AWS DMS event notification subscription.

          Constraints:

          Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

          The status "no-permission" indicates that AWS DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime (string) --

          The time the RDS event notification subscription was created.

        • SourceType (string) --

          The type of AWS DMS resource that generates events.

          Valid values: replication-instance | replication-server | security-group | migration-task

        • SourceIdsList (list) --

          A list of source Ids for the event subscription.

          • (string) --
        • EventCategoriesList (list) --

          A lists of event categories.

          • (string) --
        • Enabled (boolean) --

          Boolean value that indicates if the event subscription is enabled.

describe_events(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_events(
    SourceIdentifier='string',
    SourceType='replication-instance',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Duration=123,
    EventCategories=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters
  • SourceIdentifier (string) -- The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It cannot end with a hyphen or contain two consecutive hyphens.
  • SourceType (string) --

    The type of AWS DMS resource that generates events.

    Valid values: replication-instance | migration-task

  • StartTime (datetime) -- The start time for the events to be listed.
  • EndTime (datetime) -- The end time for the events to be listed.
  • Duration (integer) -- The duration of the events to be listed.
  • EventCategories (list) --

    A list of event categories for a source type that you want to subscribe to.

    • (string) --
  • Filters (list) --

    Filters applied to the action.

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'Marker': 'string',
    'Events': [
        {
            'SourceIdentifier': 'string',
            'SourceType': 'replication-instance',
            'Message': 'string',
            'EventCategories': [
                'string',
            ],
            'Date': datetime(2015, 1, 1)
        },
    ]
}

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 .

    • Events (list) --

      The events described.

      • (dict) --

        • SourceIdentifier (string) --

          The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

          Constraints:replication instance, endpoint, migration task

        • SourceType (string) --

          The type of AWS DMS resource that generates events.

          Valid values: replication-instance | endpoint | migration-task

        • Message (string) --

          The event message.

        • EventCategories (list) --

          The event categories available for the specified source type.

          • (string) --
        • Date (datetime) --

          The date of the event.

describe_orderable_replication_instances(**kwargs)

Returns information about the replication instance types that can be created in the specified region.

See also: AWS API Documentation

Request Syntax

response = client.describe_orderable_replication_instances(
    MaxRecords=123,
    Marker='string'
)
Parameters
  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'OrderableReplicationInstances': [
        {
            'EngineVersion': 'string',
            'ReplicationInstanceClass': 'string',
            'StorageType': 'string',
            'MinAllocatedStorage': 123,
            'MaxAllocatedStorage': 123,
            'DefaultAllocatedStorage': 123,
            'IncludedAllocatedStorage': 123
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    • OrderableReplicationInstances (list) --

      The order-able replication instances available.

      • (dict) --

        • EngineVersion (string) --

          The version of the replication engine.

        • ReplicationInstanceClass (string) --

          The compute and memory capacity of the replication instance.

          Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

        • StorageType (string) --

          The type of storage used by the replication instance.

        • MinAllocatedStorage (integer) --

          The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

        • MaxAllocatedStorage (integer) --

          The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

        • DefaultAllocatedStorage (integer) --

          The default amount of storage (in gigabytes) that is allocated for the replication instance.

        • IncludedAllocatedStorage (integer) --

          The amount of storage (in gigabytes) that is allocated for the replication instance.

    • 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 .

describe_refresh_schemas_status(**kwargs)

Returns the status of the RefreshSchemas operation.

See also: AWS API Documentation

Request Syntax

response = client.describe_refresh_schemas_status(
    EndpointArn='string'
)
Parameters
EndpointArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Return type
dict
Returns
Response Syntax
{
    'RefreshSchemasStatus': {
        'EndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'Status': 'successful'|'failed'|'refreshing',
        'LastRefreshDate': datetime(2015, 1, 1),
        'LastFailureMessage': 'string'
    }
}

Response Structure

  • (dict) --
    • RefreshSchemasStatus (dict) --

      The status of the schema.

      • EndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • Status (string) --

        The status of the schema.

      • LastRefreshDate (datetime) --

        The date the schema was last refreshed.

      • LastFailureMessage (string) --

        The last failure message for the schema.

describe_replication_instance_task_logs(**kwargs)

Returns information about the task logs for the specified task.

See also: AWS API Documentation

Request Syntax

response = client.describe_replication_instance_task_logs(
    ReplicationInstanceArn='string',
    MaxRecords=123,
    Marker='string'
)
Parameters
  • ReplicationInstanceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication instance.

  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'ReplicationInstanceArn': 'string',
    'ReplicationInstanceTaskLogs': [
        {
            'ReplicationTaskName': 'string',
            'ReplicationTaskArn': 'string',
            'ReplicationInstanceTaskLogSize': 123
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    • ReplicationInstanceArn (string) --

      The Amazon Resource Name (ARN) of the replication instance.

    • ReplicationInstanceTaskLogs (list) --

      An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).

      • (dict) --

        Contains metadata for a replication instance task log.

        • ReplicationTaskName (string) --

          The name of the replication task.

        • ReplicationTaskArn (string) --

          The Amazon Resource Name (ARN) of the replication task.

        • ReplicationInstanceTaskLogSize (integer) --

          The size, in bytes, of the replication task log.

    • 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 .

describe_replication_instances(**kwargs)

Returns information about replication instances for your account in the current region.

See also: AWS API Documentation

Request Syntax

response = client.describe_replication_instances(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'Marker': 'string',
    'ReplicationInstances': [
        {
            'ReplicationInstanceIdentifier': 'string',
            'ReplicationInstanceClass': 'string',
            'ReplicationInstanceStatus': 'string',
            'AllocatedStorage': 123,
            'InstanceCreateTime': datetime(2015, 1, 1),
            'VpcSecurityGroups': [
                {
                    'VpcSecurityGroupId': 'string',
                    'Status': 'string'
                },
            ],
            'AvailabilityZone': 'string',
            'ReplicationSubnetGroup': {
                'ReplicationSubnetGroupIdentifier': 'string',
                'ReplicationSubnetGroupDescription': 'string',
                'VpcId': 'string',
                'SubnetGroupStatus': 'string',
                'Subnets': [
                    {
                        'SubnetIdentifier': 'string',
                        'SubnetAvailabilityZone': {
                            'Name': 'string'
                        },
                        'SubnetStatus': 'string'
                    },
                ]
            },
            'PreferredMaintenanceWindow': 'string',
            'PendingModifiedValues': {
                'ReplicationInstanceClass': 'string',
                'AllocatedStorage': 123,
                'MultiAZ': True|False,
                'EngineVersion': 'string'
            },
            'MultiAZ': True|False,
            'EngineVersion': 'string',
            'AutoMinorVersionUpgrade': True|False,
            'KmsKeyId': 'string',
            'ReplicationInstanceArn': 'string',
            'ReplicationInstancePublicIpAddress': 'string',
            'ReplicationInstancePrivateIpAddress': 'string',
            'ReplicationInstancePublicIpAddresses': [
                'string',
            ],
            'ReplicationInstancePrivateIpAddresses': [
                'string',
            ],
            'PubliclyAccessible': True|False,
            'SecondaryAvailabilityZone': 'string',
            'FreeUntil': datetime(2015, 1, 1),
            'DnsNameServers': '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 .

    • ReplicationInstances (list) --

      The replication instances described.

      • (dict) --

        • ReplicationInstanceIdentifier (string) --

          The replication instance identifier. This parameter is stored as a lowercase string.

          Constraints:

          • Must contain from 1 to 63 alphanumeric characters or hyphens.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.

          Example: myrepinstance

        • ReplicationInstanceClass (string) --

          The compute and memory capacity of the replication instance.

          Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

        • ReplicationInstanceStatus (string) --

          The status of the replication instance.

        • AllocatedStorage (integer) --

          The amount of storage (in gigabytes) that is allocated for the replication instance.

        • InstanceCreateTime (datetime) --

          The time the replication instance was created.

        • VpcSecurityGroups (list) --

          The VPC security group for the instance.

          • (dict) --

            • VpcSecurityGroupId (string) --

              The VPC security group Id.

            • Status (string) --

              The status of the VPC security group.

        • AvailabilityZone (string) --

          The Availability Zone for the instance.

        • ReplicationSubnetGroup (dict) --

          The subnet group for the replication instance.

          • ReplicationSubnetGroupIdentifier (string) --

            The identifier of the replication instance subnet group.

          • ReplicationSubnetGroupDescription (string) --

            The description of the replication subnet group.

          • VpcId (string) --

            The ID of the VPC.

          • SubnetGroupStatus (string) --

            The status of the subnet group.

          • Subnets (list) --

            The subnets that are in the subnet group.

            • (dict) --

              • SubnetIdentifier (string) --

                The subnet identifier.

              • SubnetAvailabilityZone (dict) --

                The Availability Zone of the subnet.

                • Name (string) --

                  The name of the availability zone.

              • SubnetStatus (string) --

                The status of the subnet.

        • PreferredMaintenanceWindow (string) --

          The maintenance window times for the replication instance.

        • PendingModifiedValues (dict) --

          The pending modification values.

          • ReplicationInstanceClass (string) --

            The compute and memory capacity of the replication instance.

            Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

          • AllocatedStorage (integer) --

            The amount of storage (in gigabytes) that is allocated for the replication instance.

          • MultiAZ (boolean) --

            Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

          • EngineVersion (string) --

            The engine version number of the replication instance.

        • MultiAZ (boolean) --

          Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

        • EngineVersion (string) --

          The engine version number of the replication instance.

        • AutoMinorVersionUpgrade (boolean) --

          Boolean value indicating if minor version upgrades will be automatically applied to the instance.

        • KmsKeyId (string) --

          The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

        • ReplicationInstanceArn (string) --

          The Amazon Resource Name (ARN) of the replication instance.

        • ReplicationInstancePublicIpAddress (string) --

          The public IP address of the replication instance.

        • ReplicationInstancePrivateIpAddress (string) --

          The private IP address of the replication instance.

        • ReplicationInstancePublicIpAddresses (list) --

          The public IP address of the replication instance.

          • (string) --
        • ReplicationInstancePrivateIpAddresses (list) --

          The private IP address of the replication instance.

          • (string) --
        • PubliclyAccessible (boolean) --

          Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true .

        • SecondaryAvailabilityZone (string) --

          The availability zone of the standby replication instance in a Multi-AZ deployment.

        • FreeUntil (datetime) --

          The expiration date of the free replication instance that is part of the Free DMS program.

        • DnsNameServers (string) --

          The DNS name servers for the replication instance.

describe_replication_subnet_groups(**kwargs)

Returns information about the replication subnet groups.

See also: AWS API Documentation

Request Syntax

response = client.describe_replication_subnet_groups(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'Marker': 'string',
    'ReplicationSubnetGroups': [
        {
            'ReplicationSubnetGroupIdentifier': 'string',
            'ReplicationSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': '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 .

    • ReplicationSubnetGroups (list) --

      A description of the replication subnet groups.

      • (dict) --

        • ReplicationSubnetGroupIdentifier (string) --

          The identifier of the replication instance subnet group.

        • ReplicationSubnetGroupDescription (string) --

          The description of the replication subnet group.

        • VpcId (string) --

          The ID of the VPC.

        • SubnetGroupStatus (string) --

          The status of the subnet group.

        • Subnets (list) --

          The subnets that are in the subnet group.

          • (dict) --

            • SubnetIdentifier (string) --

              The subnet identifier.

            • SubnetAvailabilityZone (dict) --

              The Availability Zone of the subnet.

              • Name (string) --

                The name of the availability zone.

            • SubnetStatus (string) --

              The status of the subnet.

describe_replication_task_assessment_results(**kwargs)

Returns the task assessment results from Amazon S3. This action always returns the latest results.

See also: AWS API Documentation

Request Syntax

response = client.describe_replication_task_assessment_results(
    ReplicationTaskArn='string',
    MaxRecords=123,
    Marker='string'
)
Parameters
  • ReplicationTaskArn (string) --
    • The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified the API will return only one result and ignore the values of the max-records and marker parameters.
  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'Marker': 'string',
    'BucketName': 'string',
    'ReplicationTaskAssessmentResults': [
        {
            'ReplicationTaskIdentifier': 'string',
            'ReplicationTaskArn': 'string',
            'ReplicationTaskLastAssessmentDate': datetime(2015, 1, 1),
            'AssessmentStatus': 'string',
            'AssessmentResultsFile': 'string',
            'AssessmentResults': 'string',
            'S3ObjectUrl': '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 .

    • BucketName (string) --

      • The Amazon S3 bucket where the task assessment report is located.
    • ReplicationTaskAssessmentResults (list) --

      The task assessment report.

      • (dict) --

        The task assessment report in JSON format.

        • ReplicationTaskIdentifier (string) --

          The replication task identifier of the task on which the task assessment was run.

        • ReplicationTaskArn (string) --

          The Amazon Resource Name (ARN) of the replication task.

        • ReplicationTaskLastAssessmentDate (datetime) --

          The date the task assessment was completed.

        • AssessmentStatus (string) --

          The status of the task assessment.

        • AssessmentResultsFile (string) --

          The file containing the results of the task assessment.

        • AssessmentResults (string) --

          The task assessment results in JSON format.

        • S3ObjectUrl (string) --

          The URL of the S3 object containing the task assessment results.

describe_replication_tasks(**kwargs)

Returns information about replication tasks for your account in the current region.

See also: AWS API Documentation

Request Syntax

response = client.describe_replication_tasks(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'Marker': 'string',
    'ReplicationTasks': [
        {
            'ReplicationTaskIdentifier': 'string',
            'SourceEndpointArn': 'string',
            'TargetEndpointArn': 'string',
            'ReplicationInstanceArn': 'string',
            'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
            'TableMappings': 'string',
            'ReplicationTaskSettings': 'string',
            'Status': 'string',
            'LastFailureMessage': 'string',
            'StopReason': 'string',
            'ReplicationTaskCreationDate': datetime(2015, 1, 1),
            'ReplicationTaskStartDate': datetime(2015, 1, 1),
            'CdcStartPosition': 'string',
            'CdcStopPosition': 'string',
            'RecoveryCheckpoint': 'string',
            'ReplicationTaskArn': 'string',
            'ReplicationTaskStats': {
                'FullLoadProgressPercent': 123,
                'ElapsedTimeMillis': 123,
                'TablesLoaded': 123,
                'TablesLoading': 123,
                'TablesQueued': 123,
                'TablesErrored': 123
            }
        },
    ]
}

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 .

    • ReplicationTasks (list) --

      A description of the replication tasks.

      • (dict) --

        • ReplicationTaskIdentifier (string) --

          The user-assigned replication task identifier or name.

          Constraints:

          • Must contain from 1 to 255 alphanumeric characters or hyphens.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
        • SourceEndpointArn (string) --

          The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

        • TargetEndpointArn (string) --

          The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

        • ReplicationInstanceArn (string) --

          The Amazon Resource Name (ARN) of the replication instance.

        • MigrationType (string) --

          The type of migration.

        • TableMappings (string) --

          Table mappings specified in the task.

        • ReplicationTaskSettings (string) --

          The settings for the replication task.

        • Status (string) --

          The status of the replication task.

        • LastFailureMessage (string) --

          The last error (failure) message generated for the replication instance.

        • StopReason (string) --

          The reason the replication task was stopped.

        • ReplicationTaskCreationDate (datetime) --

          The date the replication task was created.

        • ReplicationTaskStartDate (datetime) --

          The date the replication task is scheduled to start.

        • CdcStartPosition (string) --

          Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

          The value can be in date, checkpoint, or LSN/SCN format.

          Date Example: --cdc-start-position “2018-03-08T12:12:12”

          Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

          LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

        • CdcStopPosition (string) --

          Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

          Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

          Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

        • RecoveryCheckpoint (string) --

          Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

        • ReplicationTaskArn (string) --

          The Amazon Resource Name (ARN) of the replication task.

        • ReplicationTaskStats (dict) --

          The statistics for the task, including elapsed time, tables loaded, and table errors.

          • FullLoadProgressPercent (integer) --

            The percent complete for the full load migration task.

          • ElapsedTimeMillis (integer) --

            The elapsed time of the task, in milliseconds.

          • TablesLoaded (integer) --

            The number of tables loaded for this task.

          • TablesLoading (integer) --

            The number of tables currently loading for this task.

          • TablesQueued (integer) --

            The number of tables queued for this task.

          • TablesErrored (integer) --

            The number of errors that have occurred during this task.

describe_schemas(**kwargs)

Returns information about the schema for the specified endpoint.

See also: AWS API Documentation

Request Syntax

response = client.describe_schemas(
    EndpointArn='string',
    MaxRecords=123,
    Marker='string'
)
Parameters
  • EndpointArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

  • MaxRecords (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.

  • 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 .
Return type

dict

Returns

Response Syntax

{
    'Marker': 'string',
    'Schemas': [
        '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 .

    • Schemas (list) --

      The described schema.

      • (string) --

describe_table_statistics(**kwargs)

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

response = client.describe_table_statistics(
    ReplicationTaskArn='string',
    MaxRecords=123,
    Marker='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
Parameters
  • ReplicationTaskArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication task.

  • MaxRecords (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.

  • 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 .
  • Filters (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) --
Return type

dict

Returns

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 .

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
import_certificate(**kwargs)

Uploads the specified certificate.

See also: AWS API Documentation

Request Syntax

response = client.import_certificate(
    CertificateIdentifier='string',
    CertificatePem='string',
    CertificateWallet=b'bytes',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • CertificateIdentifier (string) --

    [REQUIRED]

    The customer-assigned name of the certificate. Valid characters are A-z and 0-9.

  • CertificatePem (string) -- The contents of the .pem X.509 certificate file for the certificate.
  • CertificateWallet (bytes) -- The location of the imported Oracle Wallet certificate for use with SSL.
  • Tags (list) --

    The tags associated with the certificate.

    • (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}_.:/=+\-]*)$").

Return type

dict

Returns

Response Syntax

{
    'Certificate': {
        'CertificateIdentifier': 'string',
        'CertificateCreationDate': datetime(2015, 1, 1),
        'CertificatePem': 'string',
        'CertificateWallet': b'bytes',
        'CertificateArn': 'string',
        'CertificateOwner': 'string',
        'ValidFromDate': datetime(2015, 1, 1),
        'ValidToDate': datetime(2015, 1, 1),
        'SigningAlgorithm': 'string',
        'KeyLength': 123
    }
}

Response Structure

  • (dict) --

    • Certificate (dict) --

      The certificate to be uploaded.

      • CertificateIdentifier (string) --

        The customer-assigned name of the certificate. Valid characters are A-z and 0-9.

      • CertificateCreationDate (datetime) --

        The date that the certificate was created.

      • CertificatePem (string) --

        The contents of the .pem X.509 certificate file for the certificate.

      • CertificateWallet (bytes) --

        The location of the imported Oracle Wallet certificate for use with SSL.

      • CertificateArn (string) --

        The Amazon Resource Name (ARN) for the certificate.

      • CertificateOwner (string) --

        The owner of the certificate.

      • ValidFromDate (datetime) --

        The beginning date that the certificate is valid.

      • ValidToDate (datetime) --

        The final date that the certificate is valid.

      • SigningAlgorithm (string) --

        The signing algorithm for the certificate.

      • KeyLength (integer) --

        The key length of the cryptographic algorithm being used.

list_tags_for_resource(**kwargs)

Lists all tags for an AWS DMS resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.

Return type
dict
Returns
Response Syntax
{
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • TagList (list) --

      A list of tags for the resource.

      • (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}_.:/=+\-]*)$").

modify_endpoint(**kwargs)

Modifies the specified endpoint.

See also: AWS API Documentation

Request Syntax

response = 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'
    },
    KinesisSettings={
        'StreamArn': 'string',
        'MessageFormat': 'json',
        'ServiceAccessRoleArn': 'string'
    },
    ElasticsearchSettings={
        'ServiceAccessRoleArn': 'string',
        'EndpointUri': 'string',
        'FullLoadErrorPercentage': 123,
        'ErrorRetryDuration': 123
    }
)
Parameters
  • EndpointArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) string that uniquely identifies the 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 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.
  • Username (string) -- The user name to be used to login to the endpoint database.
  • Password (string) -- The password to be used to login to the endpoint database.
  • ServerName (string) -- The name of the server where the endpoint database resides.
  • Port (integer) -- The port used by the endpoint database.
  • DatabaseName (string) -- The name of the endpoint database.
  • ExtraConnectionAttributes (string) -- Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
  • CertificateArn (string) -- The Amazon Resource Name (ARN) of the certificate used for SSL connection.
  • SslMode (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.

  • ServiceAccessRoleArn (string) -- The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.
  • ExternalTableDefinition (string) -- The external table definition.
  • DynamoDbSettings (dict) --

    Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.

    • ServiceAccessRoleArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) used by the service access IAM role.

  • S3Settings (dict) --

    Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

    • 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 of source endpoint.

    Attributes include the following:

    • 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) --

    Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

    • 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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

  • KinesisSettings (dict) --

    Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see `Using Object Mapping to Migrate Data to a Kinesis Data Stream <http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping >`__ in the AWS Database Migration User Guide.

    • StreamArn (string) --

      The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

    • MessageFormat (string) --

      The output format for the records created on the endpoint. The message format is JSON .

    • ServiceAccessRoleArn (string) --

      The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

  • ElasticsearchSettings (dict) --

    Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.

    • ServiceAccessRoleArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) used by service to access the IAM role.

    • EndpointUri (string) -- [REQUIRED]

      The endpoint for the ElasticSearch cluster.

    • FullLoadErrorPercentage (integer) --

      The maximum percentage of records that can fail to be written before a full load operation stops.

    • ErrorRetryDuration (integer) --

      The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

Return type

dict

Returns

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'
        },
        'KinesisSettings': {
            'StreamArn': 'string',
            'MessageFormat': 'json',
            'ServiceAccessRoleArn': 'string'
        },
        'ElasticsearchSettings': {
            'ServiceAccessRoleArn': 'string',
            'EndpointUri': 'string',
            'FullLoadErrorPercentage': 123,
            'ErrorRetryDuration': 123
        }
    }
}

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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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 of source endpoint.

        Possible attributes include the following:

        • 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. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

        Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

        JSON syntax for these attributes is as follows: { "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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

      • KinesisSettings (dict) --

        The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.

        • StreamArn (string) --

          The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

        • MessageFormat (string) --

          The output format for the records created on the endpoint. The message format is JSON .

        • ServiceAccessRoleArn (string) --

          The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

      • ElasticsearchSettings (dict) --

        The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

        • ServiceAccessRoleArn (string) --

          The Amazon Resource Name (ARN) used by service to access the IAM role.

        • EndpointUri (string) --

          The endpoint for the ElasticSearch cluster.

        • FullLoadErrorPercentage (integer) --

          The maximum percentage of records that can fail to be written before a full load operation stops.

        • ErrorRetryDuration (integer) --

          The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

modify_event_subscription(**kwargs)

Modifies an existing AWS DMS event notification subscription.

See also: AWS API Documentation

Request Syntax

response = client.modify_event_subscription(
    SubscriptionName='string',
    SnsTopicArn='string',
    SourceType='string',
    EventCategories=[
        'string',
    ],
    Enabled=True|False
)
Parameters
  • SubscriptionName (string) --

    [REQUIRED]

    The name of the AWS DMS event notification subscription to be modified.

  • SnsTopicArn (string) -- The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
  • SourceType (string) --

    The type of AWS DMS resource that generates the events you want to subscribe to.

    Valid values: replication-instance | migration-task

  • EventCategories (list) --

    A list of event categories for a source type that you want to subscribe to. Use the DescribeEventCategories action to see a list of event categories.

    • (string) --
  • Enabled (boolean) -- A Boolean value; set to true to activate the subscription.
Return type

dict

Returns

Response Syntax

{
    'EventSubscription': {
        'CustomerAwsId': 'string',
        'CustSubscriptionId': 'string',
        'SnsTopicArn': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string',
        'SourceType': 'string',
        'SourceIdsList': [
            'string',
        ],
        'EventCategoriesList': [
            'string',
        ],
        'Enabled': True|False
    }
}

Response Structure

  • (dict) --

    • EventSubscription (dict) --

      The modified event subscription.

      • CustomerAwsId (string) --

        The AWS customer account associated with the AWS DMS event notification subscription.

      • CustSubscriptionId (string) --

        The AWS DMS event notification subscription Id.

      • SnsTopicArn (string) --

        The topic ARN of the AWS DMS event notification subscription.

      • Status (string) --

        The status of the AWS DMS event notification subscription.

        Constraints:

        Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

        The status "no-permission" indicates that AWS DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

      • SubscriptionCreationTime (string) --

        The time the RDS event notification subscription was created.

      • SourceType (string) --

        The type of AWS DMS resource that generates events.

        Valid values: replication-instance | replication-server | security-group | migration-task

      • SourceIdsList (list) --

        A list of source Ids for the event subscription.

        • (string) --
      • EventCategoriesList (list) --

        A lists of event categories.

        • (string) --
      • Enabled (boolean) --

        Boolean value that indicates if the event subscription is enabled.

modify_replication_instance(**kwargs)

Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.

Some settings are applied during the maintenance window.

See also: AWS API Documentation

Request Syntax

response = client.modify_replication_instance(
    ReplicationInstanceArn='string',
    AllocatedStorage=123,
    ApplyImmediately=True|False,
    ReplicationInstanceClass='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    PreferredMaintenanceWindow='string',
    MultiAZ=True|False,
    EngineVersion='string',
    AllowMajorVersionUpgrade=True|False,
    AutoMinorVersionUpgrade=True|False,
    ReplicationInstanceIdentifier='string'
)
Parameters
  • ReplicationInstanceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication instance.

  • AllocatedStorage (integer) -- The amount of storage (in gigabytes) to be allocated for the replication instance.
  • ApplyImmediately (boolean) -- Indicates whether the changes should be applied immediately or during the next maintenance window.
  • ReplicationInstanceClass (string) --

    The compute and memory capacity of the replication instance.

    Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

  • VpcSecurityGroupIds (list) --

    Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.

    • (string) --
  • PreferredMaintenanceWindow (string) --

    The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

    Default: Uses existing setting

    Format: ddd:hh24:mi-ddd:hh24:mi

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Must be at least 30 minutes

  • MultiAZ (boolean) -- Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .
  • EngineVersion (string) -- The engine version number of the replication instance.
  • AllowMajorVersionUpgrade (boolean) --

    Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

    Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.

  • AutoMinorVersionUpgrade (boolean) -- Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version.
  • ReplicationInstanceIdentifier (string) -- The replication instance identifier. This parameter is stored as a lowercase string.
Return type

dict

Returns

Response Syntax

{
    'ReplicationInstance': {
        'ReplicationInstanceIdentifier': 'string',
        'ReplicationInstanceClass': 'string',
        'ReplicationInstanceStatus': 'string',
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'ReplicationSubnetGroup': {
            'ReplicationSubnetGroupIdentifier': 'string',
            'ReplicationSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': 'string'
                },
            ]
        },
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'ReplicationInstanceClass': 'string',
            'AllocatedStorage': 123,
            'MultiAZ': True|False,
            'EngineVersion': 'string'
        },
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'KmsKeyId': 'string',
        'ReplicationInstanceArn': 'string',
        'ReplicationInstancePublicIpAddress': 'string',
        'ReplicationInstancePrivateIpAddress': 'string',
        'ReplicationInstancePublicIpAddresses': [
            'string',
        ],
        'ReplicationInstancePrivateIpAddresses': [
            'string',
        ],
        'PubliclyAccessible': True|False,
        'SecondaryAvailabilityZone': 'string',
        'FreeUntil': datetime(2015, 1, 1),
        'DnsNameServers': 'string'
    }
}

Response Structure

  • (dict) --

    • ReplicationInstance (dict) --

      The modified replication instance.

      • ReplicationInstanceIdentifier (string) --

        The replication instance identifier. This parameter is stored as a lowercase string.

        Constraints:

        • Must contain from 1 to 63 alphanumeric characters or hyphens.
        • First character must be a letter.
        • Cannot end with a hyphen or contain two consecutive hyphens.

        Example: myrepinstance

      • ReplicationInstanceClass (string) --

        The compute and memory capacity of the replication instance.

        Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

      • ReplicationInstanceStatus (string) --

        The status of the replication instance.

      • AllocatedStorage (integer) --

        The amount of storage (in gigabytes) that is allocated for the replication instance.

      • InstanceCreateTime (datetime) --

        The time the replication instance was created.

      • VpcSecurityGroups (list) --

        The VPC security group for the instance.

        • (dict) --

          • VpcSecurityGroupId (string) --

            The VPC security group Id.

          • Status (string) --

            The status of the VPC security group.

      • AvailabilityZone (string) --

        The Availability Zone for the instance.

      • ReplicationSubnetGroup (dict) --

        The subnet group for the replication instance.

        • ReplicationSubnetGroupIdentifier (string) --

          The identifier of the replication instance subnet group.

        • ReplicationSubnetGroupDescription (string) --

          The description of the replication subnet group.

        • VpcId (string) --

          The ID of the VPC.

        • SubnetGroupStatus (string) --

          The status of the subnet group.

        • Subnets (list) --

          The subnets that are in the subnet group.

          • (dict) --

            • SubnetIdentifier (string) --

              The subnet identifier.

            • SubnetAvailabilityZone (dict) --

              The Availability Zone of the subnet.

              • Name (string) --

                The name of the availability zone.

            • SubnetStatus (string) --

              The status of the subnet.

      • PreferredMaintenanceWindow (string) --

        The maintenance window times for the replication instance.

      • PendingModifiedValues (dict) --

        The pending modification values.

        • ReplicationInstanceClass (string) --

          The compute and memory capacity of the replication instance.

          Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

        • AllocatedStorage (integer) --

          The amount of storage (in gigabytes) that is allocated for the replication instance.

        • MultiAZ (boolean) --

          Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

        • EngineVersion (string) --

          The engine version number of the replication instance.

      • MultiAZ (boolean) --

        Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

      • EngineVersion (string) --

        The engine version number of the replication instance.

      • AutoMinorVersionUpgrade (boolean) --

        Boolean value indicating if minor version upgrades will be automatically applied to the instance.

      • KmsKeyId (string) --

        The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • ReplicationInstancePublicIpAddress (string) --

        The public IP address of the replication instance.

      • ReplicationInstancePrivateIpAddress (string) --

        The private IP address of the replication instance.

      • ReplicationInstancePublicIpAddresses (list) --

        The public IP address of the replication instance.

        • (string) --
      • ReplicationInstancePrivateIpAddresses (list) --

        The private IP address of the replication instance.

        • (string) --
      • PubliclyAccessible (boolean) --

        Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true .

      • SecondaryAvailabilityZone (string) --

        The availability zone of the standby replication instance in a Multi-AZ deployment.

      • FreeUntil (datetime) --

        The expiration date of the free replication instance that is part of the Free DMS program.

      • DnsNameServers (string) --

        The DNS name servers for the replication instance.

modify_replication_subnet_group(**kwargs)

Modifies the settings for the specified replication subnet group.

See also: AWS API Documentation

Request Syntax

response = client.modify_replication_subnet_group(
    ReplicationSubnetGroupIdentifier='string',
    ReplicationSubnetGroupDescription='string',
    SubnetIds=[
        'string',
    ]
)
Parameters
  • ReplicationSubnetGroupIdentifier (string) --

    [REQUIRED]

    The name of the replication instance subnet group.

  • ReplicationSubnetGroupDescription (string) -- The description of the replication instance subnet group.
  • SubnetIds (list) --

    [REQUIRED]

    A list of subnet IDs.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'ReplicationSubnetGroup': {
        'ReplicationSubnetGroupIdentifier': 'string',
        'ReplicationSubnetGroupDescription': 'string',
        'VpcId': 'string',
        'SubnetGroupStatus': 'string',
        'Subnets': [
            {
                'SubnetIdentifier': 'string',
                'SubnetAvailabilityZone': {
                    'Name': 'string'
                },
                'SubnetStatus': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ReplicationSubnetGroup (dict) --

      The modified replication subnet group.

      • ReplicationSubnetGroupIdentifier (string) --

        The identifier of the replication instance subnet group.

      • ReplicationSubnetGroupDescription (string) --

        The description of the replication subnet group.

      • VpcId (string) --

        The ID of the VPC.

      • SubnetGroupStatus (string) --

        The status of the subnet group.

      • Subnets (list) --

        The subnets that are in the subnet group.

        • (dict) --

          • SubnetIdentifier (string) --

            The subnet identifier.

          • SubnetAvailabilityZone (dict) --

            The Availability Zone of the subnet.

            • Name (string) --

              The name of the availability zone.

          • SubnetStatus (string) --

            The status of the subnet.

modify_replication_task(**kwargs)

Modifies the specified replication task.

You can't modify the task endpoints. The task must be stopped before you can modify it.

For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide .

See also: AWS API Documentation

Request Syntax

response = client.modify_replication_task(
    ReplicationTaskArn='string',
    ReplicationTaskIdentifier='string',
    MigrationType='full-load'|'cdc'|'full-load-and-cdc',
    TableMappings='string',
    ReplicationTaskSettings='string',
    CdcStartTime=datetime(2015, 1, 1),
    CdcStartPosition='string',
    CdcStopPosition='string'
)
Parameters
  • ReplicationTaskArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication task.

  • ReplicationTaskIdentifier (string) --

    The replication task identifier.

    Constraints:

    • Must contain from 1 to 255 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.
  • MigrationType (string) --

    The migration type.

    Valid values: full-load | cdc | full-load-and-cdc

  • TableMappings (string) --

    When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with "file://". When working with the DMS API, provide the JSON as the parameter value.

    For example, --table-mappings file://mappingfile.json

  • ReplicationTaskSettings (string) -- JSON file that contains settings for the task, such as target metadata settings.
  • CdcStartTime (datetime) --

    Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

    Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

  • CdcStartPosition (string) --

    Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

    The value can be in date, checkpoint, or LSN/SCN format.

    Date Example: --cdc-start-position “2018-03-08T12:12:12”

    Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

    LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

  • CdcStopPosition (string) --

    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

    Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

    Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

Return type

dict

Returns

Response Syntax

{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123
        }
    }
}

Response Structure

  • (dict) --

    • ReplicationTask (dict) --

      The replication task that was modified.

      • ReplicationTaskIdentifier (string) --

        The user-assigned replication task identifier or name.

        Constraints:

        • Must contain from 1 to 255 alphanumeric characters or hyphens.
        • First character must be a letter.
        • Cannot end with a hyphen or contain two consecutive hyphens.
      • SourceEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • TargetEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • MigrationType (string) --

        The type of migration.

      • TableMappings (string) --

        Table mappings specified in the task.

      • ReplicationTaskSettings (string) --

        The settings for the replication task.

      • Status (string) --

        The status of the replication task.

      • LastFailureMessage (string) --

        The last error (failure) message generated for the replication instance.

      • StopReason (string) --

        The reason the replication task was stopped.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        The date the replication task is scheduled to start.

      • CdcStartPosition (string) --

        Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

        The value can be in date, checkpoint, or LSN/SCN format.

        Date Example: --cdc-start-position “2018-03-08T12:12:12”

        Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

        LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

      • CdcStopPosition (string) --

        Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

        Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

        Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

      • RecoveryCheckpoint (string) --

        Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        The statistics for the task, including elapsed time, tables loaded, and table errors.

        • FullLoadProgressPercent (integer) --

          The percent complete for the full load migration task.

        • ElapsedTimeMillis (integer) --

          The elapsed time of the task, in milliseconds.

        • TablesLoaded (integer) --

          The number of tables loaded for this task.

        • TablesLoading (integer) --

          The number of tables currently loading for this task.

        • TablesQueued (integer) --

          The number of tables queued for this task.

        • TablesErrored (integer) --

          The number of errors that have occurred during this task.

reboot_replication_instance(**kwargs)

Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.

See also: AWS API Documentation

Request Syntax

response = client.reboot_replication_instance(
    ReplicationInstanceArn='string',
    ForceFailover=True|False
)
Parameters
  • ReplicationInstanceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication instance.

  • ForceFailover (boolean) -- If this parameter is true , the reboot is conducted through a Multi-AZ failover. (If the instance isn't configured for Multi-AZ, then you can't specify true .)
Return type

dict

Returns

Response Syntax

{
    'ReplicationInstance': {
        'ReplicationInstanceIdentifier': 'string',
        'ReplicationInstanceClass': 'string',
        'ReplicationInstanceStatus': 'string',
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'ReplicationSubnetGroup': {
            'ReplicationSubnetGroupIdentifier': 'string',
            'ReplicationSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': 'string'
                },
            ]
        },
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'ReplicationInstanceClass': 'string',
            'AllocatedStorage': 123,
            'MultiAZ': True|False,
            'EngineVersion': 'string'
        },
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'KmsKeyId': 'string',
        'ReplicationInstanceArn': 'string',
        'ReplicationInstancePublicIpAddress': 'string',
        'ReplicationInstancePrivateIpAddress': 'string',
        'ReplicationInstancePublicIpAddresses': [
            'string',
        ],
        'ReplicationInstancePrivateIpAddresses': [
            'string',
        ],
        'PubliclyAccessible': True|False,
        'SecondaryAvailabilityZone': 'string',
        'FreeUntil': datetime(2015, 1, 1),
        'DnsNameServers': 'string'
    }
}

Response Structure

  • (dict) --

    • ReplicationInstance (dict) --

      The replication instance that is being rebooted.

      • ReplicationInstanceIdentifier (string) --

        The replication instance identifier. This parameter is stored as a lowercase string.

        Constraints:

        • Must contain from 1 to 63 alphanumeric characters or hyphens.
        • First character must be a letter.
        • Cannot end with a hyphen or contain two consecutive hyphens.

        Example: myrepinstance

      • ReplicationInstanceClass (string) --

        The compute and memory capacity of the replication instance.

        Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

      • ReplicationInstanceStatus (string) --

        The status of the replication instance.

      • AllocatedStorage (integer) --

        The amount of storage (in gigabytes) that is allocated for the replication instance.

      • InstanceCreateTime (datetime) --

        The time the replication instance was created.

      • VpcSecurityGroups (list) --

        The VPC security group for the instance.

        • (dict) --

          • VpcSecurityGroupId (string) --

            The VPC security group Id.

          • Status (string) --

            The status of the VPC security group.

      • AvailabilityZone (string) --

        The Availability Zone for the instance.

      • ReplicationSubnetGroup (dict) --

        The subnet group for the replication instance.

        • ReplicationSubnetGroupIdentifier (string) --

          The identifier of the replication instance subnet group.

        • ReplicationSubnetGroupDescription (string) --

          The description of the replication subnet group.

        • VpcId (string) --

          The ID of the VPC.

        • SubnetGroupStatus (string) --

          The status of the subnet group.

        • Subnets (list) --

          The subnets that are in the subnet group.

          • (dict) --

            • SubnetIdentifier (string) --

              The subnet identifier.

            • SubnetAvailabilityZone (dict) --

              The Availability Zone of the subnet.

              • Name (string) --

                The name of the availability zone.

            • SubnetStatus (string) --

              The status of the subnet.

      • PreferredMaintenanceWindow (string) --

        The maintenance window times for the replication instance.

      • PendingModifiedValues (dict) --

        The pending modification values.

        • ReplicationInstanceClass (string) --

          The compute and memory capacity of the replication instance.

          Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

        • AllocatedStorage (integer) --

          The amount of storage (in gigabytes) that is allocated for the replication instance.

        • MultiAZ (boolean) --

          Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

        • EngineVersion (string) --

          The engine version number of the replication instance.

      • MultiAZ (boolean) --

        Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

      • EngineVersion (string) --

        The engine version number of the replication instance.

      • AutoMinorVersionUpgrade (boolean) --

        Boolean value indicating if minor version upgrades will be automatically applied to the instance.

      • KmsKeyId (string) --

        The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • ReplicationInstancePublicIpAddress (string) --

        The public IP address of the replication instance.

      • ReplicationInstancePrivateIpAddress (string) --

        The private IP address of the replication instance.

      • ReplicationInstancePublicIpAddresses (list) --

        The public IP address of the replication instance.

        • (string) --
      • ReplicationInstancePrivateIpAddresses (list) --

        The private IP address of the replication instance.

        • (string) --
      • PubliclyAccessible (boolean) --

        Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true .

      • SecondaryAvailabilityZone (string) --

        The availability zone of the standby replication instance in a Multi-AZ deployment.

      • FreeUntil (datetime) --

        The expiration date of the free replication instance that is part of the Free DMS program.

      • DnsNameServers (string) --

        The DNS name servers for the replication instance.

refresh_schemas(**kwargs)

Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.

See also: AWS API Documentation

Request Syntax

response = client.refresh_schemas(
    EndpointArn='string',
    ReplicationInstanceArn='string'
)
Parameters
  • EndpointArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

  • ReplicationInstanceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication instance.

Return type

dict

Returns

Response Syntax

{
    'RefreshSchemasStatus': {
        'EndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'Status': 'successful'|'failed'|'refreshing',
        'LastRefreshDate': datetime(2015, 1, 1),
        'LastFailureMessage': 'string'
    }
}

Response Structure

  • (dict) --

    • RefreshSchemasStatus (dict) --

      The status of the refreshed schema.

      • EndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • Status (string) --

        The status of the schema.

      • LastRefreshDate (datetime) --

        The date the schema was last refreshed.

      • LastFailureMessage (string) --

        The last failure message for the schema.

reload_tables(**kwargs)

Reloads the target database table with the source data.

See also: AWS API Documentation

Request Syntax

response = client.reload_tables(
    ReplicationTaskArn='string',
    TablesToReload=[
        {
            'SchemaName': 'string',
            'TableName': 'string'
        },
    ],
    ReloadOption='data-reload'|'validate-only'
)
Parameters
  • ReplicationTaskArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication task.

  • TablesToReload (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.

  • ReloadOption (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.

Return type

dict

Returns

Response Syntax

{
    'ReplicationTaskArn': 'string'
}

Response Structure

  • (dict) --

    • ReplicationTaskArn (string) --

      The Amazon Resource Name (ARN) of the replication task.

remove_tags_from_resource(**kwargs)

Removes metadata tags from a DMS resource.

See also: AWS API Documentation

Request Syntax

response = client.remove_tags_from_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    >The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be removed from.

  • TagKeys (list) --

    [REQUIRED]

    The tag key (name) of the tag to be removed.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

start_replication_task(**kwargs)

Starts the replication task.

For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.

See also: AWS API Documentation

Request Syntax

response = client.start_replication_task(
    ReplicationTaskArn='string',
    StartReplicationTaskType='start-replication'|'resume-processing'|'reload-target',
    CdcStartTime=datetime(2015, 1, 1),
    CdcStartPosition='string',
    CdcStopPosition='string'
)
Parameters
  • ReplicationTaskArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication task to be started.

  • StartReplicationTaskType (string) --

    [REQUIRED]

    The type of replication task.

  • CdcStartTime (datetime) --

    Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

    Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

  • CdcStartPosition (string) --

    Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

    The value can be in date, checkpoint, or LSN/SCN format.

    Date Example: --cdc-start-position “2018-03-08T12:12:12”

    Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

    LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

  • CdcStopPosition (string) --

    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

    Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

    Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

Return type

dict

Returns

Response Syntax

{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123
        }
    }
}

Response Structure

  • (dict) --

    • ReplicationTask (dict) --

      The replication task started.

      • ReplicationTaskIdentifier (string) --

        The user-assigned replication task identifier or name.

        Constraints:

        • Must contain from 1 to 255 alphanumeric characters or hyphens.
        • First character must be a letter.
        • Cannot end with a hyphen or contain two consecutive hyphens.
      • SourceEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • TargetEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • MigrationType (string) --

        The type of migration.

      • TableMappings (string) --

        Table mappings specified in the task.

      • ReplicationTaskSettings (string) --

        The settings for the replication task.

      • Status (string) --

        The status of the replication task.

      • LastFailureMessage (string) --

        The last error (failure) message generated for the replication instance.

      • StopReason (string) --

        The reason the replication task was stopped.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        The date the replication task is scheduled to start.

      • CdcStartPosition (string) --

        Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

        The value can be in date, checkpoint, or LSN/SCN format.

        Date Example: --cdc-start-position “2018-03-08T12:12:12”

        Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

        LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

      • CdcStopPosition (string) --

        Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

        Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

        Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

      • RecoveryCheckpoint (string) --

        Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        The statistics for the task, including elapsed time, tables loaded, and table errors.

        • FullLoadProgressPercent (integer) --

          The percent complete for the full load migration task.

        • ElapsedTimeMillis (integer) --

          The elapsed time of the task, in milliseconds.

        • TablesLoaded (integer) --

          The number of tables loaded for this task.

        • TablesLoading (integer) --

          The number of tables currently loading for this task.

        • TablesQueued (integer) --

          The number of tables queued for this task.

        • TablesErrored (integer) --

          The number of errors that have occurred during this task.

start_replication_task_assessment(**kwargs)

Starts the replication task assessment for unsupported data types in the source database.

See also: AWS API Documentation

Request Syntax

response = client.start_replication_task_assessment(
    ReplicationTaskArn='string'
)
Parameters
ReplicationTaskArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the replication task.

Return type
dict
Returns
Response Syntax
{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123
        }
    }
}

Response Structure

  • (dict) --
    • ReplicationTask (dict) --

      The assessed replication task.

      • ReplicationTaskIdentifier (string) --

        The user-assigned replication task identifier or name.

        Constraints:

        • Must contain from 1 to 255 alphanumeric characters or hyphens.
        • First character must be a letter.
        • Cannot end with a hyphen or contain two consecutive hyphens.
      • SourceEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • TargetEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • MigrationType (string) --

        The type of migration.

      • TableMappings (string) --

        Table mappings specified in the task.

      • ReplicationTaskSettings (string) --

        The settings for the replication task.

      • Status (string) --

        The status of the replication task.

      • LastFailureMessage (string) --

        The last error (failure) message generated for the replication instance.

      • StopReason (string) --

        The reason the replication task was stopped.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        The date the replication task is scheduled to start.

      • CdcStartPosition (string) --

        Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

        The value can be in date, checkpoint, or LSN/SCN format.

        Date Example: --cdc-start-position “2018-03-08T12:12:12”

        Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

        LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

      • CdcStopPosition (string) --

        Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

        Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

        Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

      • RecoveryCheckpoint (string) --

        Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        The statistics for the task, including elapsed time, tables loaded, and table errors.

        • FullLoadProgressPercent (integer) --

          The percent complete for the full load migration task.

        • ElapsedTimeMillis (integer) --

          The elapsed time of the task, in milliseconds.

        • TablesLoaded (integer) --

          The number of tables loaded for this task.

        • TablesLoading (integer) --

          The number of tables currently loading for this task.

        • TablesQueued (integer) --

          The number of tables queued for this task.

        • TablesErrored (integer) --

          The number of errors that have occurred during this task.

stop_replication_task(**kwargs)

Stops the replication task.

See also: AWS API Documentation

Request Syntax

response = client.stop_replication_task(
    ReplicationTaskArn='string'
)
Parameters
ReplicationTaskArn (string) --

[REQUIRED]

The Amazon Resource Name(ARN) of the replication task to be stopped.

Return type
dict
Returns
Response Syntax
{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123
        }
    }
}

Response Structure

  • (dict) --
    • ReplicationTask (dict) --

      The replication task stopped.

      • ReplicationTaskIdentifier (string) --

        The user-assigned replication task identifier or name.

        Constraints:

        • Must contain from 1 to 255 alphanumeric characters or hyphens.
        • First character must be a letter.
        • Cannot end with a hyphen or contain two consecutive hyphens.
      • SourceEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • TargetEndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • MigrationType (string) --

        The type of migration.

      • TableMappings (string) --

        Table mappings specified in the task.

      • ReplicationTaskSettings (string) --

        The settings for the replication task.

      • Status (string) --

        The status of the replication task.

      • LastFailureMessage (string) --

        The last error (failure) message generated for the replication instance.

      • StopReason (string) --

        The reason the replication task was stopped.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        The date the replication task is scheduled to start.

      • CdcStartPosition (string) --

        Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

        The value can be in date, checkpoint, or LSN/SCN format.

        Date Example: --cdc-start-position “2018-03-08T12:12:12”

        Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

        LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

      • CdcStopPosition (string) --

        Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

        Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

        Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

      • RecoveryCheckpoint (string) --

        Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        The statistics for the task, including elapsed time, tables loaded, and table errors.

        • FullLoadProgressPercent (integer) --

          The percent complete for the full load migration task.

        • ElapsedTimeMillis (integer) --

          The elapsed time of the task, in milliseconds.

        • TablesLoaded (integer) --

          The number of tables loaded for this task.

        • TablesLoading (integer) --

          The number of tables currently loading for this task.

        • TablesQueued (integer) --

          The number of tables queued for this task.

        • TablesErrored (integer) --

          The number of errors that have occurred during this task.

test_connection(**kwargs)

Tests the connection between the replication instance and the endpoint.

See also: AWS API Documentation

Request Syntax

response = client.test_connection(
    ReplicationInstanceArn='string',
    EndpointArn='string'
)
Parameters
  • ReplicationInstanceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication instance.

  • EndpointArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Return type

dict

Returns

Response Syntax

{
    'Connection': {
        'ReplicationInstanceArn': 'string',
        'EndpointArn': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'EndpointIdentifier': 'string',
        'ReplicationInstanceIdentifier': 'string'
    }
}

Response Structure

  • (dict) --

    • Connection (dict) --

      The connection tested.

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • EndpointArn (string) --

        The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

      • Status (string) --

        The connection status.

      • LastFailureMessage (string) --

        The error message when the connection last failed.

      • EndpointIdentifier (string) --

        The identifier of the endpoint. 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.

      • ReplicationInstanceIdentifier (string) --

        The replication instance identifier. This parameter is stored as a lowercase string.

Paginators

The available paginators are:

class DatabaseMigrationService.Paginator.DescribeCertificates
paginator = client.get_paginator('describe_certificates')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_certificates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

    Filters applied to the certificate described in the form of key-value pairs.

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Certificates': [
        {
            'CertificateIdentifier': 'string',
            'CertificateCreationDate': datetime(2015, 1, 1),
            'CertificatePem': 'string',
            'CertificateWallet': b'bytes',
            'CertificateArn': 'string',
            'CertificateOwner': 'string',
            'ValidFromDate': datetime(2015, 1, 1),
            'ValidToDate': datetime(2015, 1, 1),
            'SigningAlgorithm': 'string',
            'KeyLength': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Certificates (list) --

      The Secure Sockets Layer (SSL) certificates associated with the replication instance.

      • (dict) --

        The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.

        • CertificateIdentifier (string) --

          The customer-assigned name of the certificate. Valid characters are A-z and 0-9.

        • CertificateCreationDate (datetime) --

          The date that the certificate was created.

        • CertificatePem (string) --

          The contents of the .pem X.509 certificate file for the certificate.

        • CertificateWallet (bytes) --

          The location of the imported Oracle Wallet certificate for use with SSL.

        • CertificateArn (string) --

          The Amazon Resource Name (ARN) for the certificate.

        • CertificateOwner (string) --

          The owner of the certificate.

        • ValidFromDate (datetime) --

          The beginning date that the certificate is valid.

        • ValidToDate (datetime) --

          The final date that the certificate is valid.

        • SigningAlgorithm (string) --

          The signing algorithm for the certificate.

        • KeyLength (integer) --

          The key length of the cryptographic algorithm being used.

    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeConnections
paginator = client.get_paginator('describe_connections')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_connections().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

    The filters applied to the connection.

    Valid filter names: endpoint-arn | replication-instance-arn

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Connections': [
        {
            'ReplicationInstanceArn': 'string',
            'EndpointArn': 'string',
            'Status': 'string',
            'LastFailureMessage': 'string',
            'EndpointIdentifier': 'string',
            'ReplicationInstanceIdentifier': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Connections (list) --

      A description of the connections.

      • (dict) --

        • ReplicationInstanceArn (string) --

          The Amazon Resource Name (ARN) of the replication instance.

        • EndpointArn (string) --

          The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

        • Status (string) --

          The connection status.

        • LastFailureMessage (string) --

          The error message when the connection last failed.

        • EndpointIdentifier (string) --

          The identifier of the endpoint. 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.

        • ReplicationInstanceIdentifier (string) --

          The replication instance identifier. This parameter is stored as a lowercase string.

    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeEndpointTypes
paginator = client.get_paginator('describe_endpoint_types')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_endpoint_types().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: engine-name | endpoint-type

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'SupportedEndpointTypes': [
        {
            'EngineName': 'string',
            'SupportsCDC': True|False,
            'EndpointType': 'source'|'target',
            'EngineDisplayName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SupportedEndpointTypes (list) --

      The type of endpoints that are supported.

      • (dict) --

        • 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.

        • SupportsCDC (boolean) --

          Indicates if Change Data Capture (CDC) is supported.

        • EndpointType (string) --

          The type of endpoint.

        • EngineDisplayName (string) --

          The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."

    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeEndpoints
paginator = client.get_paginator('describe_endpoints')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_endpoints().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (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) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    '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'
            },
            'KinesisSettings': {
                'StreamArn': 'string',
                'MessageFormat': 'json',
                'ServiceAccessRoleArn': 'string'
            },
            'ElasticsearchSettings': {
                'ServiceAccessRoleArn': 'string',
                'EndpointUri': 'string',
                'FullLoadErrorPercentage': 123,
                'ErrorRetryDuration': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • 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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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 of source endpoint.

          Possible attributes include the following:

          • 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. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

          Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

          JSON syntax for these attributes is as follows: { "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 AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

        • KinesisSettings (dict) --

          The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.

          • StreamArn (string) --

            The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

          • MessageFormat (string) --

            The output format for the records created on the endpoint. The message format is JSON .

          • ServiceAccessRoleArn (string) --

            The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

        • ElasticsearchSettings (dict) --

          The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

          • ServiceAccessRoleArn (string) --

            The Amazon Resource Name (ARN) used by service to access the IAM role.

          • EndpointUri (string) --

            The endpoint for the ElasticSearch cluster.

          • FullLoadErrorPercentage (integer) --

            The maximum percentage of records that can fail to be written before a full load operation stops.

          • ErrorRetryDuration (integer) --

            The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeEventSubscriptions
paginator = client.get_paginator('describe_event_subscriptions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_event_subscriptions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SubscriptionName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • SubscriptionName (string) -- The name of the AWS DMS event subscription to be described.
  • Filters (list) --

    Filters applied to the action.

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'EventSubscriptionsList': [
        {
            'CustomerAwsId': 'string',
            'CustSubscriptionId': 'string',
            'SnsTopicArn': 'string',
            'Status': 'string',
            'SubscriptionCreationTime': 'string',
            'SourceType': 'string',
            'SourceIdsList': [
                'string',
            ],
            'EventCategoriesList': [
                'string',
            ],
            'Enabled': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • EventSubscriptionsList (list) --

      A list of event subscriptions.

      • (dict) --

        • CustomerAwsId (string) --

          The AWS customer account associated with the AWS DMS event notification subscription.

        • CustSubscriptionId (string) --

          The AWS DMS event notification subscription Id.

        • SnsTopicArn (string) --

          The topic ARN of the AWS DMS event notification subscription.

        • Status (string) --

          The status of the AWS DMS event notification subscription.

          Constraints:

          Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

          The status "no-permission" indicates that AWS DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime (string) --

          The time the RDS event notification subscription was created.

        • SourceType (string) --

          The type of AWS DMS resource that generates events.

          Valid values: replication-instance | replication-server | security-group | migration-task

        • SourceIdsList (list) --

          A list of source Ids for the event subscription.

          • (string) --
        • EventCategoriesList (list) --

          A lists of event categories.

          • (string) --
        • Enabled (boolean) --

          Boolean value that indicates if the event subscription is enabled.

    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeEvents
paginator = client.get_paginator('describe_events')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_events().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SourceIdentifier='string',
    SourceType='replication-instance',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Duration=123,
    EventCategories=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • SourceIdentifier (string) -- The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It cannot end with a hyphen or contain two consecutive hyphens.
  • SourceType (string) --

    The type of AWS DMS resource that generates events.

    Valid values: replication-instance | migration-task

  • StartTime (datetime) -- The start time for the events to be listed.
  • EndTime (datetime) -- The end time for the events to be listed.
  • Duration (integer) -- The duration of the events to be listed.
  • EventCategories (list) --

    A list of event categories for a source type that you want to subscribe to.

    • (string) --
  • Filters (list) --

    Filters applied to the action.

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Events': [
        {
            'SourceIdentifier': 'string',
            'SourceType': 'replication-instance',
            'Message': 'string',
            'EventCategories': [
                'string',
            ],
            'Date': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Events (list) --

      The events described.

      • (dict) --

        • SourceIdentifier (string) --

          The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

          Constraints:replication instance, endpoint, migration task

        • SourceType (string) --

          The type of AWS DMS resource that generates events.

          Valid values: replication-instance | endpoint | migration-task

        • Message (string) --

          The event message.

        • EventCategories (list) --

          The event categories available for the specified source type.

          • (string) --
        • Date (datetime) --

          The date of the event.

    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeOrderableReplicationInstances
paginator = client.get_paginator('describe_orderable_replication_instances')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_orderable_replication_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'OrderableReplicationInstances': [
        {
            'EngineVersion': 'string',
            'ReplicationInstanceClass': 'string',
            'StorageType': 'string',
            'MinAllocatedStorage': 123,
            'MaxAllocatedStorage': 123,
            'DefaultAllocatedStorage': 123,
            'IncludedAllocatedStorage': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • OrderableReplicationInstances (list) --

      The order-able replication instances available.

      • (dict) --
        • EngineVersion (string) --

          The version of the replication engine.

        • ReplicationInstanceClass (string) --

          The compute and memory capacity of the replication instance.

          Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

        • StorageType (string) --

          The type of storage used by the replication instance.

        • MinAllocatedStorage (integer) --

          The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

        • MaxAllocatedStorage (integer) --

          The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

        • DefaultAllocatedStorage (integer) --

          The default amount of storage (in gigabytes) that is allocated for the replication instance.

        • IncludedAllocatedStorage (integer) --

          The amount of storage (in gigabytes) that is allocated for the replication instance.

    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeReplicationInstances
paginator = client.get_paginator('describe_replication_instances')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_replication_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ReplicationInstances': [
        {
            'ReplicationInstanceIdentifier': 'string',
            'ReplicationInstanceClass': 'string',
            'ReplicationInstanceStatus': 'string',
            'AllocatedStorage': 123,
            'InstanceCreateTime': datetime(2015, 1, 1),
            'VpcSecurityGroups': [
                {
                    'VpcSecurityGroupId': 'string',
                    'Status': 'string'
                },
            ],
            'AvailabilityZone': 'string',
            'ReplicationSubnetGroup': {
                'ReplicationSubnetGroupIdentifier': 'string',
                'ReplicationSubnetGroupDescription': 'string',
                'VpcId': 'string',
                'SubnetGroupStatus': 'string',
                'Subnets': [
                    {
                        'SubnetIdentifier': 'string',
                        'SubnetAvailabilityZone': {
                            'Name': 'string'
                        },
                        'SubnetStatus': 'string'
                    },
                ]
            },
            'PreferredMaintenanceWindow': 'string',
            'PendingModifiedValues': {
                'ReplicationInstanceClass': 'string',
                'AllocatedStorage': 123,
                'MultiAZ': True|False,
                'EngineVersion': 'string'
            },
            'MultiAZ': True|False,
            'EngineVersion': 'string',
            'AutoMinorVersionUpgrade': True|False,
            'KmsKeyId': 'string',
            'ReplicationInstanceArn': 'string',
            'ReplicationInstancePublicIpAddress': 'string',
            'ReplicationInstancePrivateIpAddress': 'string',
            'ReplicationInstancePublicIpAddresses': [
                'string',
            ],
            'ReplicationInstancePrivateIpAddresses': [
                'string',
            ],
            'PubliclyAccessible': True|False,
            'SecondaryAvailabilityZone': 'string',
            'FreeUntil': datetime(2015, 1, 1),
            'DnsNameServers': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ReplicationInstances (list) --

      The replication instances described.

      • (dict) --

        • ReplicationInstanceIdentifier (string) --

          The replication instance identifier. This parameter is stored as a lowercase string.

          Constraints:

          • Must contain from 1 to 63 alphanumeric characters or hyphens.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.

          Example: myrepinstance

        • ReplicationInstanceClass (string) --

          The compute and memory capacity of the replication instance.

          Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

        • ReplicationInstanceStatus (string) --

          The status of the replication instance.

        • AllocatedStorage (integer) --

          The amount of storage (in gigabytes) that is allocated for the replication instance.

        • InstanceCreateTime (datetime) --

          The time the replication instance was created.

        • VpcSecurityGroups (list) --

          The VPC security group for the instance.

          • (dict) --

            • VpcSecurityGroupId (string) --

              The VPC security group Id.

            • Status (string) --

              The status of the VPC security group.

        • AvailabilityZone (string) --

          The Availability Zone for the instance.

        • ReplicationSubnetGroup (dict) --

          The subnet group for the replication instance.

          • ReplicationSubnetGroupIdentifier (string) --

            The identifier of the replication instance subnet group.

          • ReplicationSubnetGroupDescription (string) --

            The description of the replication subnet group.

          • VpcId (string) --

            The ID of the VPC.

          • SubnetGroupStatus (string) --

            The status of the subnet group.

          • Subnets (list) --

            The subnets that are in the subnet group.

            • (dict) --

              • SubnetIdentifier (string) --

                The subnet identifier.

              • SubnetAvailabilityZone (dict) --

                The Availability Zone of the subnet.

                • Name (string) --

                  The name of the availability zone.

              • SubnetStatus (string) --

                The status of the subnet.

        • PreferredMaintenanceWindow (string) --

          The maintenance window times for the replication instance.

        • PendingModifiedValues (dict) --

          The pending modification values.

          • ReplicationInstanceClass (string) --

            The compute and memory capacity of the replication instance.

            Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

          • AllocatedStorage (integer) --

            The amount of storage (in gigabytes) that is allocated for the replication instance.

          • MultiAZ (boolean) --

            Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

          • EngineVersion (string) --

            The engine version number of the replication instance.

        • MultiAZ (boolean) --

          Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true .

        • EngineVersion (string) --

          The engine version number of the replication instance.

        • AutoMinorVersionUpgrade (boolean) --

          Boolean value indicating if minor version upgrades will be automatically applied to the instance.

        • KmsKeyId (string) --

          The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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.

        • ReplicationInstanceArn (string) --

          The Amazon Resource Name (ARN) of the replication instance.

        • ReplicationInstancePublicIpAddress (string) --

          The public IP address of the replication instance.

        • ReplicationInstancePrivateIpAddress (string) --

          The private IP address of the replication instance.

        • ReplicationInstancePublicIpAddresses (list) --

          The public IP address of the replication instance.

          • (string) --
        • ReplicationInstancePrivateIpAddresses (list) --

          The private IP address of the replication instance.

          • (string) --
        • PubliclyAccessible (boolean) --

          Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true .

        • SecondaryAvailabilityZone (string) --

          The availability zone of the standby replication instance in a Multi-AZ deployment.

        • FreeUntil (datetime) --

          The expiration date of the free replication instance that is part of the Free DMS program.

        • DnsNameServers (string) --

          The DNS name servers for the replication instance.

    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeReplicationSubnetGroups
paginator = client.get_paginator('describe_replication_subnet_groups')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_replication_subnet_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ReplicationSubnetGroups': [
        {
            'ReplicationSubnetGroupIdentifier': 'string',
            'ReplicationSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ReplicationSubnetGroups (list) --

      A description of the replication subnet groups.

      • (dict) --

        • ReplicationSubnetGroupIdentifier (string) --

          The identifier of the replication instance subnet group.

        • ReplicationSubnetGroupDescription (string) --

          The description of the replication subnet group.

        • VpcId (string) --

          The ID of the VPC.

        • SubnetGroupStatus (string) --

          The status of the subnet group.

        • Subnets (list) --

          The subnets that are in the subnet group.

          • (dict) --

            • SubnetIdentifier (string) --

              The subnet identifier.

            • SubnetAvailabilityZone (dict) --

              The Availability Zone of the subnet.

              • Name (string) --

                The name of the availability zone.

            • SubnetStatus (string) --

              The status of the subnet.

    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeReplicationTaskAssessmentResults
paginator = client.get_paginator('describe_replication_task_assessment_results')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_replication_task_assessment_results().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ReplicationTaskArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ReplicationTaskArn (string) --
    • The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified the API will return only one result and ignore the values of the max-records and marker parameters.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'BucketName': 'string',
    'ReplicationTaskAssessmentResults': [
        {
            'ReplicationTaskIdentifier': 'string',
            'ReplicationTaskArn': 'string',
            'ReplicationTaskLastAssessmentDate': datetime(2015, 1, 1),
            'AssessmentStatus': 'string',
            'AssessmentResultsFile': 'string',
            'AssessmentResults': 'string',
            'S3ObjectUrl': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • BucketName (string) --

      • The Amazon S3 bucket where the task assessment report is located.
    • ReplicationTaskAssessmentResults (list) --

      The task assessment report.

      • (dict) --

        The task assessment report in JSON format.

        • ReplicationTaskIdentifier (string) --

          The replication task identifier of the task on which the task assessment was run.

        • ReplicationTaskArn (string) --

          The Amazon Resource Name (ARN) of the replication task.

        • ReplicationTaskLastAssessmentDate (datetime) --

          The date the task assessment was completed.

        • AssessmentStatus (string) --

          The status of the task assessment.

        • AssessmentResultsFile (string) --

          The file containing the results of the task assessment.

        • AssessmentResults (string) --

          The task assessment results in JSON format.

        • S3ObjectUrl (string) --

          The URL of the S3 object containing the task assessment results.

    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeReplicationTasks
paginator = client.get_paginator('describe_replication_tasks')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_replication_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ReplicationTasks': [
        {
            'ReplicationTaskIdentifier': 'string',
            'SourceEndpointArn': 'string',
            'TargetEndpointArn': 'string',
            'ReplicationInstanceArn': 'string',
            'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
            'TableMappings': 'string',
            'ReplicationTaskSettings': 'string',
            'Status': 'string',
            'LastFailureMessage': 'string',
            'StopReason': 'string',
            'ReplicationTaskCreationDate': datetime(2015, 1, 1),
            'ReplicationTaskStartDate': datetime(2015, 1, 1),
            'CdcStartPosition': 'string',
            'CdcStopPosition': 'string',
            'RecoveryCheckpoint': 'string',
            'ReplicationTaskArn': 'string',
            'ReplicationTaskStats': {
                'FullLoadProgressPercent': 123,
                'ElapsedTimeMillis': 123,
                'TablesLoaded': 123,
                'TablesLoading': 123,
                'TablesQueued': 123,
                'TablesErrored': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ReplicationTasks (list) --

      A description of the replication tasks.

      • (dict) --

        • ReplicationTaskIdentifier (string) --

          The user-assigned replication task identifier or name.

          Constraints:

          • Must contain from 1 to 255 alphanumeric characters or hyphens.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
        • SourceEndpointArn (string) --

          The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

        • TargetEndpointArn (string) --

          The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

        • ReplicationInstanceArn (string) --

          The Amazon Resource Name (ARN) of the replication instance.

        • MigrationType (string) --

          The type of migration.

        • TableMappings (string) --

          Table mappings specified in the task.

        • ReplicationTaskSettings (string) --

          The settings for the replication task.

        • Status (string) --

          The status of the replication task.

        • LastFailureMessage (string) --

          The last error (failure) message generated for the replication instance.

        • StopReason (string) --

          The reason the replication task was stopped.

        • ReplicationTaskCreationDate (datetime) --

          The date the replication task was created.

        • ReplicationTaskStartDate (datetime) --

          The date the replication task is scheduled to start.

        • CdcStartPosition (string) --

          Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

          The value can be in date, checkpoint, or LSN/SCN format.

          Date Example: --cdc-start-position “2018-03-08T12:12:12”

          Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

          LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

        • CdcStopPosition (string) --

          Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

          Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

          Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

        • RecoveryCheckpoint (string) --

          Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

        • ReplicationTaskArn (string) --

          The Amazon Resource Name (ARN) of the replication task.

        • ReplicationTaskStats (dict) --

          The statistics for the task, including elapsed time, tables loaded, and table errors.

          • FullLoadProgressPercent (integer) --

            The percent complete for the full load migration task.

          • ElapsedTimeMillis (integer) --

            The elapsed time of the task, in milliseconds.

          • TablesLoaded (integer) --

            The number of tables loaded for this task.

          • TablesLoading (integer) --

            The number of tables currently loading for this task.

          • TablesQueued (integer) --

            The number of tables queued for this task.

          • TablesErrored (integer) --

            The number of errors that have occurred during this task.

    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeSchemas
paginator = client.get_paginator('describe_schemas')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_schemas().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    EndpointArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • EndpointArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Schemas': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Schemas (list) --

      The described schema.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

class DatabaseMigrationService.Paginator.DescribeTableStatistics
paginator = client.get_paginator('describe_table_statistics')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_table_statistics().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ReplicationTaskArn='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ReplicationTaskArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication task.

  • Filters (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) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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'
        },
    ],
    'NextToken': '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.

    • NextToken (string) --

      A token to resume pagination.

Waiters

The available waiters are:

class DatabaseMigrationService.Waiter.EndpointDeleted
waiter = client.get_waiter('endpoint_deleted')
wait(**kwargs)

Polls DatabaseMigrationService.Client.describe_endpoints() every 5 seconds until a successful state is reached. An error is returned after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • Filters (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) --
  • MaxRecords (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.

  • 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 .
  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 5

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 60

Returns

None

class DatabaseMigrationService.Waiter.ReplicationInstanceAvailable
waiter = client.get_waiter('replication_instance_available')
wait(**kwargs)

Polls DatabaseMigrationService.Client.describe_replication_instances() every 60 seconds until a successful state is reached. An error is returned after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 60

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 60

Returns

None

class DatabaseMigrationService.Waiter.ReplicationInstanceDeleted
waiter = client.get_waiter('replication_instance_deleted')
wait(**kwargs)

Polls DatabaseMigrationService.Client.describe_replication_instances() every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 15

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 60

Returns

None

class DatabaseMigrationService.Waiter.ReplicationTaskDeleted
waiter = client.get_waiter('replication_task_deleted')
wait(**kwargs)

Polls DatabaseMigrationService.Client.describe_replication_tasks() every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 15

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 60

Returns

None

class DatabaseMigrationService.Waiter.ReplicationTaskReady
waiter = client.get_waiter('replication_task_ready')
wait(**kwargs)

Polls DatabaseMigrationService.Client.describe_replication_tasks() every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 15

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 60

Returns

None

class DatabaseMigrationService.Waiter.ReplicationTaskRunning
waiter = client.get_waiter('replication_task_running')
wait(**kwargs)

Polls DatabaseMigrationService.Client.describe_replication_tasks() every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 15

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 60

Returns

None

class DatabaseMigrationService.Waiter.ReplicationTaskStopped
waiter = client.get_waiter('replication_task_stopped')
wait(**kwargs)

Polls DatabaseMigrationService.Client.describe_replication_tasks() every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • Filters (list) --

    Filters applied to the describe action.

    Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

    • (dict) --
      • Name (string) -- [REQUIRED]

        The name of the filter.

      • Values (list) -- [REQUIRED]

        The filter value.

        • (string) --
  • MaxRecords (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.

  • 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 .
  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 15

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 60

Returns

None

class DatabaseMigrationService.Waiter.TestConnectionSucceeds
waiter = client.get_waiter('test_connection_succeeds')
wait(**kwargs)

Polls DatabaseMigrationService.Client.test_connection() every 5 seconds until a successful state is reached. An error is returned after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    ReplicationInstanceArn='string',
    EndpointArn='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • ReplicationInstanceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication instance.

  • EndpointArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 5

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 60

Returns

None