BedrockAgentCore / Client / list_recommendations

list_recommendations¶

BedrockAgentCore.Client.list_recommendations(**kwargs)¶

Lists all recommendations in the account, with optional filtering by status.

Request Syntax

response = client.list_recommendations(
    maxResults=123,
    nextToken='string',
    statusFilter='PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'DELETING'
)

Parameters:

maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
statusFilter (string) – Optional filter to return only recommendations with the specified status.

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) –
  
  If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions

BedrockAgentCore.Client.exceptions.AccessDeniedException
BedrockAgentCore.Client.exceptions.ValidationException
BedrockAgentCore.Client.exceptions.ThrottlingException
BedrockAgentCore.Client.exceptions.InternalServerException