:doc:`Bedrock <../../bedrock>` / Paginator / ListPromptRouters

*****************
ListPromptRouters
*****************



.. py:class:: Bedrock.Paginator.ListPromptRouters

  ::

    
    paginator = client.get_paginator('list_prompt_routers')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Bedrock.Client.list_prompt_routers`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListPromptRouters>`_    


    **Request Syntax**
    ::

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

      The type of the prompt routers, such as whether it's default or custom.

      

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

      
      ::

        {
            'promptRouterSummaries': [
                {
                    'promptRouterName': 'string',
                    'routingCriteria': {
                        'responseQualityDifference': 123.0
                    },
                    'description': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'promptRouterArn': 'string',
                    'models': [
                        {
                            'modelArn': 'string'
                        },
                    ],
                    'fallbackModel': {
                        'modelArn': 'string'
                    },
                    'status': 'AVAILABLE',
                    'type': 'custom'|'default'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **promptRouterSummaries** *(list) --* 

          A list of prompt router summaries.

          
          

          - *(dict) --* 

            Details about a prompt router.

            
            

            - **promptRouterName** *(string) --* 

              The router's name.

              
            

            - **routingCriteria** *(dict) --* 

              The router's routing criteria.

              
              

              - **responseQualityDifference** *(float) --* 

                The criteria's response quality difference.

                
          
            

            - **description** *(string) --* 

              The router's description.

              
            

            - **createdAt** *(datetime) --* 

              When the router was created.

              
            

            - **updatedAt** *(datetime) --* 

              When the router was updated.

              
            

            - **promptRouterArn** *(string) --* 

              The router's ARN.

              
            

            - **models** *(list) --* 

              The router's models.

              
              

              - *(dict) --* 

                The target model for a prompt router.

                
                

                - **modelArn** *(string) --* 

                  The target model's ARN.

                  
            
          
            

            - **fallbackModel** *(dict) --* 

              The router's fallback model.

              
              

              - **modelArn** *(string) --* 

                The target model's ARN.

                
          
            

            - **status** *(string) --* 

              The router's status.

              
            

            - **type** *(string) --* 

              The summary's type.

              
        
      
        

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

          A token to resume pagination.

          
    