DatabaseMigrationService / Client / describe_replication_instances

describe_replication_instances#

DatabaseMigrationService.Client.describe_replication_instances(**kwargs)#

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

Request Syntax

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

Parameters:

Filters (list) –
Filters applied to replication instances.

Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
- (dict) –
  
  Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
  - Name (string) – [REQUIRED]
    
    The name of the filter as specified for a Describe* or similar operation.
  - Values (list) – [REQUIRED]
    
    The filter value, which can specify one or more values used to narrow the returned results.
    - (string) –
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'
                    },
                ],
                'SupportedNetworkTypes': [
                    'string',
                ]
            },
            'PreferredMaintenanceWindow': 'string',
            'PendingModifiedValues': {
                'ReplicationInstanceClass': 'string',
                'AllocatedStorage': 123,
                'MultiAZ': True|False,
                'EngineVersion': 'string',
                'NetworkType': 'string'
            },
            'MultiAZ': True|False,
            'EngineVersion': 'string',
            'AutoMinorVersionUpgrade': True|False,
            'KmsKeyId': 'string',
            'ReplicationInstanceArn': 'string',
            'ReplicationInstancePublicIpAddress': 'string',
            'ReplicationInstancePrivateIpAddress': 'string',
            'ReplicationInstancePublicIpAddresses': [
                'string',
            ],
            'ReplicationInstancePrivateIpAddresses': [
                'string',
            ],
            'ReplicationInstanceIpv6Addresses': [
                'string',
            ],
            'PubliclyAccessible': True|False,
            'SecondaryAvailabilityZone': 'string',
            'FreeUntil': datetime(2015, 1, 1),
            'DnsNameServers': 'string',
            'NetworkType': 'string',
            'KerberosAuthenticationSettings': {
                'KeyCacheSecretId': 'string',
                'KeyCacheSecretIamArn': 'string',
                'Krb5FileContents': '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) –
    
    Provides information that defines a replication instance.
    - ReplicationInstanceIdentifier (string) –
      
      The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
      
      Constraints:
      - Must contain 1-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 as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.
      
      For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
    - ReplicationInstanceStatus (string) –
      
      The status of the replication instance. The possible return values include:
      - "available"
      - "creating"
      - "deleted"
      - "deleting"
      - "failed"
      - "modifying"
      - "upgrading"
      - "rebooting"
      - "resetting-master-credentials"
      - "storage-full"
      - "incompatible-credentials"
      - "incompatible-network"
      - "maintenance"
    - 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) –
        
        Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
        
        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) –
        
        A description for 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) –
        
        In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
        
        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.
      - SupportedNetworkTypes (list) –
        
        The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
        
        (string) –
    - PreferredMaintenanceWindow (string) –
      
      The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
    - PendingModifiedValues (dict) –
      
      The pending modification values.
      - ReplicationInstanceClass (string) –
        
        The compute and memory capacity of the replication instance as defined for the specified replication instance class.
        
        For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
      - AllocatedStorage (integer) –
        
        The amount of storage (in gigabytes) that is allocated for the replication instance.
      - MultiAZ (boolean) –
        
        Specifies whether the replication instance is a Multi-AZ deployment. You can’t set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
      - EngineVersion (string) –
        
        The engine version number of the replication instance.
      - NetworkType (string) –
        
        The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
    - MultiAZ (boolean) –
      
      Specifies whether the replication instance is a Multi-AZ deployment. You can’t set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
    - EngineVersion (string) –
      
      The engine version number of the replication instance.
      
      If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
      
      When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
    - AutoMinorVersionUpgrade (boolean) –
      
      Boolean value indicating if minor version upgrades will be automatically applied to the instance.
    - KmsKeyId (string) –
      
      An KMS key identifier that is used to encrypt the data on the replication instance.
      
      If you don’t specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
      
      KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
    - 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) –
      
      One or more public IP addresses for the replication instance.
      - (string) –
    - ReplicationInstancePrivateIpAddresses (list) –
      
      One or more private IP addresses for the replication instance.
      - (string) –
    - ReplicationInstanceIpv6Addresses (list) –
      
      One or more IPv6 addresses for 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 supported for the replication instance to access your on-premise source or target database.
    - NetworkType (string) –
      
      The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
    - KerberosAuthenticationSettings (dict) –
      
      Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when replicating an instance.
      - KeyCacheSecretId (string) –
        
        Specifies the secret ID of the key cache for the replication instance.
      - KeyCacheSecretIamArn (string) –
        
        Specifies the Amazon Resource Name (ARN) of the IAM role that grants Amazon Web Services DMS access to the secret containing key cache file for the replication instance.
      - Krb5FileContents (string) –
        
        Specifies the ID of the secret that stores the key cache file required for kerberos authentication of the replication instance.

Exceptions

DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault

Examples

Returns the status of the refresh-schemas operation.

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

print(response)

Expected Output:

{
    'Marker': '',
    'ReplicationInstances': [
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}