Skip to main content

browsers

Creates, updates, deletes, gets or lists a browsers resource.

Overview

Namebrowsers
TypeResource
Idaws.bedrock_agentcore_control.browsers

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe name of the browser. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,47}</code>)
browser_arnstringThe Amazon Resource Name (ARN) of the browser. (pattern: <code>arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws.browser.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})</code>)
browser_idstringThe unique identifier of the browser. (pattern: <code>(aws.browser.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})</code>)
browser_signingobjectThe browser signing configuration that shows whether cryptographic agent identification is enabled for web bot authentication.
certificatesarrayThe list of certificates configured for the browser.
created_atstring (date-time)The timestamp when the browser was created.
descriptionstringThe description of the browser.
enterprise_policiesarrayThe list of enterprise policy files configured for the browser.
execution_role_arnstringThe IAM role ARN that provides permissions for the browser. (pattern: <code>arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+</code>)
failure_reasonstringThe reason for failure if the browser is in a failed state.
filesystem_configurationsarrayThe file system configurations to mount into the session. Each configuration maps an access point to a path inside the session. You can specify up to 4 configurations. The maximum is 2 Amazon Simple Storage Service (Amazon S3) Files access points and 2 Amazon Elastic File System (Amazon EFS) access points.
last_updated_atstring (date-time)The timestamp when the browser was last updated.
network_configurationobjectThe network configuration for a browser. This structure defines how the browser connects to the network.
recordingobjectThe recording configuration for a browser. This structure defines how browser sessions are recorded.
statusstringThe current status of the browser. (CREATING, CREATE_FAILED, READY, DELETING, DELETE_FAILED, DELETED)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_browserselectbrowser_id, regionGets information about a custom browser.
list_browsersselectregionmaxResults, nextToken, typeLists all custom browsers in your account.
create_browserinsertregion, name, networkConfigurationCreates a custom browser.
delete_browserdeletebrowser_id, regionclientTokenDeletes a custom browser.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
browser_idstringThe unique identifier of the browser to delete.
regionstringAWS region (default: us-east-1)
clientTokenstringA unique, case-sensitive identifier to ensure idempotency of the request.
maxResultsintegerThe maximum number of results to return in a single call. The default value is 10. The maximum value is 50.
nextTokenstringThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
typestringThe type of browsers to list. If not specified, all browser types are returned.

SELECT examples

Gets information about a custom browser.

SELECT
name,
browser_arn,
browser_id,
browser_signing,
certificates,
created_at,
description,
enterprise_policies,
execution_role_arn,
failure_reason,
filesystem_configurations,
last_updated_at,
network_configuration,
recording,
status
FROM aws.bedrock_agentcore_control.browsers
WHERE browser_id = '{{ browser_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

Creates a custom browser.

INSERT INTO aws.bedrock_agentcore_control.browsers (
name,
description,
executionRoleArn,
networkConfiguration,
recording,
browserSigning,
enterprisePolicies,
certificates,
filesystemConfigurations,
clientToken,
tags,
region
)
SELECT
'{{ name }}' /* required */,
'{{ description }}',
'{{ executionRoleArn }}',
'{{ networkConfiguration }}' /* required */,
'{{ recording }}',
'{{ browserSigning }}',
'{{ enterprisePolicies }}',
'{{ certificates }}',
'{{ filesystemConfigurations }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
browser_arn,
browser_id,
created_at,
status
;

DELETE examples

Deletes a custom browser.

DELETE FROM aws.bedrock_agentcore_control.browsers
WHERE browser_id = '{{ browser_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;