agent_runtimes

Creates, updates, deletes, gets or lists an agent_runtimes resource.

Overview

Name	`agent_runtimes`
Type	Resource
Id	`aws.bedrock_agentcore_control.agent_runtimes`

Fields

The following fields are returned by SELECT queries:

get_agent_runtime
list_agent_runtimes

Name	Datatype	Description
`agent_runtime_arn`	`string`	The Amazon Resource Name (ARN) of the AgentCore Runtime. (pattern: <code>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}</code>)
`agent_runtime_artifact`	`object`	The artifact of the agent.
`agent_runtime_id`	`string`	The unique identifier of the AgentCore Runtime. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}</code>)
`agent_runtime_name`	`string`	The name of the AgentCore Runtime. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,47}</code>)
`agent_runtime_version`	`string`	The version of the AgentCore Runtime. (pattern: <code>([1-9][0-9]{0,4})</code>)
`authorizer_configuration`	`object`	Represents inbound authorization configuration options used to authenticate incoming requests.
`capacity_provider_configuration`	`object`	Configuration for customer-managed compute capacity for the AgentCore Runtime. A capacity provider runs the AgentCore Runtime on the Instances compute type, using Amazon Web Services managed compute in your account.
`created_at`	`string (date-time)`	The timestamp when the AgentCore Runtime was created.
`description`	`string`	The description of the AgentCore Runtime.
`environment_variables`	`object`	Environment variables set in the AgentCore Runtime environment.
`failure_reason`	`string`	The reason for failure if the AgentCore Runtime is in a failed state.
`filesystem_configurations`	`array`	The filesystem configurations mounted into the AgentCore Runtime.
`last_updated_at`	`string (date-time)`	The timestamp when the AgentCore Runtime was last updated.
`lifecycle_configuration`	`object`	LifecycleConfiguration lets you manage the lifecycle of runtime sessions and resources in AgentCore Runtime. This configuration helps optimize resource utilization by automatically cleaning up idle sessions and preventing long-running instances from consuming resources indefinitely.
`metadata_configuration`	`object`	Configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.
`network_configuration`	`object`	SecurityConfig for the Agent.
`protocol_configuration`	`object`	The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.
`request_header_configuration`	`object`	Configuration for HTTP request headers that will be passed through to the runtime.
`role_arn`	`string`	The IAM role ARN that provides permissions for the AgentCore Runtime. (pattern: <code>arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+</code>)
`status`	`string`	The current status of the AgentCore Runtime. (CREATING, CREATE_FAILED, UPDATING, UPDATE_FAILED, READY, DELETING)
`workload_identity_details`	`object`	The information about the workload identity.

