browsers
Creates, updates, deletes, gets or lists a browsers resource.
Overview
| Name | browsers |
| Type | Resource |
| Id | aws.bedrock_agentcore_control.browsers |
Fields
The following fields are returned by SELECT queries:
- get_browser
- list_browsers
| Name | Datatype | Description |
|---|---|---|
name | string | The name of the browser. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,47}</code>) |
browser_arn | string | The 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_id | string | The 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_signing | object | The browser signing configuration that shows whether cryptographic agent identification is enabled for web bot authentication. |
certificates | array | The list of certificates configured for the browser. |
created_at | string (date-time) | The timestamp when the browser was created. |
description | string | The description of the browser. |
enterprise_policies | array | The list of enterprise policy files configured for the browser. |
execution_role_arn | string | The IAM role ARN that provides permissions for the browser. (pattern: <code>arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+</code>) |
failure_reason | string | The reason for failure if the browser is in a failed state. |
filesystem_configurations | array | The 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_at | string (date-time) | The timestamp when the browser was last updated. |
network_configuration | object | The network configuration for a browser. This structure defines how the browser connects to the network. |
recording | object | The recording configuration for a browser. This structure defines how browser sessions are recorded. |
status | string | The current status of the browser. (CREATING, CREATE_FAILED, READY, DELETING, DELETE_FAILED, DELETED) |
| Name | Datatype | Description |
|---|---|---|
name | string | The name of the browser. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,47}</code>) |
browser_arn | string | The 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_id | string | The 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>) |
created_at | string (date-time) | The timestamp when the browser was created. |
description | string | The description of the browser. |
last_updated_at | string (date-time) | The timestamp when the browser was last updated. |
status | string | The current status of the browser. (CREATING, CREATE_FAILED, READY, DELETING, DELETE_FAILED, DELETED) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_browser | select | browser_id, region | Gets information about a custom browser. | |
list_browsers | select | region | maxResults, nextToken, type | Lists all custom browsers in your account. |
create_browser | insert | region, name, networkConfiguration | Creates a custom browser. | |
delete_browser | delete | browser_id, region | clientToken | Deletes 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.
| Name | Datatype | Description |
|---|---|---|
browser_id | string | The unique identifier of the browser to delete. |
region | string | AWS region (default: us-east-1) |
clientToken | string | A unique, case-sensitive identifier to ensure idempotency of the request. |
maxResults | integer | The maximum number of results to return in a single call. The default value is 10. The maximum value is 50. |
nextToken | string | The 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. |
type | string | The type of browsers to list. If not specified, all browser types are returned. |
SELECT examples
- get_browser
- list_browsers
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
;
Lists all custom browsers in your account.
SELECT
name,
browser_arn,
browser_id,
created_at,
description,
last_updated_at,
status
FROM aws.bedrock_agentcore_control.browsers
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND type = '{{ type }}'
;
INSERT examples
- create_browser
- Manifest
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
;
# Description fields are for documentation purposes
- name: browsers
props:
- name: region
value: "{{ region }}"
description: Required parameter for the browsers resource.
- name: name
value: "{{ name }}"
- name: description
value: "{{ description }}"
- name: executionRoleArn
value: "{{ executionRoleArn }}"
- name: networkConfiguration
description: |
The network configuration for a browser. This structure defines how the browser connects to the network.
value:
networkMode: "{{ networkMode }}"
vpcConfig:
securityGroups:
- "{{ securityGroups }}"
subnets:
- "{{ subnets }}"
requireServiceS3Endpoint: {{ requireServiceS3Endpoint }}
- name: recording
description: |
The recording configuration for a browser. This structure defines how browser sessions are recorded.
value:
enabled: {{ enabled }}
s3Location:
bucket: "{{ bucket }}"
prefix: "{{ prefix }}"
versionId: "{{ versionId }}"
- name: browserSigning
description: |
Configuration for enabling browser signing capabilities that allow agents to cryptographically identify themselves to websites using HTTP message signatures.
value:
enabled: {{ enabled }}
- name: enterprisePolicies
value:
- location:
s3:
bucket: "{{ bucket }}"
prefix: "{{ prefix }}"
versionId: "{{ versionId }}"
type_: "{{ type_ }}"
- name: certificates
value:
- location:
secretsManager:
secretArn: "{{ secretArn }}"
- name: filesystemConfigurations
description: |
The 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.
value:
- s3FilesConfiguration:
accessPointArn: "{{ accessPointArn }}"
mountPath: "{{ mountPath }}"
fileSystemArn: "{{ fileSystemArn }}"
efsConfiguration:
accessPointArn: "{{ accessPointArn }}"
mountPath: "{{ mountPath }}"
fileSystemArn: "{{ fileSystemArn }}"
- name: clientToken
value: "{{ clientToken }}"
- name: tags
value: "{{ tags }}"
DELETE examples
- delete_browser
Deletes a custom browser.
DELETE FROM aws.bedrock_agentcore_control.browsers
WHERE browser_id = '{{ browser_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;