List Browser Sessions

bedrockagentcore_list_browser_sessions

R Documentation

Retrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria¶

Description¶

Retrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.

You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently.

We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.

The following operations are related to list_browser_sessions:

start_browser_session
get_browser_session

Usage¶

bedrockagentcore_list_browser_sessions(browserIdentifier, maxResults,
  nextToken, status)

Arguments¶

browserIdentifier

[required] The unique identifier of the browser to list sessions for. If specified, only sessions for this browser are returned. If not specified, sessions for all browsers are returned.

maxResults

The maximum number of results to return in a single call. The default value is 10. Valid values range from 1 to 100. To retrieve the remaining results, make another call with the returned nextToken value.

nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. If not specified, Amazon Bedrock AgentCore returns the first page of results.

status

The status of the browser sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.

Value¶

A list with the following syntax:

list(
  items = list(
    list(
      browserIdentifier = "string",
      sessionId = "string",
      name = "string",
      status = "READY"|"TERMINATED",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_browser_sessions(
  browserIdentifier = "string",
  maxResults = 123,
  nextToken = "string",
  status = "READY"|"TERMINATED"
)