:doc:`DatabaseMigrationService <../../dms>` / Paginator / DescribeOrderableReplicationInstances

*************************************
DescribeOrderableReplicationInstances
*************************************



.. py:class:: DatabaseMigrationService.Paginator.DescribeOrderableReplicationInstances

  ::

    
    paginator = client.get_paginator('describe_orderable_replication_instances')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`DatabaseMigrationService.Client.describe_orderable_replication_instances`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeOrderableReplicationInstances>`_    


    **Request Syntax**
    ::

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

      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.

        

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

                

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    