Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-agentcore-control ]

create-browser

Description

Creates a custom browser.

See also: AWS API Documentation

Synopsis

  create-browser
--name <value>
[--description <value>]
[--execution-role-arn <value>]
--network-configuration <value>
[--recording <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--name (string)

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

--description (string)

The description of the browser.

--execution-role-arn (string)

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

--network-configuration (structure)

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

networkMode -> (string)

The network mode for the browser. This field specifies how the browser connects to the network.

Shorthand Syntax:

networkMode=string

JSON Syntax:

{
  "networkMode": "PUBLIC"
}

--recording (structure)

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

enabled -> (boolean)

Indicates whether recording is enabled for the browser. When set to true, browser sessions are recorded.

s3Location -> (structure)

The Amazon S3 location where browser recordings are stored. This location contains the recorded browser sessions.

bucket -> (string)

The name of the Amazon S3 bucket. This bucket contains the stored data.

prefix -> (string)

The prefix for objects in the Amazon S3 bucket. This prefix is added to the object keys to organize the data.

Shorthand Syntax:

enabled=boolean,s3Location={bucket=string,prefix=string}

JSON Syntax:

{
  "enabled": true|false,
  "s3Location": {
    "bucket": "string",
    "prefix": "string"
  }
}

--client-token (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

browserId -> (string)

The unique identifier of the created browser.

browserArn -> (string)

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

createdAt -> (timestamp)

The timestamp when the browser was created.

status -> (string)

The current status of the browser.