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

GetAgentRuntime

Gets an Amazon Secure Agent.

Request Syntax


GET /runtimes/agentRuntimeId/?version=agentRuntimeVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

agentRuntimeId

The unique identifier of the agent runtime to retrieve.

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

Required: Yes

agentRuntimeVersion

The version of the agent runtime to retrieve.

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

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "agentRuntimeArn": "string",
   "agentRuntimeArtifact": { ... },
   "agentRuntimeId": "string",
   "agentRuntimeName": "string",
   "agentRuntimeVersion": "string",
   "authorizerConfiguration": { ... },
   "createdAt": "string",
   "description": "string",
   "environmentVariables": { 
      "string" : "string" 
   },
   "lastUpdatedAt": "string",
   "networkConfiguration": { 
      "networkMode": "string"
   },
   "protocolConfiguration": { 
      "serverProtocol": "string"
   },
   "roleArn": "string",
   "status": "string",
   "workloadIdentityDetails": { 
      "workloadIdentityArn": "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.

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

agentRuntimeArtifact

The artifact of the agent runtime.

Type: AgentArtifact object

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

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}

agentRuntimeName

The name of the agent runtime.

Type: String

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

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

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.

createdAt

The timestamp when the agent runtime was created.

Type: Timestamp

description

The description of the agent runtime.

Type: String

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

environmentVariables

Environment variables 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.

lastUpdatedAt

The timestamp when the agent runtime was last updated.

Type: Timestamp

networkConfiguration

The network configuration for the agent runtime.

Type: NetworkConfiguration object

protocolConfiguration

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

Type: ProtocolConfiguration object

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/.+

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

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

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