Name	Datatype	Description
`agent_runtime_arn`	`string`	The Amazon Resource Name (ARN) of the agent runtime. (pattern: <code>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}</code>)
`agent_runtime_id`	`string`	The unique identifier of the agent runtime. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}</code>)
`agent_runtime_name`	`string`	The name of the agent runtime. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,47}</code>)
`agent_runtime_version`	`string`	The version of the agent runtime. (pattern: <code>([1-9][0-9]{0,4})</code>)
`description`	`string`	The description of the agent runtime.
`last_updated_at`	`string (date-time)`	The timestamp when the agent runtime was last updated.
`status`	`string`	The current status of the agent runtime. (CREATING, CREATE_FAILED, UPDATING, UPDATE_FAILED, READY, DELETING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_agent_runtime`	`select`	`agent_runtime_id`, `region`	`version`	Gets an Amazon Bedrock AgentCore Runtime.
`list_agent_runtimes`	`select`	`region`	`maxResults`, `nextToken`	Lists all Amazon Secure Agents in your account.
`create_agent_runtime`	`insert`	`region`, `agentRuntimeName`, `agentRuntimeArtifact`, `roleArn`		Creates an Amazon Bedrock AgentCore Runtime.
`update_agent_runtime`	`update`	`agent_runtime_id`, `region`, `agentRuntimeArtifact`, `roleArn`		Updates an existing Amazon Secure Agent.
`delete_agent_runtime`	`delete`	`agent_runtime_id`, `region`	`version`, `clientToken`	Deletes an Amazon Bedrock AgentCore Runtime, or a single version of an AgentCore Runtime when you provide the version qualifier.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`agent_runtime_id`	`string`	The unique identifier of the AgentCore Runtime to delete.
`region`	`string`	AWS region (default: us-east-1)
`clientToken`	`string`	A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
`maxResults`	`integer`	The maximum number of results to return in the response.
`nextToken`	`string`	A token to retrieve the next page of results.
`version`	`string`	The version of the AgentCore Runtime to delete. When you provide this value, only that version is deleted. When you omit it, the entire AgentCore Runtime and all of its versions are deleted.

`SELECT` examples

get_agent_runtime
list_agent_runtimes

Gets an Amazon Bedrock AgentCore Runtime.

SELECT
agent_runtime_arn,
agent_runtime_artifact,
agent_runtime_id,
agent_runtime_name,
agent_runtime_version,
authorizer_configuration,
capacity_provider_configuration,
created_at,
description,
environment_variables,
failure_reason,
filesystem_configurations,
last_updated_at,
lifecycle_configuration,
metadata_configuration,
network_configuration,
protocol_configuration,
request_header_configuration,
role_arn,
status,
workload_identity_details
FROM aws.bedrock_agentcore_control.agent_runtimes
WHERE agent_runtime_id = '{{ agent_runtime_id }}' -- required
AND region = '{{ region }}' -- required
AND version = '{{ version }}'
;

Lists all Amazon Secure Agents in your account.

SELECT
agent_runtime_arn,
agent_runtime_id,
agent_runtime_name,
agent_runtime_version,
description,
last_updated_at,
status
FROM aws.bedrock_agentcore_control.agent_runtimes
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

`INSERT` examples

create_agent_runtime
Manifest

Creates an Amazon Bedrock AgentCore Runtime.

INSERT INTO aws.bedrock_agentcore_control.agent_runtimes (
agentRuntimeName,
agentRuntimeArtifact,
roleArn,
networkConfiguration,
clientToken,
description,
authorizerConfiguration,
requestHeaderConfiguration,
protocolConfiguration,
lifecycleConfiguration,
environmentVariables,
filesystemConfigurations,
capacityProviderConfiguration,
tags,
region
)
SELECT 
'{{ agentRuntimeName }}' /* required */,
'{{ agentRuntimeArtifact }}' /* required */,
'{{ roleArn }}' /* required */,
'{{ networkConfiguration }}',
'{{ clientToken }}',
'{{ description }}',
'{{ authorizerConfiguration }}',
'{{ requestHeaderConfiguration }}',
'{{ protocolConfiguration }}',
'{{ lifecycleConfiguration }}',
'{{ environmentVariables }}',
'{{ filesystemConfigurations }}',
'{{ capacityProviderConfiguration }}',
'{{ tags }}',
'{{ region }}'
RETURNING
agent_runtime_arn,
agent_runtime_id,
agent_runtime_version,
created_at,
status,
workload_identity_details
;

# Description fields are for documentation purposes
- name: agent_runtimes
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the agent_runtimes resource.
  - name: agentRuntimeName
    value: "{{ agentRuntimeName }}"
  - name: agentRuntimeArtifact
    description: |
      The artifact of the agent.
    value:
      containerConfiguration:
        containerUri: "{{ containerUri }}"
      codeConfiguration:
        code:
          s3:
            bucket: "{{ bucket }}"
            prefix: "{{ prefix }}"
            versionId: "{{ versionId }}"
        runtime: "{{ runtime }}"
        entryPoint:
          - "{{ entryPoint }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: networkConfiguration
    description: |
      SecurityConfig for the Agent.
    value:
      networkMode: "{{ networkMode }}"
      networkModeConfig:
        securityGroups:
          - "{{ securityGroups }}"
        subnets:
          - "{{ subnets }}"
        requireServiceS3Endpoint: {{ requireServiceS3Endpoint }}
  - name: clientToken
    value: "{{ clientToken }}"
  - name: description
    value: "{{ description }}"
  - name: authorizerConfiguration
    description: |
      Represents inbound authorization configuration options used to authenticate incoming requests.
    value:
      customJWTAuthorizer:
        discoveryUrl: "{{ discoveryUrl }}"
        allowedAudience:
          - "{{ allowedAudience }}"
        allowedClients:
          - "{{ allowedClients }}"
        allowedScopes:
          - "{{ allowedScopes }}"
        advertisedScopeMapping: "{{ advertisedScopeMapping }}"
        customClaims:
          - inboundTokenClaimName: "{{ inboundTokenClaimName }}"
            inboundTokenClaimValueType: "{{ inboundTokenClaimValueType }}"
            authorizingClaimMatchValue:
              claimMatchValue:
                matchValueString: "{{ matchValueString }}"
                matchValueStringList: "{{ matchValueStringList }}"
              claimMatchOperator: "{{ claimMatchOperator }}"
        privateEndpoint:
          selfManagedLatticeResource:
            resourceConfigurationIdentifier: "{{ resourceConfigurationIdentifier }}"
          managedVpcResource:
            vpcIdentifier: "{{ vpcIdentifier }}"
            subnetIds:
              - "{{ subnetIds }}"
            endpointIpAddressType: "{{ endpointIpAddressType }}"
            securityGroupIds:
              - "{{ securityGroupIds }}"
            tags: "{{ tags }}"
            routingDomain: "{{ routingDomain }}"
        privateEndpointOverrides:
          - domain: "{{ domain }}"
            privateEndpoint:
              selfManagedLatticeResource:
                resourceConfigurationIdentifier: "{{ resourceConfigurationIdentifier }}"
              managedVpcResource:
                vpcIdentifier: "{{ vpcIdentifier }}"
                subnetIds: "{{ subnetIds }}"
                endpointIpAddressType: "{{ endpointIpAddressType }}"
                securityGroupIds: "{{ securityGroupIds }}"
                tags: "{{ tags }}"
                routingDomain: "{{ routingDomain }}"
        allowedWorkloadConfiguration:
          hostingEnvironments:
            - arn: "{{ arn }}"
          workloadIdentities:
            - "{{ workloadIdentities }}"
  - name: requestHeaderConfiguration
    description: |
      Configuration for HTTP request headers that will be passed through to the runtime.
    value:
      requestHeaderAllowlist:
        - "{{ requestHeaderAllowlist }}"
  - name: protocolConfiguration
    description: |
      The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.
    value:
      serverProtocol: "{{ serverProtocol }}"
  - name: lifecycleConfiguration
    description: |
      LifecycleConfiguration lets you manage the lifecycle of runtime sessions and resources in AgentCore Runtime. This configuration helps optimize resource utilization by automatically cleaning up idle sessions and preventing long-running instances from consuming resources indefinitely.
    value:
      idleRuntimeSessionTimeout: {{ idleRuntimeSessionTimeout }}
      maxLifetime: {{ maxLifetime }}
  - name: environmentVariables
    value: "{{ environmentVariables }}"
  - name: filesystemConfigurations
    value:
      - sessionStorage:
          mountPath: "{{ mountPath }}"
        s3FilesAccessPoint:
          accessPointArn: "{{ accessPointArn }}"
          mountPath: "{{ mountPath }}"
        efsAccessPoint:
          accessPointArn: "{{ accessPointArn }}"
          mountPath: "{{ mountPath }}"
        capacityProviderVolume:
          volumeName: "{{ volumeName }}"
          mountPath: "{{ mountPath }}"
  - name: capacityProviderConfiguration
    description: |
      Configuration for customer-managed compute capacity for the AgentCore Runtime. A capacity provider runs the AgentCore Runtime on the Instances compute type, using Amazon Web Services managed compute in your account.
    value:
      capacityProviderArn: "{{ capacityProviderArn }}"
  - name: tags
    value: "{{ tags }}"

`UPDATE` examples

update_agent_runtime

Updates an existing Amazon Secure Agent.

UPDATE aws.bedrock_agentcore_control.agent_runtimes
SET 
agentRuntimeArtifact = '{{ agentRuntimeArtifact }}',
roleArn = '{{ roleArn }}',
networkConfiguration = '{{ networkConfiguration }}',
description = '{{ description }}',
authorizerConfiguration = '{{ authorizerConfiguration }}',
requestHeaderConfiguration = '{{ requestHeaderConfiguration }}',
protocolConfiguration = '{{ protocolConfiguration }}',
lifecycleConfiguration = '{{ lifecycleConfiguration }}',
metadataConfiguration = '{{ metadataConfiguration }}',
environmentVariables = '{{ environmentVariables }}',
filesystemConfigurations = '{{ filesystemConfigurations }}',
capacityProviderConfiguration = '{{ capacityProviderConfiguration }}',
clientToken = '{{ clientToken }}'
WHERE 
agent_runtime_id = '{{ agent_runtime_id }}' --required
AND region = '{{ region }}' --required
AND agentRuntimeArtifact = '{{ agentRuntimeArtifact }}' --required
AND roleArn = '{{ roleArn }}' --required
RETURNING
agent_runtime_arn,
agent_runtime_id,
agent_runtime_version,
created_at,
last_updated_at,
status,
workload_identity_details;

`DELETE` examples

delete_agent_runtime

Deletes an Amazon Bedrock AgentCore Runtime, or a single version of an AgentCore Runtime when you provide the version qualifier.

DELETE FROM aws.bedrock_agentcore_control.agent_runtimes
WHERE agent_runtime_id = '{{ agent_runtime_id }}' --required
AND region = '{{ region }}' --required
AND version = '{{ version }}'
AND clientToken = '{{ clientToken }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​