Skip to content

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

Description

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

Usage

bedrockagentcore_list_recommendations(maxResults, nextToken,
  statusFilter)

Arguments

  • maxResults

    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

    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

    Optional filter to return only recommendations with the specified status.

Value

A list with the following syntax:

list(
  recommendationSummaries = list(
    list(
      recommendationId = "string",
      recommendationArn = "string",
      name = "string",
      description = "string",
      type = "SYSTEM_PROMPT_RECOMMENDATION"|"TOOL_DESCRIPTION_RECOMMENDATION",
      status = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"DELETING",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_recommendations(
  maxResults = 123,
  nextToken = "string",
  statusFilter = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"DELETING"
)