View Source AWS.BedrockAgentCoreControl (aws-elixir v1.0.11)

Welcome to the Amazon Bedrock AgentCore Control plane API reference.

Control plane actions configure, create, modify, and monitor Amazon Web Services resources.

Link to this section Summary

Functions

Creates an Amazon Bedrock AgentCore Runtime.

Creates a new API key credential provider.

Creates a browser profile in Amazon Bedrock AgentCore.

Creates a custom code interpreter.

Creates a new configuration bundle resource.

Creates a custom evaluator for agent quality assessment.

Creates a gateway for Amazon Bedrock Agent.

Operation to create a Harness.

Creates a new Amazon Bedrock AgentCore Memory resource.

Creates a new OAuth2 credential provider.

Creates an online evaluation configuration for continuous monitoring of agent performance.

Creates a new payment connector for a payment manager.

Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.

Creates a new payment manager in your Amazon Web Services account.

Creates a policy within the AgentCore Policy system.

Creates a new policy engine within the AgentCore Policy system.

Creates a new registry in your Amazon Web Services account.

Creates a new registry record within the specified registry.

Deletes an Amazon Bedrock AgentCore Runtime.

Deletes a configuration bundle and all of its versions.

Deletes an Amazon Bedrock AgentCore Memory resource.

Deletes an online evaluation configuration and stops any ongoing evaluation processes associated with it.

Deletes a payment credential provider and its associated stored credentials.

Deletes an existing policy from the AgentCore Policy system.

Deletes an existing policy engine from the AgentCore Policy system.

Deletes the resource-based policy for a specified resource.

Gets information about an Amazon Secure AgentEndpoint.

Retrieves information about an API key credential provider.

Gets information about a custom browser.

Gets information about a browser profile.

Gets information about a custom code interpreter.

Gets the latest version of a configuration bundle.

Gets a specific version of a configuration bundle by its version identifier.

Retrieves detailed information about an evaluator, including its configuration, status, and metadata.

Retrieves information about a specific Gateway.

Retrieves detailed information about a specific gateway rule.

Retrieves information about a specific gateway target.

Operation to get a single Harness.

Retrieve an existing Amazon Bedrock AgentCore Memory resource.

Retrieves information about an OAuth2 credential provider.

Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.

Retrieves information about a specific payment connector.

Retrieves information about a specific payment credential provider.

Retrieves information about a specific payment manager.

Retrieves detailed information about a specific policy within the AgentCore Policy system.

Retrieves detailed information about a specific policy engine within the AgentCore Policy system.

Retrieves information about a policy generation request within the AgentCore Policy system.

Retrieves information about a specific registry.

Retrieves information about a specific registry record.

Retrieves the resource-based policy for a specified resource.

Retrieves information about a token vault.

Retrieves information about a workload identity.

Lists all endpoints for a specific Amazon Secure Agent.

Lists all versions of a specific Amazon Secure Agent.

Lists all Amazon Secure Agents in your account.

Lists all API key credential providers in your account.

Lists all browser profiles in your account.

Lists all custom browsers in your account.

Lists all custom code interpreters in your account.

Lists all versions of a configuration bundle, with optional filtering by branch name or creation source.

Lists all configuration bundles in the account.

Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.

Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.

Lists all OAuth2 credential providers in your account.

Lists all online evaluation configurations in the account, providing summary information about each configuration's status and settings.

Lists all payment connectors for a specified payment manager.

Lists all payment credential providers in the account.

Lists all payment managers in the account.

Retrieves a list of policy engines within the AgentCore Policy system.

Retrieves a list of generated policy assets from a policy generation request within the AgentCore Policy system.

Retrieves a list of policy generation requests within the AgentCore Policy system.

Lists the tags associated with the specified resource.

Lists all workload identities in your account.

Creates or updates a resource-based policy for a resource with the specified resourceArn.

Sets the customer master key (CMK) for a token vault.

Initiates the AI-powered generation of Cedar policies from natural language descriptions within the AgentCore Policy system.

Synchronizes the gateway targets by fetching the latest tool definitions from the target endpoints.

Associates the specified tags to a resource with the specified resourceArn.

Removes the specified tags from the specified resource.

Updates an existing Amazon Bedrock AgentCore Runtime endpoint.

Updates an existing API key credential provider.

Updates a configuration bundle by creating a new version with the specified changes.

Updates a custom evaluator's configuration, description, or evaluation level.

Updates a gateway rule's priority, conditions, actions, or description.

Update an Amazon Bedrock AgentCore Memory resource memory.

