Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateBrowser

Creates a custom browser.

Request Syntax


PUT /browsers HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "executionRoleArn": "string",
   "name": "string",
   "networkConfiguration": { 
      "networkMode": "string"
   },
   "recording": { 
      "enabled": boolean,
      "s3Location": { 
         "bucket": "string",
         "prefix": "string"
      }
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

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

Type: String

Length Constraints: Minimum length of 33. Maximum length of 256.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

Required: No

description

The description of the browser.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

executionRoleArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+

Required: No

name

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

Type: String

Pattern: [a-zA-Z][a-zA-Z0-9_]{0,47}

Required: Yes

networkConfiguration

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

Type: BrowserNetworkConfiguration object

Required: Yes

recording

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

Type: RecordingConfig object

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "browserArn": "string",
   "browserId": "string",
   "createdAt": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

browserArn

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

Type: String

Pattern: arn:(-[^:]+)?: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})

browserId

The unique identifier of the created browser.

Type: String

Pattern: (aws\.browser\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})

createdAt

The timestamp when the browser was created.

Type: Timestamp

status

The current status of the browser.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ServiceQuotaExceededException

This exception is thrown when a request is made beyond the service quota

HTTP Status Code: 402

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400