GetBrowser - Amazon Bedrock AgentCore Control
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetBrowser

Gets information about a custom browser.

Request Syntax

GET /browsers/browserId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

browserId

The unique identifier of the browser to retrieve.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "browserArn": "string",
   "browserId": "string",
   "createdAt": "string",
   "description": "string",
   "executionRoleArn": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "networkConfiguration": { 
      "networkMode": "string"
   },
   "recording": { 
      "enabled": boolean,
      "s3Location": { 
         "bucket": "string",
         "prefix": "string"
      }
   },
   "status": "string"
}

Response Elements

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

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

browserArn

The Amazon Resource Name (ARN) of the 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 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

description

The description of the browser.

Type: String

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

executionRoleArn

The IAM role ARN that provides permissions for the browser.

Type: String

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

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

lastUpdatedAt

The timestamp when the browser was last updated.

Type: Timestamp

name

The name of the browser.

Type: String

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

networkConfiguration

The network configuration for a browser. This structure defines how the browser connects to the network.

Type: BrowserNetworkConfiguration object

recording

The recording configuration for a browser. This structure defines how browser sessions are recorded.

Type: RecordingConfig object

status

The current status of the browser.

Type: String

Valid Values: CREATING | CREATE_FAILED | READY | DELETING | DELETE_FAILED | DELETED

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

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: