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

CreateAgentRuntime

Creates an Amazon Secure Agent.

Request Syntax


PUT /runtimes/ HTTP/1.1
Content-type: application/json

{
   "agentRuntimeArtifact": { ... },
   "agentRuntimeName": "string",
   "authorizerConfiguration": { ... },
   "clientToken": "string",
   "description": "string",
   "environmentVariables": { 
      "string" : "string" 
   },
   "networkConfiguration": { 
      "networkMode": "string"
   },
   "protocolConfiguration": { 
      "serverProtocol": "string"
   },
   "roleArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

agentRuntimeArtifact

The artifact of the agent.

Type: AgentArtifact object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

agentRuntimeName

The name of the secure agent.

Type: String

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

Required: Yes

authorizerConfiguration

The authorizer configuration for the agent runtime.

Type: AuthorizerConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

clientToken

A unique, case-sensitive identifier to ensure idempotency of the request.

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 agent runtime.

Type: String

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

Required: No

environmentVariables

Environment variables to set in the agent runtime 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 100.

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

Required: No

networkConfiguration

The network configuration for the agent runtime.

Type: NetworkConfiguration object

Required: Yes

protocolConfiguration

The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.

Type: ProtocolConfiguration object

Required: No

roleArn

The IAM role ARN that provides permissions for the agent runtime.

Type: String

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

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

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "agentRuntimeArn": "string",
   "agentRuntimeId": "string",
   "agentRuntimeVersion": "string",
   "createdAt": "string",
   "status": "string",
   "workloadIdentityDetails": { 
      "workloadIdentityArn": "string"
   }
}

Response Elements

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

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

agentRuntimeArn

The Amazon Resource Name (ARN) of the agent runtime.

Type: String

Pattern: arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:agent/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}:([0-9]{0,4}[1-9][0-9]{0,4})

agentRuntimeId

The unique identifier of the agent runtime.

Type: String

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

agentRuntimeVersion

The version of the agent runtime.

Type: String

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

Pattern: ([1-9][0-9]{0,4})

createdAt

The timestamp when the agent runtime was created.

Type: Timestamp

status

The current status of the agent runtime.

Type: String

workloadIdentityDetails

The workload identity details for the agent runtime.

Type: WorkloadIdentityDetails object

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

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