AWS API Changes

2016/12/14 - AWS Database Migration Service - 1 new12 updated api methods

Changes Update dms client to latest version

ModifyReplicationTask (new)

Link ¶

Modifies the specified replication task.

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

Request Syntax

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

type ReplicationTaskArn:

string

param ReplicationTaskArn:

[REQUIRED]

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

type ReplicationTaskIdentifier:

string

param ReplicationTaskIdentifier:

The replication task identifier.

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.

type MigrationType:

string

param MigrationType:

The migration type.

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

type TableMappings:

string

param TableMappings:

The path of the JSON file that contains the table mappings. Preceed the path with "file://".

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

type ReplicationTaskSettings:

string

param ReplicationTaskSettings:

JSON file that contains settings for the task, such as target metadata settings.

type CdcStartTime:

datetime

param CdcStartTime:

The start time for the Change Data Capture (CDC) operation.

rtype:

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),
        '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 replication task identifier.
    
    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.
  - 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.
  - 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.

CreateReplicationInstance (updated)

Link ¶
Changes (response)

{'ReplicationInstance': {'SecondaryAvailabilityZone': 'string'}}

Creates the replication instance using the specified parameters.

See also: AWS API Documentation

Request Syntax

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
)

type ReplicationInstanceIdentifier:

string

param ReplicationInstanceIdentifier:

[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

type AllocatedStorage:

integer

param AllocatedStorage:

The amount of storage (in gigabytes) to be initially allocated for the replication instance.

type ReplicationInstanceClass:

string

param ReplicationInstanceClass:

[REQUIRED]

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

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

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

type AvailabilityZone:

string

param AvailabilityZone:

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

type ReplicationSubnetGroupIdentifier:

string

param ReplicationSubnetGroupIdentifier:

A subnet group to associate with the replication instance.

type PreferredMaintenanceWindow:

string

param PreferredMaintenanceWindow:

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.

type MultiAZ:

boolean

param MultiAZ:

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.

type EngineVersion:

string

param EngineVersion:

The engine version number of the replication instance.

type AutoMinorVersionUpgrade:

boolean

param AutoMinorVersionUpgrade:

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

Default: true

type Tags:

list

param Tags:

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

type KmsKeyId:

string

param KmsKeyId:

The KMS key identifier that will be used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

type PubliclyAccessible:

boolean

param PubliclyAccessible:

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.

rtype:

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'
    }
}

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 KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
  - 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.

CreateReplicationTask (updated)

Link ¶
Changes (response)

{'ReplicationTask': {'StopReason': 'string'}}

Creates a replication task using the specified parameters.

See also: AWS API Documentation

Request Syntax

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),
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ReplicationTaskIdentifier:

string

param ReplicationTaskIdentifier:

[REQUIRED]

The replication task identifier.

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.

type SourceEndpointArn:

string

param SourceEndpointArn:

[REQUIRED]

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

type TargetEndpointArn:

string

param TargetEndpointArn:

[REQUIRED]

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

type ReplicationInstanceArn:

string

param ReplicationInstanceArn:

[REQUIRED]

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

type MigrationType:

string

param MigrationType:

[REQUIRED]

The migration type.

type TableMappings:

string

param TableMappings:

[REQUIRED]

The path of the JSON file that contains the table mappings. Preceed the path with "file://".

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

type ReplicationTaskSettings:

string

param ReplicationTaskSettings:

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.

type CdcStartTime:

datetime

param CdcStartTime:

The start time for the Change Data Capture (CDC) operation.

type Tags:

list

param Tags:

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

rtype:

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),
        '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 replication task identifier.
    
    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.
  - 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.
  - 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.

DeleteCertificate (updated)

Link ¶
Changes (response)

{'Certificate': {'CertificateWallet': 'blob'}}

Deletes the specified certificate.

See also: AWS API Documentation

Request Syntax

client.delete_certificate(
    CertificateArn='string'
)

type CertificateArn:

string

param CertificateArn:

[REQUIRED]

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

rtype:

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.

DeleteReplicationInstance (updated)

Link ¶
Changes (response)

{'ReplicationInstance': {'SecondaryAvailabilityZone': 'string'}}

Deletes the specified replication instance.

See also: AWS API Documentation

Request Syntax

client.delete_replication_instance(
    ReplicationInstanceArn='string'
)

type ReplicationInstanceArn:

string

param ReplicationInstanceArn:

[REQUIRED]

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

rtype:

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'
    }
}

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 KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
  - 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.

DeleteReplicationTask (updated)

Link ¶
Changes (response)

