Skip to content

list_recommendations

Operation

list_recommendations

list_recommendations(request: ListRecommendationsInput | ListRecommendationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRecommendationsInputDict]) -> ListRecommendationsOutput

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

Parameters:

Name Type Description Default
request ListRecommendationsInput | ListRecommendationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListRecommendationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListRecommendationsOutput

An instance of ListRecommendationsOutput.

list_recommendations async

list_recommendations(request: ListRecommendationsInput | ListRecommendationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRecommendationsInputDict]) -> ListRecommendationsOutput

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

Parameters:

Name Type Description Default
request ListRecommendationsInput | ListRecommendationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListRecommendationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListRecommendationsOutput

An instance of ListRecommendationsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListRecommendationsInputDict

Bases: TypedDict

Dictionary form of ListRecommendationsInput.

Attributes

max_results instance-attribute
max_results: int | 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 instance-attribute
next_token: str | 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 instance-attribute
status_filter: str | None

Optional filter to return only recommendations with the specified status.

ListRecommendationsInput dataclass

Bases: _SerdeShape

Dataclass for ListRecommendationsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | 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 = ...

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 = ...

Optional filter to return only recommendations with the specified status.

Output

ListRecommendationsOutput dataclass

Bases: _SerdeShape

Dataclass for ListRecommendationsOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | 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 = ...

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.