View a markdown version of this page

AgentRuntimeEndpoint - Amazon Bedrock AgentCore Control Plane
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AgentRuntimeEndpoint

Contains information about an agent runtime endpoint. An endpoint provides a way to connect to and interact with an agent runtime.

Contents

agentRuntimeArn

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

Type: String

Pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}

Required: Yes

agentRuntimeEndpointArn

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

Type: String

Pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}/runtime-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47}

Required: Yes

createdAt

The timestamp when the agent runtime endpoint was created.

Type: Timestamp

Required: Yes

id

The unique identifier of the agent runtime endpoint.

Type: String

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

Required: Yes

lastUpdatedAt

The timestamp when the agent runtime endpoint was last updated.

Type: Timestamp

Required: Yes

name

The name of the agent runtime endpoint.

Type: String

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

Required: Yes

status

The current status of the agent runtime endpoint.

Type: String

Valid Values: CREATING | CREATE_FAILED | UPDATING | UPDATE_FAILED | READY | DELETING | DELETE_FAILED

Required: Yes

description

The description of the agent runtime endpoint.

Type: String

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

Required: No

liveVersion

The live version of the agent runtime endpoint. This is the version that is currently serving requests.

Type: String

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

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

Required: No

targetVersion

The target version of the agent runtime endpoint. This is the version that the endpoint is being updated to.

Type: String

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

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

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: