:doc:`DatabaseMigrationService <../../dms>` / Client / describe_orderable_replication_instances

****************************************
describe_orderable_replication_instances
****************************************



.. py:method:: DatabaseMigrationService.Client.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 <https://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeOrderableReplicationInstances>`_  


  **Request Syntax**
  ::

    response = client.describe_orderable_replication_instances(
        MaxRecords=123,
        Marker='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: 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**

    
    ::

      {
          'OrderableReplicationInstances': [
              {
                  'EngineVersion': 'string',
                  'ReplicationInstanceClass': 'string',
                  'StorageType': 'string',
                  'MinAllocatedStorage': 123,
                  'MaxAllocatedStorage': 123,
                  'DefaultAllocatedStorage': 123,
                  'IncludedAllocatedStorage': 123,
                  'AvailabilityZones': [
                      'string',
                  ],
                  'ReleaseStatus': 'beta'|'prod'
              },
          ],
          'Marker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **OrderableReplicationInstances** *(list) --* 

        The order-able replication instances available.

        
        

        - *(dict) --* 

          In response to the ``DescribeOrderableReplicationInstances`` operation, this object describes an available replication instance. This description includes the replication instance's type, engine version, and allocated storage.

          
          

          - **EngineVersion** *(string) --* 

            The version of the replication engine.

            
          

          - **ReplicationInstanceClass** *(string) --* 

            The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to ``"dms.c4.large"``.

             

            For more information on the settings and capacities for the available replication instance classes, see `Selecting the right DMS replication instance for your migration <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth>`__.

            
          

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

            
          

          - **AvailabilityZones** *(list) --* 

            List of Availability Zones for this replication instance.

            
            

            - *(string) --* 
        
          

          - **ReleaseStatus** *(string) --* 

            The value returned when the specified ``EngineVersion`` of the replication instance is in Beta or test mode. This indicates some features might not work as expected.

             

            .. note::

              

              DMS supports the ``ReleaseStatus`` parameter in versions 3.1.4 and later.

              

            
      
    
      

      - **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``.

        
  

  **Examples**

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

    response = client.describe_orderable_replication_instances(
        Marker='',
        MaxRecords=123,
    )
    
    print(response)

  
  Expected Output:
  ::

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

  