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

SaveBrowserSessionProfile

Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore. A browser profile captures persistent browser data such as cookies and local storage from an active session, enabling you to reuse this data in future browser sessions.

To save a browser session profile, you must specify the profile identifier, browser identifier, and session ID. The session must be active when saving the profile. Once saved, the profile can be used with the StartBrowserSession operation to initialize new sessions with the stored browser state.

Browser profiles are useful for scenarios that require persistent authentication, maintaining user preferences across sessions, or continuing tasks that depend on previously stored browser data.

The following operations are related to SaveBrowserSessionProfile:

Request Syntax


PUT /browser-profiles/profileIdentifier/save HTTP/1.1
X-Amzn-Trace-Id: traceId
traceparent: traceParent
Content-type: application/json

{
   "browserIdentifier": "string",
   "clientToken": "string",
   "sessionId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

profileIdentifier

The unique identifier for the browser profile. This identifier is used to reference the profile when starting new browser sessions. The identifier must follow the pattern of an alphanumeric name (up to 48 characters) followed by a hyphen and a 10-character alphanumeric suffix.

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

Required: Yes

traceId

The trace identifier for request tracking.

Length Constraints: Minimum length of 0. Maximum length of 1024.

traceParent

The parent trace information for distributed tracing.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Request Body

The request accepts the following data in JSON format.

browserIdentifier

The unique identifier of the browser associated with the session from which to save the profile.

Type: String

Required: Yes

clientToken

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore 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

sessionId

The unique identifier of the browser session from which to save the profile. The session must be active when saving the profile.

Type: String

Pattern: [0-9a-zA-Z]{1,40}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "browserIdentifier": "string",
   "lastUpdatedAt": "string",
   "profileIdentifier": "string",
   "sessionId": "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.

browserIdentifier

The unique identifier of the browser associated with the session from which the profile was saved.

Type: String

lastUpdatedAt

The timestamp when the browser profile was last updated. This value is in ISO 8601 format.

Type: Timestamp

profileIdentifier

The unique identifier of the saved browser profile.

Type: String

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

sessionId

The unique identifier of the browser session from which the profile was saved.

Type: String

Pattern: [0-9a-zA-Z]{1,40}

Errors

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

AccessDeniedException

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

HTTP Status Code: 403

ConflictException

The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

HTTP Status Code: 409

InternalServerException

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

HTTP Status Code: 500

ResourceNotFoundException

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

HTTP Status Code: 404

ThrottlingException

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

HTTP Status Code: 429

ValidationException

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

HTTP Status Code: 400