Skip to content

create_browser

Operation

create_browser

create_browser(request: CreateBrowserInput | CreateBrowserInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateBrowserInputDict]) -> CreateBrowserOutput

Creates a custom browser.

Parameters:

Name Type Description Default
request CreateBrowserInput | CreateBrowserInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateBrowserInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateBrowserOutput

An instance of CreateBrowserOutput.

create_browser async

create_browser(request: CreateBrowserInput | CreateBrowserInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateBrowserInputDict]) -> CreateBrowserOutput

Creates a custom browser.

Parameters:

Name Type Description Default
request CreateBrowserInput | CreateBrowserInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateBrowserInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateBrowserOutput

An instance of CreateBrowserOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateBrowserInputDict

Bases: TypedDict

Dictionary form of CreateBrowserInput.

Attributes

browser_signing instance-attribute

The browser signing configuration that enables cryptographic agent identification using HTTP message signatures for web bot authentication.

certificates instance-attribute
certificates: Sequence[Certificate | CertificateDict] | None

A list of certificates to install in the browser.

client_token instance-attribute
client_token: str | None

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 AgentCore ignores the request but does not return an error.

This field is autopopulated if not provided.

description instance-attribute
description: str | None

The description of the browser.

enterprise_policies instance-attribute

A list of enterprise policy files for the browser.

execution_role_arn instance-attribute
execution_role_arn: str | None

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the browser to access Amazon Web Services services.

filesystem_configurations instance-attribute

The file system configurations to mount into the browser. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your sessions can then access your data. If you don't specify this field, no file systems are mounted.

name instance-attribute
name: Required[str]

The name of the browser. The name must be unique within your account.

network_configuration instance-attribute

The network configuration for the browser. This configuration specifies the network mode for the browser.

recording instance-attribute

The recording configuration for the browser. When enabled, browser sessions are recorded and stored in the specified Amazon S3 location.

tags instance-attribute
tags: Mapping[str, str] | None

A map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

CreateBrowserInput dataclass

Bases: _SerdeShape

Dataclass for CreateBrowserInput structure.

Attributes

browser_signing class-attribute instance-attribute
browser_signing: BrowserSigningConfigInput | None = ...

The browser signing configuration that enables cryptographic agent identification using HTTP message signatures for web bot authentication.

certificates class-attribute instance-attribute
certificates: list[Certificate] | None = ...

A list of certificates to install in the browser.

client_token class-attribute instance-attribute
client_token: str | None = ...

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 AgentCore ignores the request but does not return an error.

This field is autopopulated if not provided.

description class-attribute instance-attribute
description: str | None = ...

The description of the browser.

enterprise_policies class-attribute instance-attribute
enterprise_policies: list[BrowserEnterprisePolicy] | None = ...

A list of enterprise policy files for the browser.

execution_role_arn class-attribute instance-attribute
execution_role_arn: str | None = ...

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the browser to access Amazon Web Services services.

filesystem_configurations class-attribute instance-attribute
filesystem_configurations: list[ToolsFileSystemConfiguration] | None = ...

The file system configurations to mount into the browser. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your sessions can then access your data. If you don't specify this field, no file systems are mounted.

name class-attribute instance-attribute
name: str | None = ...

The name of the browser. The name must be unique within your account.

network_configuration class-attribute instance-attribute
network_configuration: BrowserNetworkConfiguration | None = ...

The network configuration for the browser. This configuration specifies the network mode for the browser.

recording class-attribute instance-attribute
recording: RecordingConfig | None = ...

The recording configuration for the browser. When enabled, browser sessions are recorded and stored in the specified Amazon S3 location.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

A map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Output

CreateBrowserOutput dataclass

Bases: _SerdeShape

Dataclass for CreateBrowserOutput structure.

Attributes

browser_arn instance-attribute
browser_arn: str

The Amazon Resource Name (ARN) of the created browser.

browser_id instance-attribute
browser_id: str

The unique identifier of the created browser.

created_at instance-attribute
created_at: datetime

The timestamp when the browser was created.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status instance-attribute
status: str

The current status of the browser.