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

CreateCodeInterpreter

Creates a custom code interpreter.

Request Syntax


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

{
   "certificates": [ 
      { 
         "location": { ... }
      }
   ],
   "clientToken": "string",
   "description": "string",
   "executionRoleArn": "string",
   "filesystemConfigurations": [ 
      { ... }
   ],
   "name": "string",
   "networkConfiguration": { 
      "networkMode": "string",
      "vpcConfig": { 
         "requireServiceS3Endpoint": boolean,
         "securityGroups": [ "string" ],
         "subnets": [ "string" ]
      }
   },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

certificates

A list of certificates to install in the code interpreter.

Type: Array of Certificate objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

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 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

description

The description of the code interpreter.

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 code interpreter 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

filesystemConfigurations

The file system configurations to mount into the code interpreter. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your sessions can then access your data. If you don't specify this field, no file systems are mounted.

Type: Array of ToolsFileSystemConfiguration objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

name

The name of the code interpreter. 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 code interpreter. This configuration specifies the network mode for the code interpreter.

Type: CodeInterpreterNetworkConfiguration object

Required: Yes

tags

A map of tag keys and values to assign to the code interpreter. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [a-zA-Z0-9\s._:/=+@-]*

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: [a-zA-Z0-9\s._:/=+@-]*

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "codeInterpreterArn": "string",
   "codeInterpreterId": "string",
   "createdAt": "string",
   "status": "string"
}

Response Elements

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

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

codeInterpreterArn

The Amazon Resource Name (ARN) of the created code interpreter.

Type: String

Pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\.codeinterpreter\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})

codeInterpreterId

The unique identifier of the created code interpreter.

Type: String

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

createdAt

The timestamp when the code interpreter was created.

Type: Timestamp

status

The current status of the code interpreter.

Type: String

Errors

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

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