:doc:`Bedrock <../../bedrock>` / Client / list_prompt_routers

*******************
list_prompt_routers
*******************



.. py:method:: Bedrock.Client.list_prompt_routers(**kwargs)

  

  Retrieves a list of prompt routers.

  

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


  **Request Syntax**
  ::

    response = client.list_prompt_routers(
        maxResults=123,
        nextToken='string',
        type='custom'|'default'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of prompt routers to return in one page of results.

    

  
  :type nextToken: string
  :param nextToken: 

    Specify the pagination token from a previous request to retrieve the next page of results.

    

  
  :type type: string
  :param type: 

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

    

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

        Specify the pagination token from a previous request to retrieve the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`Bedrock.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Bedrock.Client.exceptions.ValidationException`

  
  *   :py:class:`Bedrock.Client.exceptions.InternalServerException`

  
  *   :py:class:`Bedrock.Client.exceptions.ThrottlingException`

  