List Agents

bedrockagent_list_agents

R Documentation

Lists the agents belonging to an account and information about each agent¶

Description¶

Lists the agents belonging to an account and information about each agent.

Usage¶

bedrockagent_list_agents(maxResults, nextToken)

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.

Value¶

A list with the following syntax:

list(
  agentSummaries = list(
    list(
      agentId = "string",
      agentName = "string",
      agentStatus = "CREATING"|"PREPARING"|"PREPARED"|"NOT_PREPARED"|"DELETING"|"FAILED"|"VERSIONING"|"UPDATING",
      description = "string",
      guardrailConfiguration = list(
        guardrailIdentifier = "string",
        guardrailVersion = "string"
      ),
      latestAgentVersion = "string",
      updatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_agents(
  maxResults = 123,
  nextToken = "string"
)