BedrockAgentCore / Paginator / ListRecommendations

ListRecommendations¶

class BedrockAgentCore.Paginator.ListRecommendations¶

paginator = client.get_paginator('list_recommendations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from BedrockAgentCore.Client.list_recommendations().

Request Syntax

response_iterator = paginator.paginate(
    statusFilter='PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'DELETING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

statusFilter (string) – Optional filter to return only recommendations with the specified status.
PaginationConfig (dict) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'recommendationSummaries': [
        {
            'recommendationId': 'string',
            'recommendationArn': 'string',
            'name': 'string',
            'description': 'string',
            'type': 'SYSTEM_PROMPT_RECOMMENDATION'|'TOOL_DESCRIPTION_RECOMMENDATION',
            'status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'DELETING',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- recommendationSummaries (list) –
  
  The list of recommendation summaries.
  - (dict) –
    
    Summary information about a recommendation.
    - recommendationId (string) –
      
      The unique identifier of the recommendation.
    - recommendationArn (string) –
      
      The Amazon Resource Name (ARN) of the recommendation.
    - name (string) –
      
      The name of the recommendation.
    - description (string) –
      
      The description of the recommendation.
    - type (string) –
      
      The type of recommendation.
    - status (string) –
      
      The current status of the recommendation.
    - createdAt (datetime) –
      
      The timestamp when the recommendation was created.
    - updatedAt (datetime) –
      
      The timestamp when the recommendation was last updated.
- NextToken (string) –
  
  A token to resume pagination.