BedrockAgentCoreDataPlaneFrontingLayer / Client / list_browser_sessions

list_browser_sessions

BedrockAgentCoreDataPlaneFrontingLayer.Client.list_browser_sessions(**kwargs)

Retrieves a list of browser sessions in Amazon Bedrock 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 ListBrowserSessions:

See also: AWS API Documentation

Request Syntax

response = client.list_browser_sessions(
    browserIdentifier='string',
    maxResults=123,
    nextToken='string',
    status='READY'|'TERMINATED'
)
Parameters:

  • browserIdentifier (string) –

    [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 (integer) – 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 (string) – 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 returns the first page of results.

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

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'browserIdentifier': 'string',
            'sessionId': 'string',
            'name': 'string',
            'status': 'READY'|'TERMINATED',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The list of browser sessions that match the specified criteria.

      • (dict) –

        A condensed representation of a browser session in Amazon Bedrock. This structure contains key information about a browser session, including identifiers, status, and timestamps, without the full details of the session configuration and streams.

        • browserIdentifier (string) –

          The unique identifier of the browser associated with the session. This identifier specifies which browser environment is used for the session.

        • sessionId (string) –

          The unique identifier of the browser session. This identifier is used in operations that interact with the session.

        • name (string) –

          The name of the browser session. This name helps identify and manage the session.

        • status (string) –

          The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.

        • createdAt (datetime) –

          The timestamp when the browser session was created. This value is in ISO 8601 format.

        • lastUpdatedAt (datetime) –

          The timestamp when the browser session was last updated. This value is in ISO 8601 format.

    • nextToken (string) –

      The token to use in a subsequent ListBrowserSessions request to get the next set of results.

Exceptions

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.AccessDeniedException

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ValidationException

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ResourceNotFoundException

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ThrottlingException

  • BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.InternalServerException