{'ReplicationTask': {'StopReason': 'string'}}

Deletes the specified replication task.

See also: AWS API Documentation

Request Syntax

client.delete_replication_task(
    ReplicationTaskArn='string'
)

type ReplicationTaskArn:

string

param ReplicationTaskArn:

[REQUIRED]

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

rtype:

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),
        '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 replication task identifier.
    
    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.
  - 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.
  - 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.

DescribeCertificates (updated)

Link ¶
Changes (response)

{'Certificates': {'CertificateWallet': 'blob'}}

Provides a description of the certificate.

See also: AWS API Documentation

Request Syntax

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

type Filters:

list

param Filters:

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

type MaxRecords:

integer

param MaxRecords:

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

type Marker:

string

param Marker:

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.

rtype:

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.

DescribeReplicationInstances (updated)

Link ¶
Changes (response)

{'ReplicationInstances': {'SecondaryAvailabilityZone': 'string'}}

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

See also: AWS API Documentation

Request Syntax

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

type Filters:

list

param Filters:

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

type MaxRecords:

integer

param MaxRecords:

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker:

string

param Marker:

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.

rtype:

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

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 KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
    - 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.

DescribeReplicationTasks (updated)

Link ¶
Changes (response)

{'ReplicationTasks': {'StopReason': 'string'}}

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

See also: AWS API Documentation

Request Syntax

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

type Filters:

list

param Filters:

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

type MaxRecords:

integer

param MaxRecords:

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker:

string

param Marker:

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.

rtype:

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),
            '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 replication task identifier.
      
      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.
    - 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.
    - 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.

ImportCertificate (updated)

Link ¶
Changes (request, response)
Request

{'CertificateWallet': 'blob'}

Response

{'Certificate': {'CertificateWallet': 'blob'}}

Uploads the specified certificate.

See also: AWS API Documentation

Request Syntax

client.import_certificate(
    CertificateIdentifier='string',
    CertificatePem='string',
    CertificateWallet=b'bytes'
)

type CertificateIdentifier:

string

param CertificateIdentifier:

[REQUIRED]

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

type CertificatePem:

string

param CertificatePem:

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

type CertificateWallet:

bytes

param CertificateWallet:

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

rtype:

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.

ModifyReplicationInstance (updated)

Link ¶
Changes (response)

{'ReplicationInstance': {'SecondaryAvailabilityZone': 'string'}}

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

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

type ReplicationInstanceArn:

string

param ReplicationInstanceArn:

[REQUIRED]

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

type AllocatedStorage:

integer

param AllocatedStorage:

The amount of storage (in gigabytes) to be allocated for the replication instance.

type ApplyImmediately:

boolean

param ApplyImmediately:

Indicates whether the changes should be applied immediately or during the next maintenance window.

type ReplicationInstanceClass:

string

param ReplicationInstanceClass:

The compute and memory capacity of the replication instance.

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

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

type PreferredMaintenanceWindow:

string

param PreferredMaintenanceWindow:

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

type MultiAZ:

boolean

param MultiAZ:

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.

type EngineVersion:

string

param EngineVersion:

The engine version number of the replication instance.

type AllowMajorVersionUpgrade:

boolean

param AllowMajorVersionUpgrade:

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.

type AutoMinorVersionUpgrade:

boolean

param AutoMinorVersionUpgrade:

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.

type ReplicationInstanceIdentifier:

string

param ReplicationInstanceIdentifier:

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

rtype:

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'
    }
}

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 KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
  - 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.

StartReplicationTask (updated)

Link ¶
Changes (response)

{'ReplicationTask': {'StopReason': 'string'}}

Starts the replication task.

See also: AWS API Documentation

Request Syntax

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

type ReplicationTaskArn:

string

param ReplicationTaskArn:

[REQUIRED]

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

type StartReplicationTaskType:

string

param StartReplicationTaskType:

[REQUIRED]

The type of replication task.

type CdcStartTime:

datetime

param CdcStartTime:

The start time for the Change Data Capture (CDC) operation.

rtype:

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),
        '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 replication task identifier.
    
    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.
  - 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.
  - 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.

StopReplicationTask (updated)

Link ¶
Changes (response)

{'ReplicationTask': {'StopReason': 'string'}}

Stops the replication task.

See also: AWS API Documentation

Request Syntax

client.stop_replication_task(
    ReplicationTaskArn='string'
)

type ReplicationTaskArn:

string

param ReplicationTaskArn:

[REQUIRED]

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

rtype:

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),
        '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 replication task identifier.
    
    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.
  - 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.
  - 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.