Bedrock / Client / list_prompt_routers

list_prompt_routers#

Bedrock.Client.list_prompt_routers(**kwargs)#

Retrieves a list of prompt routers.

See also: AWS API Documentation

Request Syntax

response = client.list_prompt_routers(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – The maximum number of prompt routers to return in one page of results.

  • nextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.

Return type:

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