Interface StartBrowserSessionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockAgentCoreRequest.Builder, Buildable, CopyableBuilder<StartBrowserSessionRequest.Builder,StartBrowserSessionRequest>, SdkBuilder<StartBrowserSessionRequest.Builder,StartBrowserSessionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartBrowserSessionRequest
@Mutable @NotThreadSafe public static interface StartBrowserSessionRequest.Builder extends BedrockAgentCoreRequest.Builder, SdkPojo, CopyableBuilder<StartBrowserSessionRequest.Builder,StartBrowserSessionRequest>

  • Method Details

    • traceId

      StartBrowserSessionRequest.Builder traceId(String traceId)

      The trace identifier for request tracking.

      Parameters:
      traceId - The trace identifier for request tracking.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • traceParent

      StartBrowserSessionRequest.Builder traceParent(String traceParent)

      The parent trace information for distributed tracing.

      Parameters:
      traceParent - The parent trace information for distributed tracing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • browserIdentifier

      StartBrowserSessionRequest.Builder browserIdentifier(String browserIdentifier)

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

      Parameters:
      browserIdentifier - The unique identifier of the browser to use for this session. This identifier specifies which browser environment to initialize for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      StartBrowserSessionRequest.Builder name(String name)

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

      Parameters:
      name - The name of the browser session. This name helps you identify and manage the session. The name does not need to be unique.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionTimeoutSeconds

      StartBrowserSessionRequest.Builder sessionTimeoutSeconds(Integer sessionTimeoutSeconds)

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

      Parameters:
      sessionTimeoutSeconds - 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • viewPort

      StartBrowserSessionRequest.Builder viewPort(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • viewPort

      default StartBrowserSessionRequest.Builder viewPort(Consumer<ViewPort.Builder> 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.

      This is a convenience method that creates an instance of the ViewPort.Builder avoiding the need to create one manually via ViewPort.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to viewPort(ViewPort).

      Parameters:
      viewPort - a consumer that will call methods on ViewPort.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • extensions

      StartBrowserSessionRequest.Builder extensions(Collection<BrowserExtension> extensions)

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

      Parameters:
      extensions - A list of browser extensions to load into the browser session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • extensions

      StartBrowserSessionRequest.Builder extensions(BrowserExtension... extensions)

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

      Parameters:
      extensions - A list of browser extensions to load into the browser session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • extensions

      StartBrowserSessionRequest.Builder extensions(Consumer<BrowserExtension.Builder>... extensions)

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

      This is a convenience method that creates an instance of the BrowserExtension.Builder avoiding the need to create one manually via BrowserExtension.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to extensions(List<BrowserExtension>).

      Parameters:
      extensions - a consumer that will call methods on BrowserExtension.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • profileConfiguration

      StartBrowserSessionRequest.Builder profileConfiguration(BrowserProfileConfiguration profileConfiguration)

      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.

      Parameters:
      profileConfiguration - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • profileConfiguration

      default StartBrowserSessionRequest.Builder profileConfiguration(Consumer<BrowserProfileConfiguration.Builder> profileConfiguration)

      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.

      This is a convenience method that creates an instance of the BrowserProfileConfiguration.Builder avoiding the need to create one manually via BrowserProfileConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to profileConfiguration(BrowserProfileConfiguration).

      Parameters:
      profileConfiguration - a consumer that will call methods on BrowserProfileConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • proxyConfiguration

      StartBrowserSessionRequest.Builder proxyConfiguration(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proxyConfiguration

      default StartBrowserSessionRequest.Builder proxyConfiguration(Consumer<ProxyConfiguration.Builder> 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.

      This is a convenience method that creates an instance of the ProxyConfiguration.Builder avoiding the need to create one manually via ProxyConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to proxyConfiguration(ProxyConfiguration).

      Parameters:
      proxyConfiguration - a consumer that will call methods on ProxyConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enterprisePolicies

      StartBrowserSessionRequest.Builder enterprisePolicies(Collection<BrowserEnterprisePolicy> enterprisePolicies)

      A list of files containing enterprise policies for the browser.

      Parameters:
      enterprisePolicies - A list of files containing enterprise policies for the browser.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enterprisePolicies

      StartBrowserSessionRequest.Builder enterprisePolicies(BrowserEnterprisePolicy... enterprisePolicies)

      A list of files containing enterprise policies for the browser.

      Parameters:
      enterprisePolicies - A list of files containing enterprise policies for the browser.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enterprisePolicies

      StartBrowserSessionRequest.Builder enterprisePolicies(Consumer<BrowserEnterprisePolicy.Builder>... enterprisePolicies)

      A list of files containing enterprise policies for the browser.

      This is a convenience method that creates an instance of the BrowserEnterprisePolicy.Builder avoiding the need to create one manually via BrowserEnterprisePolicy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to enterprisePolicies(List<BrowserEnterprisePolicy>).

      Parameters:
      enterprisePolicies - a consumer that will call methods on BrowserEnterprisePolicy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • certificates

      StartBrowserSessionRequest.Builder certificates(Collection<Certificate> certificates)

      A list of certificates to install in the browser session.

      Parameters:
      certificates - A list of certificates to install in the browser session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • certificates

      StartBrowserSessionRequest.Builder certificates(Certificate... certificates)

      A list of certificates to install in the browser session.

      Parameters:
      certificates - A list of certificates to install in the browser session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • certificates

      StartBrowserSessionRequest.Builder certificates(Consumer<Certificate.Builder>... certificates)

      A list of certificates to install in the browser session.

      This is a convenience method that creates an instance of the Certificate.Builder avoiding the need to create one manually via Certificate.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to certificates(List<Certificate>).

      Parameters:
      certificates - a consumer that will call methods on Certificate.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      StartBrowserSessionRequest.Builder clientToken(String clientToken)

      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.

      Parameters:
      clientToken - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartBrowserSessionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartBrowserSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.