Class: Aws::BedrockAgentCore::Types::StartBrowserSessionRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCore::Types::StartBrowserSessionRequest

Defined in:

gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #browser_identifier ⇒ String

  The unique identifier of the browser to use for this session.

• #certificates ⇒ Array<Types::Certificate>

  A list of certificates to install in the browser session.

• #client_token ⇒ String

  A unique, case-sensitive identifier to ensure that the API request completes no more than one time.

• #enterprise_policies ⇒ Array<Types::BrowserEnterprisePolicy>

  A list of files containing enterprise policies for the browser.

• #extensions ⇒ Array<Types::BrowserExtension>

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

• #name ⇒ String

  The name of the browser session.

• #profile_configuration ⇒ Types::BrowserProfileConfiguration

  The browser profile configuration to use for this session.

• #proxy_configuration ⇒ Types::ProxyConfiguration

  Optional proxy configuration for routing browser traffic through customer-specified proxy servers.

• #session_timeout_seconds ⇒ Integer

  The duration in seconds (time-to-live) after which the session automatically terminates, regardless of ongoing activity.

• #trace_id ⇒ String

  The trace identifier for request tracking.

• #trace_parent ⇒ String

  The parent trace information for distributed tracing.

• #view_port ⇒ Types::ViewPort

  The dimensions of the browser viewport for this session.

Instance Attribute Details

#browser_identifier ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#certificates ⇒ Array<Types::Certificate>

A list of certificates to install in the browser session.

Returns:

• (Array<Types::Certificate>)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ 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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#enterprise_policies ⇒ Array<Types::BrowserEnterprisePolicy>

A list of files containing enterprise policies for the browser.

Returns:

• (Array<Types::BrowserEnterprisePolicy>)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#extensions ⇒ Array<Types::BrowserExtension>

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

Returns:

• (Array<Types::BrowserExtension>)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#profile_configuration ⇒ Types::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.

Returns:

• (Types::BrowserProfileConfiguration)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#proxy_configuration ⇒ Types::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:

• (Types::ProxyConfiguration)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#session_timeout_seconds ⇒ Integer

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:

• (Integer)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#trace_id ⇒ String

The trace identifier for request tracking.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#trace_parent ⇒ String

The parent trace information for distributed tracing.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#view_port ⇒ Types::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:

• (Types::ViewPort)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4601

class StartBrowserSessionRequest < Struct.new(
  :trace_id,
  :trace_parent,
  :browser_identifier,
  :name,
  :session_timeout_seconds,
  :view_port,
  :extensions,
  :profile_configuration,
  :proxy_configuration,
  :enterprise_policies,
  :certificates,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end