Updates an existing OAuth2 credential provider.

Updates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status.

Updates an existing payment credential provider with new authentication credentials.

Updates an existing policy within the AgentCore Policy system.

Updates an existing policy engine within the AgentCore Policy system.

Updates an existing workload identity.

Link to this section Functions

Link to this function

create_agent_runtime(client, input, options \\ [])

View Source

Creates an Amazon Bedrock AgentCore Runtime.

Link to this function

create_agent_runtime_endpoint(client, agent_runtime_id, input, options \\ [])

View Source

Creates an AgentCore Runtime endpoint.

Link to this function

create_api_key_credential_provider(client, input, options \\ [])

View Source

Creates a new API key credential provider.

Link to this function

create_browser(client, input, options \\ [])

View Source

Creates a custom browser.

Link to this function

create_browser_profile(client, input, options \\ [])

View Source

Creates a browser profile in Amazon Bedrock AgentCore.

A browser profile stores persistent browser data such as cookies, local storage, session storage, and browsing history that can be saved from browser sessions and reused in subsequent sessions.

Link to this function

create_code_interpreter(client, input, options \\ [])

View Source

Creates a custom code interpreter.

Link to this function

create_configuration_bundle(client, input, options \\ [])

View Source

Creates a new configuration bundle resource.

A configuration bundle stores versioned component configurations for agent evaluation workflows.

Link to this function

create_evaluator(client, input, options \\ [])

View Source

Creates a custom evaluator for agent quality assessment.

Custom evaluators can use either LLM-as-a-Judge configurations with user-defined prompts, rating scales, and model settings, or code-based configurations with customer-managed Lambda functions to evaluate agent performance at tool call, trace, or session levels.

Link to this function

create_gateway(client, input, options \\ [])

View Source

Creates a gateway for Amazon Bedrock Agent.

A gateway serves as an integration point between your agent and external services.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

Link to this function

create_gateway_rule(client, gateway_identifier, input, options \\ [])

View Source

Creates a rule for a gateway.

Rules define conditions and actions that control how requests are routed and processed through the gateway, including principal-based access control and path-based routing.

Link to this function

create_gateway_target(client, gateway_identifier, input, options \\ [])

View Source

Creates a target for a gateway.

A target defines an endpoint that the gateway can connect to.

Link to this function

create_harness(client, input, options \\ [])

View Source

Operation to create a Harness.

Link to this function

create_memory(client, input, options \\ [])

View Source

Creates a new Amazon Bedrock AgentCore Memory resource.

Link to this function

create_oauth2_credential_provider(client, input, options \\ [])

View Source

Creates a new OAuth2 credential provider.

Link to this function

create_online_evaluation_config(client, input, options \\ [])

View Source

Creates an online evaluation configuration for continuous monitoring of agent performance.

Online evaluation automatically samples live traffic from CloudWatch logs at specified rates and applies evaluators to assess agent quality in production.

Link to this function

create_payment_connector(client, payment_manager_id, input, options \\ [])

View Source

Creates a new payment connector for a payment manager.

A payment connector integrates with a supported payment provider to enable payment processing capabilities.

Link to this function

create_payment_credential_provider(client, input, options \\ [])

View Source

Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.

Link to this function

create_payment_manager(client, input, options \\ [])

View Source

Creates a new payment manager in your Amazon Web Services account.

A payment manager serves as the top-level resource for managing payment processing capabilities, including payment connectors that integrate with supported payment providers.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

Link to this function

create_policy(client, policy_engine_id, input, options \\ [])

View Source

Creates a policy within the AgentCore Policy system.

Policies provide real-time, deterministic control over agentic interactions with AgentCore Gateway. Using the Cedar policy language, you can define fine-grained policies that specify which interactions with Gateway tools are permitted based on input parameters and OAuth claims, ensuring agents operate within defined boundaries and business rules. The policy is validated during creation against the Cedar schema generated from the Gateway's tools' input schemas, which defines the available tools, their parameters, and expected data types. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.

Link to this function

create_policy_engine(client, input, options \\ [])

View Source

Creates a new policy engine within the AgentCore Policy system.

A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with Gateways (each Gateway can be associated with at most one policy engine, but multiple Gateways can be associated with the same engine), the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

Link to this function

create_registry(client, input, options \\ [])

View Source

Creates a new registry in your Amazon Web Services account.

A registry serves as a centralized catalog for organizing and managing registry records, including MCP servers, A2A agents, agent skills, and custom resource types.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

Link to this function

create_registry_record(client, registry_id, input, options \\ [])

View Source

Creates a new registry record within the specified registry.

A registry record represents an individual AI resource's metadata in the registry. This could be an MCP server (and associated tools), A2A agent, agent skill, or a custom resource with a custom schema.

The record is processed asynchronously and returns HTTP 202 Accepted.

Link to this function

create_workload_identity(client, input, options \\ [])

View Source

Creates a new workload identity.

Link to this function

delete_agent_runtime(client, agent_runtime_id, input, options \\ [])

View Source

Deletes an Amazon Bedrock AgentCore Runtime.

Link to this function

delete_agent_runtime_endpoint(client, agent_runtime_id, endpoint_name, input, options \\ [])

View Source

Deletes an AAgentCore Runtime endpoint.

Link to this function

delete_api_key_credential_provider(client, input, options \\ [])

View Source

Deletes an API key credential provider.

Link to this function

delete_browser(client, browser_id, input, options \\ [])

View Source

Deletes a custom browser.

Link to this function

delete_browser_profile(client, profile_id, input, options \\ [])

View Source

Deletes a browser profile.

Link to this function

delete_code_interpreter(client, code_interpreter_id, input, options \\ [])

View Source

Deletes a custom code interpreter.

Link to this function

delete_configuration_bundle(client, bundle_id, input, options \\ [])

View Source

Deletes a configuration bundle and all of its versions.

Link to this function

delete_evaluator(client, evaluator_id, input, options \\ [])

View Source

Deletes a custom evaluator.

Builtin evaluators cannot be deleted. The evaluator must not be referenced by any active online evaluation configurations.

Link to this function

delete_gateway(client, gateway_identifier, input, options \\ [])

View Source

Deletes a gateway.

Link to this function

delete_gateway_rule(client, gateway_identifier, rule_id, input, options \\ [])

View Source

Deletes a gateway rule.

Link to this function

delete_gateway_target(client, gateway_identifier, target_id, input, options \\ [])

View Source

Deletes a gateway target.

You cannot delete a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before deleting the target.

Link to this function

delete_harness(client, harness_id, input, options \\ [])

View Source

Operation to delete a Harness.

Link to this function

delete_memory(client, memory_id, input, options \\ [])

View Source

Deletes an Amazon Bedrock AgentCore Memory resource.

Link to this function

delete_oauth2_credential_provider(client, input, options \\ [])

View Source

Deletes an OAuth2 credential provider.

Link to this function

delete_online_evaluation_config(client, online_evaluation_config_id, input, options \\ [])

View Source

Deletes an online evaluation configuration and stops any ongoing evaluation processes associated with it.

Link to this function

delete_payment_connector(client, payment_connector_id, payment_manager_id, input, options \\ [])

View Source

Deletes a payment connector.

Link to this function

delete_payment_credential_provider(client, input, options \\ [])

View Source

Deletes a payment credential provider and its associated stored credentials.

Link to this function

delete_payment_manager(client, payment_manager_id, input, options \\ [])

View Source

Deletes a payment manager.

All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This operation initiates the deletion process asynchronously.

Link to this function

delete_policy(client, policy_engine_id, policy_id, input, options \\ [])

View Source

Deletes an existing policy from the AgentCore Policy system.

Once deleted, the policy can no longer be used for agent behavior control and all references to it become invalid. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.

Link to this function

delete_policy_engine(client, policy_engine_id, input, options \\ [])

View Source

Deletes an existing policy engine from the AgentCore Policy system.

The policy engine must not have any associated policies before deletion. Once deleted, the policy engine and all its configurations become unavailable for policy management and evaluation. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

Link to this function

delete_registry(client, registry_id, input, options \\ [])

View Source

Deletes a registry.

The registry must contain zero records before it can be deleted. This operation initiates the deletion process asynchronously.

Link to this function

delete_registry_record(client, record_id, registry_id, input, options \\ [])

View Source

Deletes a registry record.

The record's status transitions to DELETING and the record is removed asynchronously.

Link to this function

delete_resource_policy(client, resource_arn, input, options \\ [])

View Source

Deletes the resource-based policy for a specified resource.

This feature is currently available only for AgentCore Runtime and Gateway.

Link to this function

delete_workload_identity(client, input, options \\ [])

View Source

Deletes a workload identity.

Link to this function

get_agent_runtime(client, agent_runtime_id, agent_runtime_version \\ nil, options \\ [])

View Source

Gets an Amazon Bedrock AgentCore Runtime.

Link to this function

get_agent_runtime_endpoint(client, agent_runtime_id, endpoint_name, options \\ [])

View Source

Gets information about an Amazon Secure AgentEndpoint.

Link to this function

get_api_key_credential_provider(client, input, options \\ [])

View Source

Retrieves information about an API key credential provider.

Link to this function

get_browser(client, browser_id, options \\ [])

View Source

Gets information about a custom browser.

Link to this function

get_browser_profile(client, profile_id, options \\ [])

View Source

Gets information about a browser profile.

Link to this function

get_code_interpreter(client, code_interpreter_id, options \\ [])

View Source

Gets information about a custom code interpreter.

Link to this function

get_configuration_bundle(client, bundle_id, branch_name \\ nil, options \\ [])

View Source

Gets the latest version of a configuration bundle.

By default, returns the latest version on the mainline branch. Use GetConfigurationBundleVersion to retrieve a specific historical version.

Link to this function

get_configuration_bundle_version(client, bundle_id, version_id, options \\ [])

View Source

Gets a specific version of a configuration bundle by its version identifier.

Link to this function

get_evaluator(client, evaluator_id, included_data \\ nil, options \\ [])

View Source

Retrieves detailed information about an evaluator, including its configuration, status, and metadata.

Works with both built-in and custom evaluators.

Link to this function

get_gateway(client, gateway_identifier, options \\ [])

View Source

Retrieves information about a specific Gateway.

Link to this function

get_gateway_rule(client, gateway_identifier, rule_id, options \\ [])

View Source

Retrieves detailed information about a specific gateway rule.

Link to this function

get_gateway_target(client, gateway_identifier, target_id, options \\ [])

View Source

Retrieves information about a specific gateway target.

Link to this function

get_harness(client, harness_id, options \\ [])

View Source

Operation to get a single Harness.

Link to this function

get_memory(client, memory_id, view \\ nil, options \\ [])

View Source

Retrieve an existing Amazon Bedrock AgentCore Memory resource.

Link to this function

get_oauth2_credential_provider(client, input, options \\ [])

View Source

Retrieves information about an OAuth2 credential provider.

Link to this function

get_online_evaluation_config(client, online_evaluation_config_id, options \\ [])

View Source

Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.

Link to this function

get_payment_connector(client, payment_connector_id, payment_manager_id, options \\ [])

View Source

Retrieves information about a specific payment connector.

Link to this function

get_payment_credential_provider(client, input, options \\ [])

View Source

Retrieves information about a specific payment credential provider.

Link to this function

get_payment_manager(client, payment_manager_id, options \\ [])

View Source

Retrieves information about a specific payment manager.

Link to this function

get_policy(client, policy_engine_id, policy_id, options \\ [])

View Source

Retrieves detailed information about a specific policy within the AgentCore Policy system.

This operation returns the complete policy definition, metadata, and current status, allowing administrators to review and manage policy configurations.

Link to this function

get_policy_engine(client, policy_engine_id, options \\ [])

View Source

Retrieves detailed information about a specific policy engine within the AgentCore Policy system.

This operation returns the complete policy engine configuration, metadata, and current status, allowing administrators to review and manage policy engine settings.

Link to this function

get_policy_generation(client, policy_engine_id, policy_generation_id, options \\ [])

View Source

Retrieves information about a policy generation request within the AgentCore Policy system.

Policy generation converts natural language descriptions into Cedar policy statements using AI-powered translation, enabling non-technical users to create policies.

Link to this function

get_registry(client, registry_id, options \\ [])

View Source

Retrieves information about a specific registry.

Link to this function

get_registry_record(client, record_id, registry_id, options \\ [])

View Source

Retrieves information about a specific registry record.

Link to this function

get_resource_policy(client, resource_arn, options \\ [])

View Source

Retrieves the resource-based policy for a specified resource.

This feature is currently available only for AgentCore Runtime and Gateway.

Link to this function

get_token_vault(client, input, options \\ [])

View Source

Retrieves information about a token vault.

Link to this function

get_workload_identity(client, input, options \\ [])

View Source

Retrieves information about a workload identity.

Link to this function

list_agent_runtime_endpoints(client, agent_runtime_id, input, options \\ [])

View Source

Lists all endpoints for a specific Amazon Secure Agent.

Link to this function

list_agent_runtime_versions(client, agent_runtime_id, input, options \\ [])

View Source

Lists all versions of a specific Amazon Secure Agent.

Link to this function

list_agent_runtimes(client, input, options \\ [])

