Skip to content

Bedrock AgentCore  >  Operations  >  list_recommendations

list_recommendations

Operation

list_recommendations async 

list_recommendations(input: ListRecommendationsInput, plugins: list[Plugin] | None = None) -> ListRecommendationsOutput

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

Parameters:

Name Type Description Default
input ListRecommendationsInput

An instance of ListRecommendationsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ListRecommendationsOutput

An instance of ListRecommendationsOutput.

Input

ListRecommendationsInput dataclass

Dataclass for ListRecommendationsInput structure.

Attributes

max_results class-attribute instance-attribute 
max_results: int | None = None

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.

next_token class-attribute instance-attribute 
next_token: str | None = None

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.

status_filter class-attribute instance-attribute 
status_filter: str | None = None

Optional filter to return only recommendations with the specified status.

Output

ListRecommendationsOutput dataclass

Dataclass for ListRecommendationsOutput structure.

Attributes

next_token class-attribute instance-attribute 
next_token: str | None = None

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.

recommendation_summaries instance-attribute 
recommendation_summaries: list[RecommendationSummary]

The list of recommendation summaries.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.