Package software.amazon.awssdk.services.bedrockagentcore.model

Class StartBrowserSessionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest
software.amazon.awssdk.services.bedrockagentcore.model.StartBrowserSessionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartBrowserSessionRequest.Builder,StartBrowserSessionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartBrowserSessionRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<StartBrowserSessionRequest.Builder,StartBrowserSessionRequest>

  • Method Details

    • traceId

      public final String traceId()

      The trace identifier for request tracking.

      Returns:
      The trace identifier for request tracking.

    • traceParent

      public final String traceParent()

      The parent trace information for distributed tracing.

      Returns:
      The parent trace information for distributed tracing.

    • browserIdentifier

      public final String browserIdentifier()

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

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

    • name

      public final 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.

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

    • sessionTimeoutSeconds

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

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

    • viewPort

      public final 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.

      Returns:
      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.

    • hasExtensions

      public final boolean hasExtensions()
      For responses, this returns true if the service returned a value for the Extensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • extensions

      public final List<BrowserExtension> extensions()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExtensions() method.

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

    • profileConfiguration

      public final 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.

      Returns:
      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

      public final 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.

      Returns:
      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.

    • hasEnterprisePolicies

      public final boolean hasEnterprisePolicies()
      For responses, this returns true if the service returned a value for the EnterprisePolicies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • enterprisePolicies

      public final List<BrowserEnterprisePolicy> enterprisePolicies()

      A list of files containing enterprise policies for the browser.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnterprisePolicies() method.

      Returns:
      A list of files containing enterprise policies for the browser.

    • hasCertificates

      public final boolean hasCertificates()
      For responses, this returns true if the service returned a value for the Certificates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • certificates

      public final List<Certificate> certificates()

      A list of certificates to install in the browser session.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCertificates() method.

      Returns:
      A list of certificates to install in the browser session.

    • clientToken

      public final 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.

      Returns:
      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.

    • toBuilder

      public StartBrowserSessionRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartBrowserSessionRequest.Builder,StartBrowserSessionRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest

    • builder

      public static StartBrowserSessionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartBrowserSessionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo