aws-elixir v1.0.10

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

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

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

Creates an Amazon Bedrock AgentCore Runtime.

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

Creates an AgentCore Runtime endpoint.

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

Creates a new API key credential provider.

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

Creates a custom browser.

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

Creates a custom code interpreter.

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

Creates a gateway for Amazon Bedrock Agent.

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

Creates a target for a gateway.

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

Creates a new Amazon Bedrock AgentCore Memory resource.

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

Creates a new OAuth2 credential provider.

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

Creates a new workload identity.

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

Deletes an Amazon Bedrock AgentCore Runtime.

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

Deletes an AAgentCore Runtime endpoint.

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

Deletes an API key credential provider.

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

Deletes a custom browser.

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

Deletes a custom code interpreter.

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

Deletes a gateway.

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

Deletes a gateway target.

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

Deletes an Amazon Bedrock AgentCore Memory resource.

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

Deletes an OAuth2 credential provider.

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

Deletes a workload identity.

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

Gets an Amazon Bedrock AgentCore Runtime.

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

Gets information about an Amazon Secure AgentEndpoint.

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

Retrieves information about an API key credential provider.

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

Gets information about a custom browser.

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

Gets information about a custom code interpreter.

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

Retrieves information about a specific Gateway.

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

Retrieves information about a specific gateway target.

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

Retrieve an existing Amazon Bedrock AgentCore Memory resource.

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

Retrieves information about an OAuth2 credential provider.

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

Retrieves information about a token vault.

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

Retrieves information about a workload identity.

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

Lists all endpoints for a specific Amazon Secure Agent.

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

Lists all versions of a specific Amazon Secure Agent.

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

Lists all Amazon Secure Agents in your account.

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

Lists all API key credential providers in your account.

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

Lists all custom browsers in your account.

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

Lists all custom code interpreters in your account.

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

Lists all targets for a specific gateway.

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

Lists all gateways in the account.

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

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

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

Lists all OAuth2 credential providers in your account.

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

Lists the tags associated with the specified resource.

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

Lists all workload identities in your account.

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

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

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

The gateway targets.

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

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

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

Removes the specified tags from the specified resource.

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

Updates an existing Amazon Secure Agent.

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

Updates an existing Amazon Bedrock AgentCore Runtime endpoint.

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

Updates an existing API key credential provider.

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

Updates an existing gateway.

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

Updates an existing gateway target.

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

Update an Amazon Bedrock AgentCore Memory resource memory.

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

Updates an existing OAuth2 credential provider.

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

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_code_interpreter(client, input, options \\ [])

View Source

Creates a custom code interpreter.

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_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_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_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_code_interpreter(client, code_interpreter_id, input, options \\ [])

View Source

Deletes a custom code interpreter.

Link to this function

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

View Source

Deletes a gateway.

Link to this function

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

View Source

Deletes a gateway target.

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_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_code_interpreter(client, code_interpreter_id, options \\ [])

View Source

Gets information about a custom code interpreter.

Link to this function

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

View Source

Retrieves information about a specific Gateway.

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_memory(client, memory_id, 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_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_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_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_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_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, 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

metadata()

View Source
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

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

View Source

The gateway targets.

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, 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, 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_gateway(client, gateway_identifier, input, options \\ [])

View Source

Updates an existing gateway.

Link to this function

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

View Source

Updates an existing gateway target.

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_workload_identity(client, input, options \\ [])

View Source

Updates an existing workload identity.