R/bedrockagentcore_service.R

In paws.machine.learning: 'Amazon Web Services' Machine Learning Services

# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common new_handlers new_service set_config merge_config
NULL

#' Amazon Bedrock AgentCore
#'
#' @description
#' Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.
#'
#' @param
#' config
#' Optional configuration of credentials, endpoint, and/or region.
#' \itemize{
#' \item{\strong{credentials}: \itemize{
#' \item{\strong{creds}: \itemize{
#' \item{\strong{access_key_id}: AWS access key ID}
#' \item{\strong{secret_access_key}: AWS secret access key}
#' \item{\strong{session_token}: AWS temporary session token}
#' }}
#' \item{\strong{profile}: The name of a profile to use. If not given, then the default profile is used.}
#' \item{\strong{anonymous}: Set anonymous credentials.}
#' }}
#' \item{\strong{endpoint}: The complete URL to use for the constructed client.}
#' \item{\strong{region}: The AWS Region used in instantiating the client.}
#' \item{\strong{close_connection}: Immediately close all HTTP connections.}
#' \item{\strong{timeout}: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.}
#' \item{\strong{s3_force_path_style}: Set this to `true` to force the request to use path-style addressing, i.e. `http://s3.amazonaws.com/BUCKET/KEY`.}
#' \item{\strong{sts_regional_endpoint}: Set sts regional endpoint resolver to regional or legacy \url{https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html}}
#' }
#' @param
#' credentials
#' Optional credentials shorthand for the config parameter
#' \itemize{
#' \item{\strong{creds}: \itemize{
#' \item{\strong{access_key_id}: AWS access key ID}
#' \item{\strong{secret_access_key}: AWS secret access key}
#' \item{\strong{session_token}: AWS temporary session token}
#' }}
#' \item{\strong{profile}: The name of a profile to use. If not given, then the default profile is used.}
#' \item{\strong{anonymous}: Set anonymous credentials.}
#' }
#' @param
#' endpoint
#' Optional shorthand for complete URL to use for the constructed client.
#' @param
#' region
#' Optional shorthand for AWS Region used in instantiating the client.
#'
#' @section Service syntax:
#' ```
#' svc <- bedrockagentcore(
#'   config = list(
#'     credentials = list(
#'       creds = list(
#'         access_key_id = "string",
#'         secret_access_key = "string",
#'         session_token = "string"
#'       ),
#'       profile = "string",
#'       anonymous = "logical"
#'     ),
#'     endpoint = "string",
#'     region = "string",
#'     close_connection = "logical",
#'     timeout = "numeric",
#'     s3_force_path_style = "logical",
#'     sts_regional_endpoint = "string"
#'   ),
#'   credentials = list(
#'     creds = list(
#'       access_key_id = "string",
#'       secret_access_key = "string",
#'       session_token = "string"
#'     ),
#'     profile = "string",
#'     anonymous = "logical"
#'   ),
#'   endpoint = "string",
#'   region = "string"
#' )
#' ```
#'
#' @examples
#' \dontrun{
#' svc <- bedrockagentcore()
#' svc$batch_create_memory_records(
#'   Foo = 123
#' )
#' }
#'
#' @section Operations:
#' \tabular{ll}{
#'  \link[=bedrockagentcore_batch_create_memory_records]{batch_create_memory_records} \tab Creates multiple memory records in a single batch operation for the specified memory with custom content\cr
#'  \link[=bedrockagentcore_batch_delete_memory_records]{batch_delete_memory_records} \tab Deletes multiple memory records in a single batch operation from the specified memory\cr
#'  \link[=bedrockagentcore_batch_update_memory_records]{batch_update_memory_records} \tab Updates multiple memory records with custom content in a single batch operation within the specified memory\cr
#'  \link[=bedrockagentcore_complete_resource_token_auth]{complete_resource_token_auth} \tab Confirms the user authentication session for obtaining OAuth2\cr
#'  \link[=bedrockagentcore_create_ab_test]{create_ab_test} \tab Creates an A/B test for comparing agent configurations\cr
#'  \link[=bedrockagentcore_create_event]{create_event} \tab Creates an event in an AgentCore Memory resource\cr
#'  \link[=bedrockagentcore_create_payment_instrument]{create_payment_instrument} \tab Create a new payment instrument for a connector\cr
#'  \link[=bedrockagentcore_create_payment_session]{create_payment_session} \tab Create a new payment session\cr
#'  \link[=bedrockagentcore_delete_ab_test]{delete_ab_test} \tab Deletes an A/B test and its associated gateway rules\cr
#'  \link[=bedrockagentcore_delete_batch_evaluation]{delete_batch_evaluation} \tab Deletes a batch evaluation and its associated results\cr
#'  \link[=bedrockagentcore_delete_event]{delete_event} \tab Deletes an event from an AgentCore Memory resource\cr
#'  \link[=bedrockagentcore_delete_memory_record]{delete_memory_record} \tab Deletes a memory record from an AgentCore Memory resource\cr
#'  \link[=bedrockagentcore_delete_payment_instrument]{delete_payment_instrument} \tab Deletes a payment instrument\cr
#'  \link[=bedrockagentcore_delete_payment_session]{delete_payment_session} \tab Deletes a payment session\cr
#'  \link[=bedrockagentcore_delete_recommendation]{delete_recommendation} \tab Deletes a recommendation and its associated results\cr
#'  \link[=bedrockagentcore_evaluate]{evaluate} \tab Performs on-demand evaluation of agent traces using a specified evaluator\cr
#'  \link[=bedrockagentcore_get_ab_test]{get_ab_test} \tab Retrieves detailed information about an A/B test, including its configuration, status, and statistical results\cr
#'  \link[=bedrockagentcore_get_agent_card]{get_agent_card} \tab Retrieves the A2A agent card associated with an AgentCore Runtime agent\cr
#'  \link[=bedrockagentcore_get_batch_evaluation]{get_batch_evaluation} \tab Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details\cr
#'  \link[=bedrockagentcore_get_browser_session]{get_browser_session} \tab Retrieves detailed information about a specific browser session in Amazon Bedrock AgentCore\cr
#'  \link[=bedrockagentcore_get_code_interpreter_session]{get_code_interpreter_session} \tab Retrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore\cr
#'  \link[=bedrockagentcore_get_event]{get_event} \tab Retrieves information about a specific event in an AgentCore Memory resource\cr
#'  \link[=bedrockagentcore_get_memory_record]{get_memory_record} \tab Retrieves a specific memory record from an AgentCore Memory resource\cr
#'  \link[=bedrockagentcore_get_payment_instrument]{get_payment_instrument} \tab Get a payment instrument by ID\cr
#'  \link[=bedrockagentcore_get_payment_instrument_balance]{get_payment_instrument_balance} \tab Get the balance of a payment instrument\cr
#'  \link[=bedrockagentcore_get_payment_session]{get_payment_session} \tab Get a payment session\cr
#'  \link[=bedrockagentcore_get_recommendation]{get_recommendation} \tab Retrieves detailed information about a recommendation, including its configuration, status, and results\cr
#'  \link[=bedrockagentcore_get_resource_api_key]{get_resource_api_key} \tab Retrieves the API key associated with an API key credential provider\cr
#'  \link[=bedrockagentcore_get_resource_oauth_2_token]{get_resource_oauth_2_token} \tab Returns the OAuth 2\cr
#'  \link[=bedrockagentcore_get_resource_payment_token]{get_resource_payment_token} \tab Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms\cr
#'  \link[=bedrockagentcore_get_workload_access_token]{get_workload_access_token} \tab Obtains a workload access token for agentic workloads not acting on behalf of a user\cr
#'  \link[=bedrockagentcore_get_workload_access_token_for_jwt]{get_workload_access_token_for_jwt} \tab Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token\cr
#'  \link[=bedrockagentcore_get_workload_access_token_for_user_id]{get_workload_access_token_for_user_id} \tab Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID\cr
#'  \link[=bedrockagentcore_invoke_agent_runtime]{invoke_agent_runtime} \tab Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time\cr
#'  \link[=bedrockagentcore_invoke_agent_runtime_command]{invoke_agent_runtime_command} \tab Executes a command in a runtime session container and streams the output back to the caller\cr
#'  \link[=bedrockagentcore_invoke_browser]{invoke_browser} \tab Invokes an operating system-level action on a browser session in Amazon Bedrock AgentCore\cr
#'  \link[=bedrockagentcore_invoke_code_interpreter]{invoke_code_interpreter} \tab Executes code within an active code interpreter session in Amazon Bedrock AgentCore\cr
#'  \link[=bedrockagentcore_invoke_harness]{invoke_harness} \tab Operation to invoke a Harness\cr
#'  \link[=bedrockagentcore_list_ab_tests]{list_ab_tests} \tab Lists all A/B tests in the account\cr
#'  \link[=bedrockagentcore_list_actors]{list_actors} \tab Lists all actors in an AgentCore Memory resource\cr
#'  \link[=bedrockagentcore_list_batch_evaluations]{list_batch_evaluations} \tab Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration\cr
#'  \link[=bedrockagentcore_list_browser_sessions]{list_browser_sessions} \tab Retrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria\cr
#'  \link[=bedrockagentcore_list_code_interpreter_sessions]{list_code_interpreter_sessions} \tab Retrieves a list of code interpreter sessions in Amazon Bedrock AgentCore that match the specified criteria\cr
#'  \link[=bedrockagentcore_list_events]{list_events} \tab Lists events in an AgentCore Memory resource based on specified criteria\cr
#'  \link[=bedrockagentcore_list_memory_extraction_jobs]{list_memory_extraction_jobs} \tab Lists all long-term memory extraction jobs that are eligible to be started with optional filtering\cr
#'  \link[=bedrockagentcore_list_memory_records]{list_memory_records} \tab Lists memory records in an AgentCore Memory resource based on specified criteria\cr
#'  \link[=bedrockagentcore_list_payment_instruments]{list_payment_instruments} \tab List payment instruments for a manager\cr
#'  \link[=bedrockagentcore_list_payment_sessions]{list_payment_sessions} \tab List payment sessions\cr
#'  \link[=bedrockagentcore_list_recommendations]{list_recommendations} \tab Lists all recommendations in the account, with optional filtering by status\cr
#'  \link[=bedrockagentcore_list_sessions]{list_sessions} \tab Lists sessions in an AgentCore Memory resource based on specified criteria\cr
#'  \link[=bedrockagentcore_process_payment]{process_payment} \tab Processes a payment using a payment instrument within a payment session\cr
#'  \link[=bedrockagentcore_retrieve_memory_records]{retrieve_memory_records} \tab Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria\cr
#'  \link[=bedrockagentcore_save_browser_session_profile]{save_browser_session_profile} \tab Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore\cr
#'  \link[=bedrockagentcore_search_registry_records]{search_registry_records} \tab Searches for registry records using semantic, lexical, or hybrid queries\cr
#'  \link[=bedrockagentcore_start_batch_evaluation]{start_batch_evaluation} \tab Starts a batch evaluation job that evaluates agent performance across multiple sessions\cr
#'  \link[=bedrockagentcore_start_browser_session]{start_browser_session} \tab Creates and initializes a browser session in Amazon Bedrock AgentCore\cr
#'  \link[=bedrockagentcore_start_code_interpreter_session]{start_code_interpreter_session} \tab Creates and initializes a code interpreter session in Amazon Bedrock AgentCore\cr
#'  \link[=bedrockagentcore_start_memory_extraction_job]{start_memory_extraction_job} \tab Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records\cr
#'  \link[=bedrockagentcore_start_recommendation]{start_recommendation} \tab Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance\cr
#'  \link[=bedrockagentcore_stop_batch_evaluation]{stop_batch_evaluation} \tab Stops a running batch evaluation\cr
#'  \link[=bedrockagentcore_stop_browser_session]{stop_browser_session} \tab Terminates an active browser session in Amazon Bedrock AgentCore\cr
#'  \link[=bedrockagentcore_stop_code_interpreter_session]{stop_code_interpreter_session} \tab Terminates an active code interpreter session in Amazon Bedrock AgentCore\cr
#'  \link[=bedrockagentcore_stop_runtime_session]{stop_runtime_session} \tab Stops a session that is running in an running AgentCore Runtime agent\cr
#'  \link[=bedrockagentcore_update_ab_test]{update_ab_test} \tab Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status\cr
#'  \link[=bedrockagentcore_update_browser_stream]{update_browser_stream} \tab Updates a browser stream
#' }
#'
#' @return
#' A client for the service. You can call the service's operations using
#' syntax like `svc$operation(...)`, where `svc` is the name you've assigned
#' to the client. The available operations are listed in the
#' Operations section.
#'
#' @rdname bedrockagentcore
#' @export
bedrockagentcore <- function(config = list(), credentials = list(), endpoint = NULL, region = NULL) {
  config <- merge_config(
    config,
    list(
      credentials = credentials,
      endpoint = endpoint,
      region = region
    )
  )
  svc <- .bedrockagentcore$operations
  svc <- set_config(svc, config)
  return(svc)
}

