BedrockAgentCoreDataPlaneFrontingLayer / Client / update_browser_stream

update_browser_stream

BedrockAgentCoreDataPlaneFrontingLayer.Client.update_browser_stream(**kwargs)

Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.

See also: AWS API Documentation

Request Syntax

response = client.update_browser_stream(
    browserIdentifier='string',
    sessionId='string',
    streamUpdate={
        'automationStreamUpdate': {
            'streamStatus': 'ENABLED'|'DISABLED'
        }
    },
    clientToken='string'
)
Parameters:

  • browserIdentifier (string) –

    [REQUIRED]

    The identifier of the browser.

  • sessionId (string) –

    [REQUIRED]

    The identifier of the browser session.

  • streamUpdate (dict) –

    [REQUIRED]

    The update to apply to the browser stream.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: automationStreamUpdate.

    • automationStreamUpdate (dict) –

      The update to an automation stream.

      • streamStatus (string) –

        The status of the automation stream.

  • clientToken (string) –

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'browserIdentifier': 'string',
    'sessionId': 'string',
    'streams': {
        'automationStream': {
            'streamEndpoint': 'string',
            'streamStatus': 'ENABLED'|'DISABLED'
        },
        'liveViewStream': {
            'streamEndpoint': 'string'
        }
    },
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • browserIdentifier (string) –

      The identifier of the browser.

    • sessionId (string) –

      The identifier of the browser session.

    • streams (dict) –

      The collection of streams associated with a browser session in Amazon Bedrock. These streams provide different ways to interact with and observe the browser session, including programmatic control and visual representation of the browser content.

      • 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.

    • updatedAt (datetime) –

      The time at which the browser stream was updated.

Exceptions