BedrockAgentCoreDataPlaneFrontingLayer / Client / get_browser_session

get_browser_session

BedrockAgentCoreDataPlaneFrontingLayer.Client.get_browser_session(**kwargs)

Retrieves detailed information about a specific browser session in Amazon Bedrock. This operation returns the session’s configuration, current status, associated streams, and metadata.

To get a browser session, you must specify both the browser identifier and the session ID. The response includes information about the session’s viewport configuration, timeout settings, and stream endpoints.

The following operations are related to GetBrowserSession:

See also: AWS API Documentation

Request Syntax

response = client.get_browser_session(
    browserIdentifier='string',
    sessionId='string'
)
Parameters:

  • browserIdentifier (string) –

    [REQUIRED]

    The unique identifier of the browser associated with the session.

  • sessionId (string) –

    [REQUIRED]

    The unique identifier of the browser session to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'browserIdentifier': 'string',
    'sessionId': 'string',
    'name': 'string',
    'createdAt': datetime(2015, 1, 1),
    'viewPort': {
        'width': 123,
        'height': 123
    },
    'sessionTimeoutSeconds': 123,
    'status': 'READY'|'TERMINATED',
    'streams': {
        'automationStream': {
            'streamEndpoint': 'string',
            'streamStatus': 'ENABLED'|'DISABLED'
        },
        'liveViewStream': {
            'streamEndpoint': 'string'
        }
    },
    'sessionReplayArtifact': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • browserIdentifier (string) –

      The identifier of the browser.

    • sessionId (string) –

      The identifier of the browser session.

    • name (string) –

      The name of the browser session.

    • createdAt (datetime) –

      The time at which the browser session was created.

    • viewPort (dict) –

      The configuration that defines the dimensions of a browser viewport in a browser session. The viewport determines the visible area of web content and affects how web pages are rendered and displayed. Proper viewport configuration ensures that web content is displayed correctly for the agent’s browsing tasks.

      • width (integer) –

        The width of the viewport in pixels. This value determines the horizontal dimension of the visible area. Valid values range from 800 to 1920 pixels.

      • height (integer) –

        The height of the viewport in pixels. This value determines the vertical dimension of the visible area. Valid values range from 600 to 1080 pixels.

    • sessionTimeoutSeconds (integer) –

      The timeout period for the browser session in seconds.

    • status (string) –

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

    • streams (dict) –

      The streams associated with this browser session. These include the automation stream and live view stream.

      • automationStream (dict) –

        The stream that enables programmatic control of the browser. This stream allows agents to perform actions such as navigating to URLs, clicking elements, and filling forms.

        • streamEndpoint (string) –

          The endpoint URL for the automation stream. This URL is used to establish a WebSocket connection to the stream for sending commands and receiving responses.

        • streamStatus (string) –

          The current status of the automation stream. This indicates whether the stream is available for use. Possible values include ACTIVE, CONNECTING, and DISCONNECTED.

      • liveViewStream (dict) –

        The stream that provides a visual representation of the browser content. This stream allows agents to observe the current state of the browser, including rendered web pages and visual elements.

        • streamEndpoint (string) –

          The endpoint URL for the live view stream. This URL is used to establish a connection to receive visual updates from the browser session.

    • sessionReplayArtifact (string) –

      The artifact containing the session replay information.

    • lastUpdatedAt (datetime) –

      The time at which the browser session was last updated.

Exceptions