View Source

Lists all Amazon Secure Agents in your account.

Link to this function

list_api_key_credential_providers(client, input, options \\ [])

View Source

Lists all API key credential providers in your account.

Link to this function

list_browser_profiles(client, input, options \\ [])

View Source

Lists all browser profiles in your account.

Link to this function

list_browsers(client, input, options \\ [])

View Source

Lists all custom browsers in your account.

Link to this function

list_code_interpreters(client, input, options \\ [])

View Source

Lists all custom code interpreters in your account.

Link to this function

list_configuration_bundle_versions(client, bundle_id, input, options \\ [])

View Source

Lists all versions of a configuration bundle, with optional filtering by branch name or creation source.

Link to this function

list_configuration_bundles(client, input, options \\ [])

View Source

Lists all configuration bundles in the account.

Link to this function

list_evaluators(client, input, options \\ [])

View Source

Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.

Link to this function

list_gateway_rules(client, gateway_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all rules for a gateway.

Link to this function

list_gateway_targets(client, gateway_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all targets for a specific gateway.

Link to this function

list_gateways(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all gateways in the account.

Link to this function

list_harnesses(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Operation to list Harnesses.

Link to this function

list_memories(client, input, options \\ [])

View Source

Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.

Link to this function

list_oauth2_credential_providers(client, input, options \\ [])

View Source

Lists all OAuth2 credential providers in your account.

Link to this function

list_online_evaluation_configs(client, input, options \\ [])

View Source

Lists all online evaluation configurations in the account, providing summary information about each configuration's status and settings.

Link to this function

list_payment_connectors(client, payment_manager_id, input, options \\ [])

View Source

Lists all payment connectors for a specified payment manager.

Link to this function

list_payment_credential_providers(client, input, options \\ [])

View Source

Lists all payment credential providers in the account.

Link to this function

list_payment_managers(client, input, options \\ [])

View Source

Lists all payment managers in the account.

Link to this function

list_policies(client, policy_engine_id, max_results \\ nil, next_token \\ nil, target_resource_scope \\ nil, options \\ [])

View Source

Retrieves a list of policies within the AgentCore Policy engine.

This operation supports pagination and filtering to help administrators manage and discover policies across policy engines. Results can be filtered by policy engine or resource associations.

Link to this function

list_policy_engines(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of policy engines within the AgentCore Policy system.

This operation supports pagination to help administrators discover and manage policy engines across their account. Each policy engine serves as a container for related policies.

Link to this function

list_policy_generation_assets(client, policy_engine_id, policy_generation_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of generated policy assets from a policy generation request within the AgentCore Policy system.

This operation returns the actual Cedar policies and related artifacts produced by the AI-powered policy generation process, allowing users to review and select from multiple generated policy options.

Link to this function

list_policy_generations(client, policy_engine_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of policy generation requests within the AgentCore Policy system.

This operation supports pagination and filtering to help track and manage AI-powered policy generation operations.

Link to this function

list_registries(client, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

Lists all registries in the account.

You can optionally filter results by status using the status parameter.

Link to this function

list_registry_records(client, registry_id, descriptor_type \\ nil, max_results \\ nil, name \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

Lists registry records within a registry.

You can optionally filter results using the name, status, and descriptorType parameters. When multiple filters are specified, they are combined using AND logic.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags associated with the specified resource.

This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.

Link to this function

list_workload_identities(client, input, options \\ [])

View Source

Lists all workload identities in your account.

Link to this function

put_resource_policy(client, resource_arn, input, options \\ [])

View Source

Creates or updates a resource-based policy for a resource with the specified resourceArn.

This feature is currently available only for AgentCore Runtime and Gateway.

Link to this function

set_token_vault_cm_k(client, input, options \\ [])

View Source

Sets the customer master key (CMK) for a token vault.

Link to this function

start_policy_generation(client, policy_engine_id, input, options \\ [])

View Source

Initiates the AI-powered generation of Cedar policies from natural language descriptions within the AgentCore Policy system.

This feature enables both technical and non-technical users to create policies by describing their authorization requirements in plain English, which is then automatically translated into formal Cedar policy statements. The generation process analyzes the natural language input along with the Gateway's tool context to produce validated policy options. Generated policy assets are automatically deleted after 7 days, so you should review and create policies from the generated assets within this timeframe. Once created, policies are permanent and not subject to this expiration. Generated policies should be reviewed and tested in log-only mode before deploying to production. Use this when you want to describe policy intent naturally rather than learning Cedar syntax, though generated policies may require refinement for complex scenarios.

Link to this function

submit_registry_record_for_approval(client, record_id, registry_id, input, options \\ [])

View Source

Submits a registry record for approval.

This transitions the record from DRAFT status to PENDING_APPROVAL status. If the registry has auto-approval enabled, the record is automatically approved.

Link to this function

synchronize_gateway_targets(client, gateway_identifier, input, options \\ [])

View Source

Synchronizes the gateway targets by fetching the latest tool definitions from the target endpoints.

You cannot synchronize a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before synchronizing.

You cannot synchronize a target that has a static tool schema (mcpToolSchema) configured. Remove the static schema through an UpdateGatewayTarget call to enable dynamic tool synchronization.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Associates the specified tags to a resource with the specified resourceArn.

If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes the specified tags from the specified resource.

This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.

Link to this function

update_agent_runtime(client, agent_runtime_id, input, options \\ [])

View Source

Updates an existing Amazon Secure Agent.

Link to this function

update_agent_runtime_endpoint(client, agent_runtime_id, endpoint_name, input, options \\ [])

View Source

Updates an existing Amazon Bedrock AgentCore Runtime endpoint.

Link to this function

update_api_key_credential_provider(client, input, options \\ [])

View Source

Updates an existing API key credential provider.

Link to this function

update_configuration_bundle(client, bundle_id, input, options \\ [])

View Source

Updates a configuration bundle by creating a new version with the specified changes.

Each update creates a new version in the version history.

Link to this function

update_evaluator(client, evaluator_id, input, options \\ [])

View Source

Updates a custom evaluator's configuration, description, or evaluation level.

Built-in evaluators cannot be updated. The evaluator must not be locked for modification.

Link to this function

update_gateway(client, gateway_identifier, input, options \\ [])

View Source

Updates an existing gateway.

Link to this function

update_gateway_rule(client, gateway_identifier, rule_id, input, options \\ [])

View Source

Updates a gateway rule's priority, conditions, actions, or description.

Link to this function

update_gateway_target(client, gateway_identifier, target_id, input, options \\ [])

View Source

Updates an existing gateway target.

You cannot update a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before updating the target.

Link to this function

update_harness(client, harness_id, input, options \\ [])

View Source

Operation to update a Harness.

Link to this function

update_memory(client, memory_id, input, options \\ [])

View Source

Update an Amazon Bedrock AgentCore Memory resource memory.

Link to this function

update_oauth2_credential_provider(client, input, options \\ [])

View Source

Updates an existing OAuth2 credential provider.

Link to this function

update_online_evaluation_config(client, online_evaluation_config_id, input, options \\ [])

View Source

Updates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status.

Changes take effect immediately for ongoing evaluations.

Link to this function

update_payment_connector(client, payment_connector_id, payment_manager_id, input, options \\ [])

View Source

Updates an existing payment connector.

This operation uses PATCH semantics, so you only need to specify the fields you want to change.

Link to this function

update_payment_credential_provider(client, input, options \\ [])

View Source

Updates an existing payment credential provider with new authentication credentials.

Link to this function

update_payment_manager(client, payment_manager_id, input, options \\ [])

View Source

Updates an existing payment manager.

This operation uses PATCH semantics, so you only need to specify the fields you want to change.

Link to this function

update_policy(client, policy_engine_id, policy_id, input, options \\ [])

View Source

Updates an existing policy within the AgentCore Policy system.

This operation allows modification of the policy description and definition while maintaining the policy's identity. The updated policy is validated against the Cedar schema before being applied. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.

Link to this function

update_policy_engine(client, policy_engine_id, input, options \\ [])

View Source

Updates an existing policy engine within the AgentCore Policy system.

This operation allows modification of the policy engine description while maintaining its identity. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

Link to this function

update_registry(client, registry_id, input, options \\ [])

View Source

Updates an existing registry.

This operation uses PATCH semantics, so you only need to specify the fields you want to change.

Link to this function

update_registry_record(client, record_id, registry_id, input, options \\ [])

View Source

Updates an existing registry record.

This operation uses PATCH semantics, so you only need to specify the fields you want to change. The update is processed asynchronously and returns HTTP 202 Accepted.

Link to this function

update_registry_record_status(client, record_id, registry_id, input, options \\ [])

View Source

Updates the status of a registry record.

Use this operation to approve, reject, or deprecate a registry record.

Link to this function

update_workload_identity(client, input, options \\ [])

View Source

Updates an existing workload identity.