# Private API objects: metadata, handlers, interfaces, etc.
.bedrockagentcore <- list()

.bedrockagentcore$operations <- list()

.bedrockagentcore$metadata <- list(
  service_name = "bedrockagentcore",
  endpoints = list("^(us|eu|ap|sa|ca|me|af|il|mx)\\-\\w+\\-\\d+$" = list(endpoint = "bedrock-agentcore.{region}.amazonaws.com", global = FALSE), "^cn\\-\\w+\\-\\d+$" = list(endpoint = "bedrock-agentcore.{region}.amazonaws.com.cn", global = FALSE), "^us\\-gov\\-\\w+\\-\\d+$" = list(endpoint = "bedrock-agentcore.{region}.amazonaws.com", global = FALSE), "^us\\-iso\\-\\w+\\-\\d+$" = list(endpoint = "bedrock-agentcore.{region}.c2s.ic.gov", global = FALSE), "^us\\-isob\\-\\w+\\-\\d+$" = list(endpoint = "bedrock-agentcore.{region}.sc2s.sgov.gov", global = FALSE), "^eu\\-isoe\\-\\w+\\-\\d+$" = list(endpoint = "bedrock-agentcore.{region}.cloud.adc-e.uk", global = FALSE), "^us\\-isof\\-\\w+\\-\\d+$" = list(endpoint = "bedrock-agentcore.{region}.csp.hci.ic.gov", global = FALSE), "^eusc\\-(de)\\-\\w+\\-\\d+$" = list(endpoint = "bedrock-agentcore.{region}.amazonaws.eu", global = FALSE)),
  service_id = "Bedrock AgentCore",
  api_version = "2024-02-28",
  signing_name = "bedrock-agentcore",
  json_version = "",
  target_prefix = ""
)

.bedrockagentcore$service <- function(config = list(), op = NULL) {
  handlers <- new_handlers("restjson", "v4")
  new_service(.bedrockagentcore$metadata, handlers, config, op)
}