bedrockagentcore/aws.sdk.kotlin.services.bedrockagentcore.model/StartBrowserSessionRequest/Builder

Builder

Properties

The unique identifier of the browser to use for this session. This identifier specifies which browser environment to initialize for the session.

certificates

var certificates: List<Certificate>?

A list of certificates to install in the browser session.

clientToken

var clientToken: String?

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.

enterprisePolicies

var enterprisePolicies: List<BrowserEnterprisePolicy>?

A list of files containing enterprise policies for the browser.

extensions

var extensions: List<BrowserExtension>?

A list of browser extensions to load into the browser session.

name

var name: String?

The name of the browser session. This name helps you identify and manage the session. The name does not need to be unique.

profileConfiguration

var profileConfiguration: BrowserProfileConfiguration?

The browser profile configuration to use for this session. A browser profile contains persistent data such as cookies and local storage that can be reused across multiple browser sessions. If specified, the session initializes with the profile's stored data, enabling continuity for tasks that require authentication or personalized settings.

proxyConfiguration

var proxyConfiguration: ProxyConfiguration?

Optional proxy configuration for routing browser traffic through customer-specified proxy servers. When provided, enables HTTP Basic authentication via Amazon Web Services Secrets Manager and domain-based routing rules. Requires secretsmanager:GetSecretValue IAM permission for the specified secret ARNs.

sessionTimeoutSeconds

var sessionTimeoutSeconds: Int?

The duration in seconds (time-to-live) after which the session automatically terminates, regardless of ongoing activity. Defaults to 3600 seconds (1 hour). Recommended minimum: 60 seconds. Maximum allowed: 28,800 seconds (8 hours).

traceId

var traceId: String?

The trace identifier for request tracking.

traceParent

var traceParent: String?

The parent trace information for distributed tracing.

viewPort

var viewPort: ViewPort?

The dimensions of the browser viewport for this session. This determines the visible area of the web content and affects how web pages are rendered. If not specified, Amazon Bedrock AgentCore uses a default viewport size.

Functions

profileConfiguration

fun profileConfiguration(block: BrowserProfileConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrockagentcore.model.BrowserProfileConfiguration inside the given block

proxyConfiguration

fun proxyConfiguration(block: ProxyConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrockagentcore.model.ProxyConfiguration inside the given block

viewPort

fun viewPort(block: ViewPort.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrockagentcore.model.ViewPort inside the given block