:doc:`Redshift <../../redshift>` / Paginator / DescribeOrderableClusterOptions

*******************************
DescribeOrderableClusterOptions
*******************************



.. py:class:: Redshift.Paginator.DescribeOrderableClusterOptions

  ::

    
    paginator = client.get_paginator('describe_orderable_cluster_options')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Redshift.Client.describe_orderable_cluster_options`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeOrderableClusterOptions>`_    


    **Request Syntax**
    ::

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

      The version filter value. Specify this parameter to show only the available offerings matching the specified version.

       

      Default: All versions.

       

      Constraints: Must be one of the version returned from  DescribeClusterVersions.

      

    
    :type NodeType: string
    :param NodeType: 

      The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

      

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

      
      ::

        {
            'OrderableClusterOptions': [
                {
                    'ClusterVersion': 'string',
                    'ClusterType': 'string',
                    'NodeType': 'string',
                    'AvailabilityZones': [
                        {
                            'Name': 'string',
                            'SupportedPlatforms': [
                                {
                                    'Name': 'string'
                                },
                            ]
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains the output from the  DescribeOrderableClusterOptions action.

        
        

        - **OrderableClusterOptions** *(list) --* 

          An ``OrderableClusterOption`` structure containing information about orderable options for the cluster.

          
          

          - *(dict) --* 

            Describes an orderable cluster option.

            
            

            - **ClusterVersion** *(string) --* 

              The version of the orderable cluster.

              
            

            - **ClusterType** *(string) --* 

              The cluster type, for example ``multi-node``.

              
            

            - **NodeType** *(string) --* 

              The node type for the orderable cluster.

              
            

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

              A list of availability zones for the orderable cluster.

              
              

              - *(dict) --* 

                Describes an availability zone.

                
                

                - **Name** *(string) --* 

                  The name of the availability zone.

                  
                

                - **SupportedPlatforms** *(list) --* 
                  

                  - *(dict) --* 

                    A list of supported platforms for orderable clusters.

                    
                    

                    - **Name** *(string) --* 
                
              
            
          
        
      
        

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

          A token to resume pagination.

          
    