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

StartCodeInterpreterSession

Creates and initializes a code interpreter session in Amazon Bedrock. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.

To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the StopCodeInterpreterSession operation.

The following operations are related to StartCodeInterpreterSession:

Request Syntax


PUT /code-interpreters/codeInterpreterIdentifier/sessions/start HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "name": "string",
   "sessionTimeoutSeconds": number
}

URI Request Parameters

The request uses the following URI parameters.

codeInterpreterIdentifier

The unique identifier of the code interpreter to use for this session. This identifier specifies which code interpreter environment to initialize for the session.

Required: Yes

Request Body

The request accepts the following data in JSON format.

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 ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.

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

name

The name of the code interpreter session. This name helps you identify and manage the session. The name does not need to be unique.

Type: String

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

Required: No

sessionTimeoutSeconds

The time in seconds after which the session automatically terminates if there is no activity. The default value is 3600 seconds (1 hour). The minimum allowed value is 60 seconds, and the maximum allowed value is 28800 seconds (8 hours).

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 28800.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "codeInterpreterIdentifier": "string",
   "createdAt": "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.

codeInterpreterIdentifier

The identifier of the code interpreter.

Type: String

createdAt

The time at which the code interpreter session was created.

Type: Timestamp

sessionId

The unique identifier of the created code interpreter session.

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

ServiceQuotaExceededException

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

HTTP Status Code: 402

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