:doc:`MemoryDB <../../memorydb>` / Paginator / DescribeMultiRegionClusters

***************************
DescribeMultiRegionClusters
***************************



.. py:class:: MemoryDB.Paginator.DescribeMultiRegionClusters

  ::

    
    paginator = client.get_paginator('describe_multi_region_clusters')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`MemoryDB.Client.describe_multi_region_clusters`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeMultiRegionClusters>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          MultiRegionClusterName='string',
          ShowClusterDetails=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type MultiRegionClusterName: string
    :param MultiRegionClusterName: 

      The name of a specific multi-Region cluster to describe.

      

    
    :type ShowClusterDetails: boolean
    :param ShowClusterDetails: 

      Details about the multi-Region cluster.

      

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

      
      ::

        {
            'MultiRegionClusters': [
                {
                    'MultiRegionClusterName': 'string',
                    'Description': 'string',
                    'Status': 'string',
                    'NodeType': 'string',
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'NumberOfShards': 123,
                    'Clusters': [
                        {
                            'ClusterName': 'string',
                            'Region': 'string',
                            'Status': 'string',
                            'ARN': 'string'
                        },
                    ],
                    'MultiRegionParameterGroupName': 'string',
                    'TLSEnabled': True|False,
                    'ARN': 'string'
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **MultiRegionClusters** *(list) --* 

          A list of multi-Region clusters.

          
          

          - *(dict) --* 

            Represents a multi-Region cluster.

            
            

            - **MultiRegionClusterName** *(string) --* 

              The name of the multi-Region cluster.

              
            

            - **Description** *(string) --* 

              The description of the multi-Region cluster.

              
            

            - **Status** *(string) --* 

              The current status of the multi-Region cluster.

              
            

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

              The node type used by the multi-Region cluster.

              
            

            - **Engine** *(string) --* 

              The name of the engine used by the multi-Region cluster.

              
            

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

              The version of the engine used by the multi-Region cluster.

              
            

            - **NumberOfShards** *(integer) --* 

              The number of shards in the multi-Region cluster.

              
            

            - **Clusters** *(list) --* 

              The clusters in this multi-Region cluster.

              
              

              - *(dict) --* 

                Represents a Regional cluster

                
                

                - **ClusterName** *(string) --* 

                  The name of the Regional cluster

                  
                

                - **Region** *(string) --* 

                  The Region the current Regional cluster is assigned to.

                  
                

                - **Status** *(string) --* 

                  The status of the Regional cluster.

                  
                

                - **ARN** *(string) --* 

                  The Amazon Resource Name (ARN) the Regional cluster

                  
            
          
            

            - **MultiRegionParameterGroupName** *(string) --* 

              The name of the multi-Region parameter group associated with the cluster.

              
            

            - **TLSEnabled** *(boolean) --* 

              Indiciates if the multi-Region cluster is TLS enabled.

              
            

            - **ARN** *(string) --* 

              The Amazon Resource Name (ARN) of the multi-Region cluster.

              
        
      
    