pub struct Client { /* private fields */ }Expand description
Client for Amazon Bedrock AgentCore
Client for invoking operations on Amazon Bedrock AgentCore. Each operation on Amazon Bedrock AgentCore is a method on this
this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env() instead, which returns a ConfigLoader that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_bedrockagentcore::Client::new(&config);Occasionally, SDKs may have additional service-specific values that can be set on the Config that
is absent from SdkConfig, or slightly different settings for a specific client may be desired.
The Builder struct implements From<&SdkConfig>, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_bedrockagentcore::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();See the aws-config docs and Config for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the BatchCreateMemoryRecords operation has
a Client::batch_create_memory_records, function which returns a builder for that operation.
The fluent builder ultimately has a send() function that returns an async future that
returns a result, as illustrated below:
let result = client.batch_create_memory_records()
.memory_id("example")
.send()
.await;The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn batch_create_memory_records(
&self,
) -> BatchCreateMemoryRecordsFluentBuilder
pub fn batch_create_memory_records( &self, ) -> BatchCreateMemoryRecordsFluentBuilder
Constructs a fluent builder for the BatchCreateMemoryRecords operation.
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe unique ID of the memory resource where records will be created.
records(MemoryRecordCreateInput)/set_records(Option<Vec::<MemoryRecordCreateInput>>):
required: trueA list of memory record creation inputs to be processed in the batch operation.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotent processing of the batch request.
- On success, responds with
BatchCreateMemoryRecordsOutputwith field(s):successful_records(Vec::<MemoryRecordOutput>):A list of memory records that were successfully created during the batch operation.
failed_records(Vec::<MemoryRecordOutput>):A list of memory records that failed to be created, including error details for each failure.
- On failure, responds with
SdkError<BatchCreateMemoryRecordsError>
Source§impl Client
impl Client
Sourcepub fn batch_delete_memory_records(
&self,
) -> BatchDeleteMemoryRecordsFluentBuilder
pub fn batch_delete_memory_records( &self, ) -> BatchDeleteMemoryRecordsFluentBuilder
Constructs a fluent builder for the BatchDeleteMemoryRecords operation.
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe unique ID of the memory resource where records will be deleted.
records(MemoryRecordDeleteInput)/set_records(Option<Vec::<MemoryRecordDeleteInput>>):
required: trueA list of memory record deletion inputs to be processed in the batch operation.
- On success, responds with
BatchDeleteMemoryRecordsOutputwith field(s):successful_records(Vec::<MemoryRecordOutput>):A list of memory records that were successfully deleted during the batch operation.
failed_records(Vec::<MemoryRecordOutput>):A list of memory records that failed to be deleted, including error details for each failure.
- On failure, responds with
SdkError<BatchDeleteMemoryRecordsError>
Source§impl Client
impl Client
Sourcepub fn batch_update_memory_records(
&self,
) -> BatchUpdateMemoryRecordsFluentBuilder
pub fn batch_update_memory_records( &self, ) -> BatchUpdateMemoryRecordsFluentBuilder
Constructs a fluent builder for the BatchUpdateMemoryRecords operation.
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe unique ID of the memory resource where records will be updated.
records(MemoryRecordUpdateInput)/set_records(Option<Vec::<MemoryRecordUpdateInput>>):
required: trueA list of memory record update inputs to be processed in the batch operation.
- On success, responds with
BatchUpdateMemoryRecordsOutputwith field(s):successful_records(Vec::<MemoryRecordOutput>):A list of memory records that were successfully updated during the batch operation.
failed_records(Vec::<MemoryRecordOutput>):A list of memory records that failed to be updated, including error details for each failure.
- On failure, responds with
SdkError<BatchUpdateMemoryRecordsError>
Source§impl Client
impl Client
Sourcepub fn complete_resource_token_auth(
&self,
) -> CompleteResourceTokenAuthFluentBuilder
pub fn complete_resource_token_auth( &self, ) -> CompleteResourceTokenAuthFluentBuilder
Constructs a fluent builder for the CompleteResourceTokenAuth operation.
- The fluent builder is configurable:
user_identifier(UserIdentifier)/set_user_identifier(Option<UserIdentifier>):
required: trueThe OAuth2.0 token or user ID that was used to generate the workload access token used for initiating the user authorization flow to retrieve OAuth2.0 tokens.
session_uri(impl Into<String>)/set_session_uri(Option<String>):
required: trueUnique identifier for the user’s authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.
- On success, responds with
CompleteResourceTokenAuthOutput - On failure, responds with
SdkError<CompleteResourceTokenAuthError>
Source§impl Client
impl Client
Sourcepub fn create_ab_test(&self) -> CreateABTestFluentBuilder
pub fn create_ab_test(&self) -> CreateABTestFluentBuilder
Constructs a fluent builder for the CreateABTest operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the A/B test. Must be unique within your account.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the A/B test.
gateway_arn(impl Into<String>)/set_gateway_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the gateway to use for traffic splitting.
variants(Variant)/set_variants(Option<Vec::<Variant>>):
required: trueThe list of variants for the A/B test. Must contain exactly two variants: a control (C) and a treatment (T1), each with a configuration bundle or target reference and a traffic weight.
gateway_filter(GatewayFilter)/set_gateway_filter(Option<GatewayFilter>):
required: falseOptional filter to restrict which gateway target paths are included in the A/B test.
evaluation_config(AbTestEvaluationConfig)/set_evaluation_config(Option<AbTestEvaluationConfig>):
required: trueThe evaluation configuration specifying which online evaluation configurations to use for measuring variant performance.
role_arn(impl Into<String>)/set_role_arn(Option<String>):
required: trueThe IAM role ARN that grants permissions for the A/B test to access gateway and evaluation resources.
enable_on_create(bool)/set_enable_on_create(Option<bool>):
required: falseWhether to enable the A/B test immediately upon creation. If true, traffic splitting begins automatically.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to associate with the A/B test.
- On success, responds with
CreateAbTestOutputwith field(s):ab_test_id(String):The unique identifier of the created A/B test.
ab_test_arn(String):The Amazon Resource Name (ARN) of the created A/B test.
name(Option<String>):The name of the A/B test.
status(AbTestStatus):The status of the A/B test.
execution_status(AbTestExecutionStatus):The execution status indicating whether the A/B test is currently running.
created_at(DateTime):The timestamp when the A/B test was created.
- On failure, responds with
SdkError<CreateABTestError>
Source§impl Client
impl Client
Sourcepub fn create_event(&self) -> CreateEventFluentBuilder
pub fn create_event(&self) -> CreateEventFluentBuilder
Constructs a fluent builder for the CreateEvent operation.
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe identifier of the AgentCore Memory resource in which to create the event.
actor_id(impl Into<String>)/set_actor_id(Option<String>):
required: trueThe identifier of the actor associated with this event. An actor represents an entity that participates in sessions and generates events.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: falseThe identifier of the session in which this event occurs. A session represents a sequence of related events.
event_timestamp(DateTime)/set_event_timestamp(Option<DateTime>):
required: trueThe timestamp when the event occurred. If not specified, the current time is used.
payload(PayloadType)/set_payload(Option<Vec::<PayloadType>>):
required: trueThe content payload of the event. This can include conversational data or binary content.
branch(Branch)/set_branch(Option<Branch>):
required: falseThe branch information for this event. Branches allow for organizing events into different conversation threads or paths.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, AgentCore ignores the request, but does not return an error.
metadata(impl Into<String>, MetadataValue)/set_metadata(Option<HashMap::<String, MetadataValue>>):
required: falseThe key-value metadata to attach to the event.
extraction_mode(ExtractionMode)/set_extraction_mode(Option<ExtractionMode>):
required: falseControls long-term memory extraction for this event. When set to
SKIP, the event is stored in short-term memory but is excluded from long-term memory extraction. If not specified, the event is processed for extraction as usual.
- On success, responds with
CreateEventOutputwith field(s):event(Option<Event>):The event that was created.
- On failure, responds with
SdkError<CreateEventError>
Source§impl Client
impl Client
Sourcepub fn create_payment_instrument(&self) -> CreatePaymentInstrumentFluentBuilder
pub fn create_payment_instrument(&self) -> CreatePaymentInstrumentFluentBuilder
Constructs a fluent builder for the CreatePaymentInstrument operation.
- The fluent builder is configurable:
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user ID associated with this payment instrument.
agent_name(impl Into<String>)/set_agent_name(Option<String>):
required: falseThe agent name associated with this request, used for observability.
payment_manager_arn(impl Into<String>)/set_payment_manager_arn(Option<String>):
required: trueThe ARN of the payment manager that owns this payment instrument.
payment_connector_id(impl Into<String>)/set_payment_connector_id(Option<String>):
required: trueThe ID of the payment connector to use for this instrument.
payment_instrument_type(PaymentInstrumentType)/set_payment_instrument_type(Option<PaymentInstrumentType>):
required: trueThe type of payment instrument being created.
payment_instrument_details(PaymentInstrumentDetails)/set_payment_instrument_details(Option<PaymentInstrumentDetails>):
required: trueThe details of the payment instrument.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- On success, responds with
CreatePaymentInstrumentOutputwith field(s):payment_instrument(Option<PaymentInstrument>):The created payment instrument.
- On failure, responds with
SdkError<CreatePaymentInstrumentError>
Source§impl Client
impl Client
Sourcepub fn create_payment_session(&self) -> CreatePaymentSessionFluentBuilder
pub fn create_payment_session(&self) -> CreatePaymentSessionFluentBuilder
Constructs a fluent builder for the CreatePaymentSession operation.
- The fluent builder is configurable:
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user ID associated with this payment session.
agent_name(impl Into<String>)/set_agent_name(Option<String>):
required: falseThe agent name associated with this request, used for observability.
payment_manager_arn(impl Into<String>)/set_payment_manager_arn(Option<String>):
required: trueThe ARN of the payment manager that owns this session.
limits(SessionLimits)/set_limits(Option<SessionLimits>):
required: falseThe spending limits for this payment session.
expiry_time_in_minutes(i32)/set_expiry_time_in_minutes(Option<i32>):
required: trueThe session expiry time in minutes. Must be between 15 and 480 minutes.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- On success, responds with
CreatePaymentSessionOutputwith field(s):payment_session(Option<PaymentSession>):The created payment session.
- On failure, responds with
SdkError<CreatePaymentSessionError>
Source§impl Client
impl Client
Sourcepub fn delete_ab_test(&self) -> DeleteABTestFluentBuilder
pub fn delete_ab_test(&self) -> DeleteABTestFluentBuilder
Constructs a fluent builder for the DeleteABTest operation.
- The fluent builder is configurable:
ab_test_id(impl Into<String>)/set_ab_test_id(Option<String>):
required: trueThe unique identifier of the A/B test to delete.
- On success, responds with
DeleteAbTestOutputwith field(s):ab_test_id(String):The unique identifier of the deleted A/B test.
ab_test_arn(String):The Amazon Resource Name (ARN) of the deleted A/B test.
status(AbTestStatus):The status of the A/B test deletion operation.
- On failure, responds with
SdkError<DeleteABTestError>
Source§impl Client
impl Client
Sourcepub fn delete_batch_evaluation(&self) -> DeleteBatchEvaluationFluentBuilder
pub fn delete_batch_evaluation(&self) -> DeleteBatchEvaluationFluentBuilder
Constructs a fluent builder for the DeleteBatchEvaluation operation.
- The fluent builder is configurable:
batch_evaluation_id(impl Into<String>)/set_batch_evaluation_id(Option<String>):
required: trueThe unique identifier of the batch evaluation to delete.
- On success, responds with
DeleteBatchEvaluationOutputwith field(s):batch_evaluation_id(String):The unique identifier of the deleted batch evaluation.
batch_evaluation_arn(String):The Amazon Resource Name (ARN) of the deleted batch evaluation.
status(BatchEvaluationStatus):The status of the batch evaluation deletion operation.
- On failure, responds with
SdkError<DeleteBatchEvaluationError>
Source§impl Client
impl Client
Sourcepub fn delete_event(&self) -> DeleteEventFluentBuilder
pub fn delete_event(&self) -> DeleteEventFluentBuilder
Constructs a fluent builder for the DeleteEvent operation.
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe identifier of the AgentCore Memory resource from which to delete the event.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueThe identifier of the session containing the event to delete.
event_id(impl Into<String>)/set_event_id(Option<String>):
required: trueThe identifier of the event to delete.
actor_id(impl Into<String>)/set_actor_id(Option<String>):
required: trueThe identifier of the actor associated with the event to delete.
- On success, responds with
DeleteEventOutputwith field(s):event_id(String):The identifier of the event that was deleted.
- On failure, responds with
SdkError<DeleteEventError>
Source§impl Client
impl Client
Sourcepub fn delete_memory_record(&self) -> DeleteMemoryRecordFluentBuilder
pub fn delete_memory_record(&self) -> DeleteMemoryRecordFluentBuilder
Constructs a fluent builder for the DeleteMemoryRecord operation.
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe identifier of the AgentCore Memory resource from which to delete the memory record.
memory_record_id(impl Into<String>)/set_memory_record_id(Option<String>):
required: trueThe identifier of the memory record to delete.
- On success, responds with
DeleteMemoryRecordOutputwith field(s):memory_record_id(String):The identifier of the memory record that was deleted.
- On failure, responds with
SdkError<DeleteMemoryRecordError>
Source§impl Client
impl Client
Sourcepub fn delete_payment_instrument(&self) -> DeletePaymentInstrumentFluentBuilder
pub fn delete_payment_instrument(&self) -> DeletePaymentInstrumentFluentBuilder
Constructs a fluent builder for the DeletePaymentInstrument operation.
- The fluent builder is configurable:
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user ID making the delete request. Must match the instrument’s userId.
payment_manager_arn(impl Into<String>)/set_payment_manager_arn(Option<String>):
required: trueThe payment manager ARN. Must match the instrument’s paymentManagerArn.
payment_connector_id(impl Into<String>)/set_payment_connector_id(Option<String>):
required: trueThe payment connector ID. Must match the instrument’s paymentConnectorId.
payment_instrument_id(impl Into<String>)/set_payment_instrument_id(Option<String>):
required: trueThe payment instrument ID to delete.
- On success, responds with
DeletePaymentInstrumentOutputwith field(s):status(PaymentInstrumentStatus):The status of the instrument after deletion. Always DELETED for successful soft delete.
- On failure, responds with
SdkError<DeletePaymentInstrumentError>
Source§impl Client
impl Client
Sourcepub fn delete_payment_session(&self) -> DeletePaymentSessionFluentBuilder
pub fn delete_payment_session(&self) -> DeletePaymentSessionFluentBuilder
Constructs a fluent builder for the DeletePaymentSession operation.
- The fluent builder is configurable:
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user ID making the delete request. Must match the session’s userId.
payment_manager_arn(impl Into<String>)/set_payment_manager_arn(Option<String>):
required: trueThe payment manager ARN. Must match the session’s paymentManagerArn.
payment_session_id(impl Into<String>)/set_payment_session_id(Option<String>):
required: trueThe payment session ID to delete.
- On success, responds with
DeletePaymentSessionOutputwith field(s):status(PaymentSessionStatus):The status of the deletion. Always DELETED for successful hard delete.
- On failure, responds with
SdkError<DeletePaymentSessionError>
Source§impl Client
impl Client
Sourcepub fn delete_recommendation(&self) -> DeleteRecommendationFluentBuilder
pub fn delete_recommendation(&self) -> DeleteRecommendationFluentBuilder
Constructs a fluent builder for the DeleteRecommendation operation.
- The fluent builder is configurable:
recommendation_id(impl Into<String>)/set_recommendation_id(Option<String>):
required: trueThe unique identifier of the recommendation to delete.
- On success, responds with
DeleteRecommendationOutputwith field(s):recommendation_id(String):The unique identifier of the deleted recommendation.
status(RecommendationStatus):The status of the recommendation deletion operation.
- On failure, responds with
SdkError<DeleteRecommendationError>
Source§impl Client
impl Client
Sourcepub fn evaluate(&self) -> EvaluateFluentBuilder
pub fn evaluate(&self) -> EvaluateFluentBuilder
Constructs a fluent builder for the Evaluate operation.
- The fluent builder is configurable:
evaluator_id(impl Into<String>)/set_evaluator_id(Option<String>):
required: trueThe unique identifier of the evaluator to use for scoring. Can be a built-in evaluator (e.g.,
Builtin.Helpfulness,Builtin.Correctness) or a custom evaluator Id created through the control plane API.evaluation_input(EvaluationInput)/set_evaluation_input(Option<EvaluationInput>):
required: trueThe input data containing agent session spans to be evaluated. Includes a list of spans in OpenTelemetry format from supported frameworks like Strands (AgentCore Runtime) or LangGraph with OpenInference instrumentation.
evaluation_target(EvaluationTarget)/set_evaluation_target(Option<EvaluationTarget>):
required: falseThe specific trace or span IDs to evaluate within the provided input. Allows targeting evaluation at different levels: individual tool calls, single request-response interactions (traces), or entire conversation sessions.
evaluation_reference_inputs(EvaluationReferenceInput)/set_evaluation_reference_inputs(Option<Vec::<EvaluationReferenceInput>>):
required: falseGround truth data to compare against agent responses during evaluation. Allows to provide expected responses, assertions, and expected tool trajectories at different evaluation levels. Session-level reference inputs apply to the entire conversation, while trace-level reference inputs target specific request-response interactions identified by trace ID.
- On success, responds with
EvaluateOutputwith field(s):evaluation_results(Vec::<EvaluationResultContent>):The detailed evaluation results containing scores, explanations, and metadata. Includes the evaluator information, numerical or categorical ratings based on the evaluator’s rating scale, and token usage statistics for the evaluation process.
- On failure, responds with
SdkError<EvaluateError>
Source§impl Client
impl Client
Sourcepub fn get_ab_test(&self) -> GetABTestFluentBuilder
pub fn get_ab_test(&self) -> GetABTestFluentBuilder
Constructs a fluent builder for the GetABTest operation.
- The fluent builder is configurable:
ab_test_id(impl Into<String>)/set_ab_test_id(Option<String>):
required: trueThe unique identifier of the A/B test to retrieve.
- On success, responds with
GetAbTestOutputwith field(s):ab_test_id(String):The unique identifier of the A/B test.
ab_test_arn(String):The Amazon Resource Name (ARN) of the A/B test.
name(String):The name of the A/B test.
description(Option<String>):The description of the A/B test.
status(AbTestStatus):The current status of the A/B test.
execution_status(AbTestExecutionStatus):The execution status indicating whether the A/B test is currently running.
gateway_arn(String):The Amazon Resource Name (ARN) of the gateway used for traffic splitting.
variants(Vec::<Variant>):The list of variants in the A/B test.
gateway_filter(Option<GatewayFilter>):The gateway filter restricting which target paths are included.
evaluation_config(Option<AbTestEvaluationConfig>):The evaluation configuration for measuring variant performance.
role_arn(Option<String>):The IAM role ARN used by the A/B test.
current_run_id(Option<String>):The identifier of the current run of the A/B test.
error_details(Option<Vec::<String>>):The error details if the A/B test encountered failures.
started_at(Option<DateTime>):The timestamp when the A/B test was started.
stopped_at(Option<DateTime>):The timestamp when the A/B test was stopped.
max_duration_expires_at(Option<DateTime>):The timestamp when the A/B test will automatically expire.
created_at(DateTime):The timestamp when the A/B test was created.
updated_at(DateTime):The timestamp when the A/B test was last updated.
results(Option<AbTestResults>):The statistical results of the A/B test, including per-evaluator metrics and significance analysis.
- On failure, responds with
SdkError<GetABTestError>
Source§impl Client
impl Client
Sourcepub fn get_agent_card(&self) -> GetAgentCardFluentBuilder
pub fn get_agent_card(&self) -> GetAgentCardFluentBuilder
Constructs a fluent builder for the GetAgentCard operation.
- The fluent builder is configurable:
runtime_session_id(impl Into<String>)/set_runtime_session_id(Option<String>):
required: falseThe session ID that the AgentCore Runtime agent is using.
agent_runtime_arn(impl Into<String>)/set_agent_runtime_arn(Option<String>):
required: trueThe ARN of the AgentCore Runtime agent for which you want to get the A2A agent card.
qualifier(impl Into<String>)/set_qualifier(Option<String>):
required: falseOptional qualifier to specify an agent alias, such as
prodcode> ordev. If you don’t provide a value, the DEFAULT alias is used.
- On success, responds with
GetAgentCardOutputwith field(s):runtime_session_id(Option<String>):The ID of the session associated with the AgentCore Runtime agent.
agent_card(Document):An agent card document that contains metadata and capabilities for an AgentCore Runtime agent.
status_code(Option<i32>):The status code of the request.
- On failure, responds with
SdkError<GetAgentCardError>
Source§impl Client
impl Client
Sourcepub fn get_batch_evaluation(&self) -> GetBatchEvaluationFluentBuilder
pub fn get_batch_evaluation(&self) -> GetBatchEvaluationFluentBuilder
Constructs a fluent builder for the GetBatchEvaluation operation.
- The fluent builder is configurable:
batch_evaluation_id(impl Into<String>)/set_batch_evaluation_id(Option<String>):
required: trueThe unique identifier of the batch evaluation to retrieve.
- On success, responds with
GetBatchEvaluationOutputwith field(s):batch_evaluation_id(String):The unique identifier of the batch evaluation.
batch_evaluation_arn(String):The Amazon Resource Name (ARN) of the batch evaluation.
batch_evaluation_name(String):The name of the batch evaluation.
status(BatchEvaluationStatus):The current status of the batch evaluation.
created_at(DateTime):The timestamp when the batch evaluation was created.
evaluators(Option<Vec::<Evaluator>>):The list of evaluators applied during the batch evaluation.
insights(Option<Vec::<Insight>>):The list of insight analyses applied during the batch evaluation.
data_source_config(Option<DataSourceConfig>):The data source configuration specifying where agent traces are pulled from.
output_config(Option<OutputConfig>):The output configuration specifying where evaluation results are written.
evaluation_results(Option<EvaluationJobResults>):The aggregated evaluation results, including session completion counts and evaluator score summaries.
failure_analysis_result(Option<FailureAnalysisResultContent>):The failure analysis results from insights, containing categorized failure clusters with root causes and recommendations.
user_intent_result(Option<UserIntentClusteringResultContent>):The user intent clustering results from insights, containing grouped user intents across evaluated sessions.
execution_summary_result(Option<ExecutionSummaryClusteringResultContent>):The execution summary clustering results from insights, containing grouped execution patterns across evaluated sessions.
error_details(Option<Vec::<String>>):The error details if the batch evaluation encountered failures.
description(Option<String>):The description of the batch evaluation.
updated_at(Option<DateTime>):The timestamp when the batch evaluation was last updated.
kms_key_arn(Option<String>):The ARN of the KMS key used to encrypt evaluation data.
- On failure, responds with
SdkError<GetBatchEvaluationError>
Source§impl Client
impl Client
Sourcepub fn get_browser_session(&self) -> GetBrowserSessionFluentBuilder
pub fn get_browser_session(&self) -> GetBrowserSessionFluentBuilder
Constructs a fluent builder for the GetBrowserSession operation.
- The fluent builder is configurable:
browser_identifier(impl Into<String>)/set_browser_identifier(Option<String>):
required: trueThe unique identifier of the browser associated with the session.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueThe unique identifier of the browser session to retrieve.
- On success, responds with
GetBrowserSessionOutputwith field(s):browser_identifier(String):The identifier of the browser.
session_id(String):The identifier of the browser session.
name(Option<String>):The name of the browser session.
created_at(DateTime):The time at which the browser session was created.
view_port(Option<ViewPort>):The configuration that defines the dimensions of a browser viewport in a browser session. The viewport determines the visible area of web content and affects how web pages are rendered and displayed. Proper viewport configuration ensures that web content is displayed correctly for the agent’s browsing tasks.
extensions(Option<Vec::<BrowserExtension>>):The list of browser extensions that are configured in the browser session.
enterprise_policies(Option<Vec::<BrowserEnterprisePolicy>>):A list of files containing enterprise policies for the browser session.
profile_configuration(Option<BrowserProfileConfiguration>):The browser profile configuration associated with this session. Contains the profile identifier that links to persistent browser data such as cookies and local storage.
session_timeout_seconds(Option<i32>):The timeout period for the browser session in seconds.
status(Option<BrowserSessionStatus>):The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
streams(Option<BrowserSessionStream>):The streams associated with this browser session. These include the automation stream and live view stream.
proxy_configuration(Option<ProxyConfiguration>):The active proxy configuration for this browser session. This field is only present if proxy configuration was provided when the session was started using
StartBrowserSession. The configuration includes proxy servers, domain bypass rules and the proxy authentication credentials.certificates(Option<Vec::<Certificate>>):The list of certificates installed in the browser session.
session_replay_artifact(Option<String>):The artifact containing the session replay information.
last_updated_at(Option<DateTime>):The time at which the browser session was last updated.
- On failure, responds with
SdkError<GetBrowserSessionError>
Source§impl Client
impl Client
Sourcepub fn get_code_interpreter_session(
&self,
) -> GetCodeInterpreterSessionFluentBuilder
pub fn get_code_interpreter_session( &self, ) -> GetCodeInterpreterSessionFluentBuilder
Constructs a fluent builder for the GetCodeInterpreterSession operation.
- The fluent builder is configurable:
code_interpreter_identifier(impl Into<String>)/set_code_interpreter_identifier(Option<String>):
required: trueThe unique identifier of the code interpreter associated with the session.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueThe unique identifier of the code interpreter session to retrieve.
- On success, responds with
GetCodeInterpreterSessionOutputwith field(s):code_interpreter_identifier(String):The identifier of the code interpreter.
session_id(String):The identifier of the code interpreter session.
name(Option<String>):The name of the code interpreter session.
created_at(DateTime):The time at which the code interpreter session was created.
session_timeout_seconds(Option<i32>):The timeout period for the code interpreter session in seconds.
status(Option<CodeInterpreterSessionStatus>):The current status of the code interpreter session. Possible values include ACTIVE, STOPPING, and STOPPED.
certificates(Option<Vec::<Certificate>>):The list of certificates installed in the code interpreter session.
- On failure, responds with
SdkError<GetCodeInterpreterSessionError>
Source§impl Client
impl Client
Sourcepub fn get_event(&self) -> GetEventFluentBuilder
pub fn get_event(&self) -> GetEventFluentBuilder
Constructs a fluent builder for the GetEvent operation.
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe identifier of the AgentCore Memory resource containing the event.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueThe identifier of the session containing the event.
actor_id(impl Into<String>)/set_actor_id(Option<String>):
required: trueThe identifier of the actor associated with the event.
event_id(impl Into<String>)/set_event_id(Option<String>):
required: trueThe identifier of the event to retrieve.
- On success, responds with
GetEventOutputwith field(s):event(Option<Event>):The requested event information.
- On failure, responds with
SdkError<GetEventError>
Source§impl Client
impl Client
Sourcepub fn get_memory_record(&self) -> GetMemoryRecordFluentBuilder
pub fn get_memory_record(&self) -> GetMemoryRecordFluentBuilder
Constructs a fluent builder for the GetMemoryRecord operation.
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe identifier of the AgentCore Memory resource containing the memory record.
memory_record_id(impl Into<String>)/set_memory_record_id(Option<String>):
required: trueThe identifier of the memory record to retrieve.
- On success, responds with
GetMemoryRecordOutputwith field(s):memory_record(Option<MemoryRecord>):The requested memory record.
- On failure, responds with
SdkError<GetMemoryRecordError>
Source§impl Client
impl Client
Sourcepub fn get_payment_instrument(&self) -> GetPaymentInstrumentFluentBuilder
pub fn get_payment_instrument(&self) -> GetPaymentInstrumentFluentBuilder
Constructs a fluent builder for the GetPaymentInstrument operation.
- The fluent builder is configurable:
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user ID associated with this payment instrument.
agent_name(impl Into<String>)/set_agent_name(Option<String>):
required: falseThe agent name associated with this request, used for observability.
payment_manager_arn(impl Into<String>)/set_payment_manager_arn(Option<String>):
required: trueThe ARN of the payment manager that owns this payment instrument.
payment_connector_id(impl Into<String>)/set_payment_connector_id(Option<String>):
required: falseThe ID of the payment connector.
payment_instrument_id(impl Into<String>)/set_payment_instrument_id(Option<String>):
required: trueThe ID of the payment instrument to retrieve.
- On success, responds with
GetPaymentInstrumentOutputwith field(s):payment_instrument(Option<PaymentInstrument>):The payment instrument details.
- On failure, responds with
SdkError<GetPaymentInstrumentError>
Source§impl Client
impl Client
Sourcepub fn get_payment_instrument_balance(
&self,
) -> GetPaymentInstrumentBalanceFluentBuilder
pub fn get_payment_instrument_balance( &self, ) -> GetPaymentInstrumentBalanceFluentBuilder
Constructs a fluent builder for the GetPaymentInstrumentBalance operation.
- The fluent builder is configurable:
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user ID associated with this payment instrument.
agent_name(impl Into<String>)/set_agent_name(Option<String>):
required: falseThe agent name associated with this request, used for observability.
payment_manager_arn(impl Into<String>)/set_payment_manager_arn(Option<String>):
required: trueThe ARN of the payment manager that owns this payment instrument.
payment_connector_id(impl Into<String>)/set_payment_connector_id(Option<String>):
required: trueThe ID of the payment connector associated with this instrument.
payment_instrument_id(impl Into<String>)/set_payment_instrument_id(Option<String>):
required: trueThe ID of the payment instrument to query balance for.
chain(BlockchainChainId)/set_chain(Option<BlockchainChainId>):
required: trueThe specific blockchain chain to query balance on. Required because balances are chain-specific.
token(InstrumentBalanceToken)/set_token(Option<InstrumentBalanceToken>):
required: trueThe token to query balance for. Only tokens supported for X402 payments are returned.
- On success, responds with
GetPaymentInstrumentBalanceOutputwith field(s):payment_instrument_id(String):The ID of the payment instrument.
token_balance(Option<TokenBalance>):The balance of the supported token on the requested chain.
- On failure, responds with
SdkError<GetPaymentInstrumentBalanceError>
Source§impl Client
impl Client
Sourcepub fn get_payment_session(&self) -> GetPaymentSessionFluentBuilder
pub fn get_payment_session(&self) -> GetPaymentSessionFluentBuilder
Constructs a fluent builder for the GetPaymentSession operation.
- The fluent builder is configurable:
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user ID associated with this payment session.
agent_name(impl Into<String>)/set_agent_name(Option<String>):
required: falseThe agent name associated with this request, used for observability.
payment_manager_arn(impl Into<String>)/set_payment_manager_arn(Option<String>):
required: trueThe ARN of the payment manager that owns this session.
payment_session_id(impl Into<String>)/set_payment_session_id(Option<String>):
required: trueThe ID of the payment session to retrieve.
- On success, responds with
GetPaymentSessionOutputwith field(s):payment_session(Option<PaymentSession>):The payment session details.
- On failure, responds with
SdkError<GetPaymentSessionError>
Source§impl Client
impl Client
Sourcepub fn get_recommendation(&self) -> GetRecommendationFluentBuilder
pub fn get_recommendation(&self) -> GetRecommendationFluentBuilder
Constructs a fluent builder for the GetRecommendation operation.
- The fluent builder is configurable:
recommendation_id(impl Into<String>)/set_recommendation_id(Option<String>):
required: trueThe unique identifier of the recommendation to retrieve.
- On success, responds with
GetRecommendationOutputwith field(s):recommendation_id(String):The unique identifier of the recommendation.
recommendation_arn(String):The Amazon Resource Name (ARN) of the recommendation.
name(String):The name of the recommendation.
description(Option<String>):The description of the recommendation.
r#type(RecommendationType):The type of recommendation.
recommendation_config(Option<RecommendationConfig>):The configuration for the recommendation.
status(RecommendationStatus):The current status of the recommendation.
created_at(DateTime):The timestamp when the recommendation was created.
updated_at(DateTime):The timestamp when the recommendation was last updated.
recommendation_result(Option<RecommendationResult>):The result of the recommendation, containing the optimized system prompt or tool descriptions. Only present when the recommendation status is
COMPLETED.kms_key_arn(Option<String>):The ARN of the KMS key used to encrypt recommendation data.
- On failure, responds with
SdkError<GetRecommendationError>
Source§impl Client
impl Client
Sourcepub fn get_resource_api_key(&self) -> GetResourceApiKeyFluentBuilder
pub fn get_resource_api_key(&self) -> GetResourceApiKeyFluentBuilder
Constructs a fluent builder for the GetResourceApiKey operation.
- The fluent builder is configurable:
workload_identity_token(impl Into<String>)/set_workload_identity_token(Option<String>):
required: trueThe identity token of the workload from which you want to retrieve the API key.
resource_credential_provider_name(impl Into<String>)/set_resource_credential_provider_name(Option<String>):
required: trueThe credential provider name for the resource from which you are retrieving the API key.
- On success, responds with
GetResourceApiKeyOutputwith field(s):api_key(String):The API key associated with the resource requested.
- On failure, responds with
SdkError<GetResourceApiKeyError>
Source§impl Client
impl Client
Sourcepub fn get_resource_oauth2_token(&self) -> GetResourceOauth2TokenFluentBuilder
pub fn get_resource_oauth2_token(&self) -> GetResourceOauth2TokenFluentBuilder
Constructs a fluent builder for the GetResourceOauth2Token operation.
- The fluent builder is configurable:
workload_identity_token(impl Into<String>)/set_workload_identity_token(Option<String>):
required: trueThe identity token of the workload from which you want to retrieve the OAuth2 token.
resource_credential_provider_name(impl Into<String>)/set_resource_credential_provider_name(Option<String>):
required: trueThe name of the resource’s credential provider.
scopes(impl Into<String>)/set_scopes(Option<Vec::<String>>):
required: trueThe OAuth scopes being requested.
oauth2_flow(Oauth2FlowType)/set_oauth2_flow(Option<Oauth2FlowType>):
required: trueThe type of flow to be performed.
session_uri(impl Into<String>)/set_session_uri(Option<String>):
required: falseUnique identifier for the user’s authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.
resource_oauth2_return_url(impl Into<String>)/set_resource_oauth2_return_url(Option<String>):
required: falseThe callback URL to redirect to after the OAuth 2.0 token retrieval is complete. This URL must be one of the provided URLs configured for the workload identity.
force_authentication(bool)/set_force_authentication(Option<bool>):
required: falseIndicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.
custom_parameters(impl Into<String>, impl Into<String>)/set_custom_parameters(Option<HashMap::<String, String>>):
required: falseA map of custom parameters to include in the authorization request to the resource credential provider. These parameters are in addition to the standard OAuth 2.0 flow parameters, and will not override them.
custom_state(impl Into<String>)/set_custom_state(Option<String>):
required: falseAn opaque string that will be sent back to the callback URL provided in resourceOauth2ReturnUrl. This state should be used to protect the callback URL of your application against CSRF attacks by ensuring the response corresponds to the original request.
resources(impl Into<String>)/set_resources(Option<Vec::<String>>):
required: falseThe resources to include in the token request. These are used to specify the target resources for which the OAuth2 token is being requested.
audiences(impl Into<String>)/set_audiences(Option<Vec::<String>>):
required: falseThe audiences to include in the token request. These are used to specify the intended recipients of the OAuth2 token.
- On success, responds with
GetResourceOauth2TokenOutputwith field(s):authorization_url(Option<String>):The URL to initiate the authorization process, provided when the access token requires user authorization.
access_token(Option<String>):The OAuth 2.0 access token to use.
session_uri(Option<String>):Unique identifier for the user’s authorization session for retrieving OAuth2 tokens. This matches the sessionId from the request and can be used to track the session state.
session_status(Option<SessionStatus>):Status indicating whether the user’s authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow.
- On failure, responds with
SdkError<GetResourceOauth2TokenError>
Source§impl Client
impl Client
Sourcepub fn get_resource_payment_token(&self) -> GetResourcePaymentTokenFluentBuilder
pub fn get_resource_payment_token(&self) -> GetResourcePaymentTokenFluentBuilder
Constructs a fluent builder for the GetResourcePaymentToken operation.
- The fluent builder is configurable:
workload_identity_token(impl Into<String>)/set_workload_identity_token(Option<String>):
required: trueWorkload access token for authorization.
resource_credential_provider_name(impl Into<String>)/set_resource_credential_provider_name(Option<String>):
required: trueName of the payment credential provider to use.
payment_token_request(PaymentTokenRequestInput)/set_payment_token_request(Option<PaymentTokenRequestInput>):
required: trueVendor-specific token request input. Contains all request parameters in a type-safe, vendor-specific structure.
- On success, responds with
GetResourcePaymentTokenOutputwith field(s):payment_token_response(Option<PaymentTokenResponseOutput>):Vendor-specific token response output. Contains all response data in a type-safe, vendor-specific structure.
- On failure, responds with
SdkError<GetResourcePaymentTokenError>
Source§impl Client
impl Client
Sourcepub fn get_workload_access_token(&self) -> GetWorkloadAccessTokenFluentBuilder
pub fn get_workload_access_token(&self) -> GetWorkloadAccessTokenFluentBuilder
Constructs a fluent builder for the GetWorkloadAccessToken operation.
- The fluent builder is configurable:
workload_name(impl Into<String>)/set_workload_name(Option<String>):
required: trueThe unique identifier for the registered workload.
- On success, responds with
GetWorkloadAccessTokenOutputwith field(s):workload_access_token(String):An opaque token representing the identity of both the workload and the user.
- On failure, responds with
SdkError<GetWorkloadAccessTokenError>
Source§impl Client
impl Client
Sourcepub fn get_workload_access_token_for_jwt(
&self,
) -> GetWorkloadAccessTokenForJWTFluentBuilder
pub fn get_workload_access_token_for_jwt( &self, ) -> GetWorkloadAccessTokenForJWTFluentBuilder
Constructs a fluent builder for the GetWorkloadAccessTokenForJWT operation.
- The fluent builder is configurable:
workload_name(impl Into<String>)/set_workload_name(Option<String>):
required: trueThe unique identifier for the registered workload.
user_token(impl Into<String>)/set_user_token(Option<String>):
required: trueThe OAuth 2.0 token issued by the user’s identity provider.
- On success, responds with
GetWorkloadAccessTokenForJwtOutputwith field(s):workload_access_token(String):An opaque token representing the identity of both the workload and the user.
- On failure, responds with
SdkError<GetWorkloadAccessTokenForJWTError>
Source§impl Client
impl Client
Sourcepub fn get_workload_access_token_for_user_id(
&self,
) -> GetWorkloadAccessTokenForUserIdFluentBuilder
pub fn get_workload_access_token_for_user_id( &self, ) -> GetWorkloadAccessTokenForUserIdFluentBuilder
Constructs a fluent builder for the GetWorkloadAccessTokenForUserId operation.
- The fluent builder is configurable:
workload_name(impl Into<String>)/set_workload_name(Option<String>):
required: trueThe name of the workload from which you want to retrieve the access token.
user_id(impl Into<String>)/set_user_id(Option<String>):
required: trueThe ID of the user for whom you are retrieving the access token.
- On success, responds with
GetWorkloadAccessTokenForUserIdOutputwith field(s):workload_access_token(String):The access token for the specified workload.
- On failure, responds with
SdkError<GetWorkloadAccessTokenForUserIdError>
Source§impl Client
impl Client
Sourcepub fn invoke_agent_runtime(&self) -> InvokeAgentRuntimeFluentBuilder
pub fn invoke_agent_runtime(&self) -> InvokeAgentRuntimeFluentBuilder
Constructs a fluent builder for the InvokeAgentRuntime operation.
- The fluent builder is configurable:
content_type(impl Into<String>)/set_content_type(Option<String>):
required: falseThe MIME type of the input data in the payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.
accept(impl Into<String>)/set_accept(Option<String>):
required: falseThe desired MIME type for the response from the agent runtime. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.
mcp_session_id(impl Into<String>)/set_mcp_session_id(Option<String>):
required: falseThe identifier of the MCP session.
runtime_session_id(impl Into<String>)/set_runtime_session_id(Option<String>):
required: falseThe identifier of the runtime session.
mcp_protocol_version(impl Into<String>)/set_mcp_protocol_version(Option<String>):
required: falseThe version of the MCP protocol being used.
runtime_user_id(impl Into<String>)/set_runtime_user_id(Option<String>):
required: falseThe identifier of the runtime user.
trace_id(impl Into<String>)/set_trace_id(Option<String>):
required: falseThe trace identifier for request tracking.
trace_parent(impl Into<String>)/set_trace_parent(Option<String>):
required: falseThe parent trace information for distributed tracing.
trace_state(impl Into<String>)/set_trace_state(Option<String>):
required: falseThe trace state information for distributed tracing.
baggage(impl Into<String>)/set_baggage(Option<String>):
required: falseAdditional context information for distributed tracing.
agent_runtime_arn(impl Into<String>)/set_agent_runtime_arn(Option<String>):
required: trueThe identifier of the agent runtime to invoke. You can specify either the full Amazon Web Services Resource Name (ARN) or the agent ID. If you use the agent ID, you must also provide the
accountIdquery parameter.qualifier(impl Into<String>)/set_qualifier(Option<String>):
required: falseThe qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.
account_id(impl Into<String>)/set_account_id(Option<String>):
required: falseThe identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for
agentRuntimeArn.payload(Blob)/set_payload(Option<Blob>):
required: trueThe input data to send to the agent runtime. The format of this data depends on the specific agent configuration and must match the specified content type. For most agents, this is a JSON object containing the user’s request.
- On success, responds with
InvokeAgentRuntimeOutputwith field(s):runtime_session_id(Option<String>):The identifier of the runtime session.
mcp_session_id(Option<String>):The identifier of the MCP session.
mcp_protocol_version(Option<String>):The version of the MCP protocol being used.
trace_id(Option<String>):The trace identifier for request tracking.
trace_parent(Option<String>):The parent trace information for distributed tracing.
trace_state(Option<String>):The trace state information for distributed tracing.
baggage(Option<String>):Additional context information for distributed tracing.
content_type(String):The MIME type of the response data. This indicates how to interpret the response data. Common values include application/json for JSON data.
response(ByteStream):The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent’s response to the user’s request.
status_code(Option<i32>):The HTTP status code of the response. A status code of 200 indicates a successful operation. Other status codes indicate various error conditions.
- On failure, responds with
SdkError<InvokeAgentRuntimeError>
Source§impl Client
impl Client
Sourcepub fn invoke_agent_runtime_command(
&self,
) -> InvokeAgentRuntimeCommandFluentBuilder
pub fn invoke_agent_runtime_command( &self, ) -> InvokeAgentRuntimeCommandFluentBuilder
Constructs a fluent builder for the InvokeAgentRuntimeCommand operation.
- The fluent builder is configurable:
content_type(impl Into<String>)/set_content_type(Option<String>):
required: falseThe MIME type of the input data in the request payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.
accept(impl Into<String>)/set_accept(Option<String>):
required: falseThe desired MIME type for the response from the agent runtime command. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.
runtime_session_id(impl Into<String>)/set_runtime_session_id(Option<String>):
required: falseThe unique identifier of the runtime session in which to execute the command. This session ID is used to maintain state and context across multiple command invocations.
trace_id(impl Into<String>)/set_trace_id(Option<String>):
required: falseThe trace identifier for request tracking.
trace_parent(impl Into<String>)/set_trace_parent(Option<String>):
required: falseThe parent trace information for distributed tracing.
trace_state(impl Into<String>)/set_trace_state(Option<String>):
required: falseThe trace state information for distributed tracing.
baggage(impl Into<String>)/set_baggage(Option<String>):
required: falseAdditional context information for distributed tracing.
agent_runtime_arn(impl Into<String>)/set_agent_runtime_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the agent runtime on which to execute the command. This identifies the specific agent runtime environment where the command will run.
qualifier(impl Into<String>)/set_qualifier(Option<String>):
required: falseThe qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.
account_id(impl Into<String>)/set_account_id(Option<String>):
required: falseThe identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for
agentRuntimeArn.body(InvokeAgentRuntimeCommandRequestBody)/set_body(Option<InvokeAgentRuntimeCommandRequestBody>):
required: trueThe request body containing the command to execute and optional configuration parameters such as timeout settings.
- On success, responds with
InvokeAgentRuntimeCommandOutputwith field(s):runtime_session_id(Option<String>):The unique identifier of the runtime session in which the command was executed.
trace_id(Option<String>):The trace identifier for request tracking.
trace_parent(Option<String>):The parent trace information for distributed tracing.
trace_state(Option<String>):The trace state information for distributed tracing.
baggage(Option<String>):Additional context information for distributed tracing.
content_type(String):The MIME type of the response data. This indicates how to interpret the response data. Common values include application/json for JSON data.
status_code(Option<i32>):The HTTP status code of the response. A status code of 200 indicates a successful operation. Other status codes indicate various error conditions.
stream(EventReceiver<InvokeAgentRuntimeCommandStreamOutput, InvokeAgentRuntimeCommandStreamOutputError>):The streaming output from the command execution. This stream contains events that provide real-time updates including standard output, standard error, and completion status.
- On failure, responds with
SdkError<InvokeAgentRuntimeCommandError>
Source§impl Client
impl Client
Sourcepub fn invoke_browser(&self) -> InvokeBrowserFluentBuilder
pub fn invoke_browser(&self) -> InvokeBrowserFluentBuilder
Constructs a fluent builder for the InvokeBrowser operation.
- The fluent builder is configurable:
browser_identifier(impl Into<String>)/set_browser_identifier(Option<String>):
required: trueThe unique identifier of the browser associated with the session. This must match the identifier used when creating the session with
StartBrowserSession.session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueThe unique identifier of the browser session on which to perform the action. This must be an active session created with
StartBrowserSession.action(BrowserAction)/set_action(Option<BrowserAction>):
required: trueThe browser action to perform. Exactly one member of the
BrowserActionunion must be set per request.
- On success, responds with
InvokeBrowserOutputwith field(s):result(Option<BrowserActionResult>):The result of the browser action. The member set in the result corresponds to the action that was performed.
session_id(String):The unique identifier of the browser session on which the action was performed.
- On failure, responds with
SdkError<InvokeBrowserError>
Source§impl Client
impl Client
Sourcepub fn invoke_code_interpreter(&self) -> InvokeCodeInterpreterFluentBuilder
pub fn invoke_code_interpreter(&self) -> InvokeCodeInterpreterFluentBuilder
Constructs a fluent builder for the InvokeCodeInterpreter operation.
- The fluent builder is configurable:
code_interpreter_identifier(impl Into<String>)/set_code_interpreter_identifier(Option<String>):
required: trueThe unique identifier of the code interpreter associated with the session. This must match the identifier used when creating the session with
StartCodeInterpreterSession.session_id(impl Into<String>)/set_session_id(Option<String>):
required: falseThe unique identifier of the code interpreter session to use. This must be an active session created with
StartCodeInterpreterSession. If the session has expired or been stopped, the request will fail.trace_id(impl Into<String>)/set_trace_id(Option<String>):
required: falseThe trace identifier for request tracking.
trace_parent(impl Into<String>)/set_trace_parent(Option<String>):
required: falseThe parent trace information for distributed tracing.
name(ToolName)/set_name(Option<ToolName>):
required: trueThe name of the code interpreter to invoke.
arguments(ToolArguments)/set_arguments(Option<ToolArguments>):
required: falseThe arguments for the code interpreter. This includes the code to execute and any additional parameters such as the programming language, whether to clear the execution context, and other execution options. The structure of this parameter depends on the specific code interpreter being used.
- On success, responds with
InvokeCodeInterpreterOutputwith field(s):session_id(Option<String>):The identifier of the code interpreter session.
stream(EventReceiver<CodeInterpreterStreamOutput, CodeInterpreterStreamOutputError>):The stream containing the results of the code execution. This includes output, errors, and execution status.
- On failure, responds with
SdkError<InvokeCodeInterpreterError>
Source§impl Client
impl Client
Sourcepub fn invoke_harness(&self) -> InvokeHarnessFluentBuilder
pub fn invoke_harness(&self) -> InvokeHarnessFluentBuilder
Constructs a fluent builder for the InvokeHarness operation.
- The fluent builder is configurable:
harness_arn(impl Into<String>)/set_harness_arn(Option<String>):
required: trueThe ARN of the harness to invoke.
qualifier(impl Into<String>)/set_qualifier(Option<String>):
required: falseThe endpoint name to invoke. If omitted, the DEFAULT endpoint is used.
runtime_session_id(impl Into<String>)/set_runtime_session_id(Option<String>):
required: trueThe session ID for the invocation. Use the same session ID across requests to continue a conversation.
runtime_user_id(impl Into<String>)/set_runtime_user_id(Option<String>):
required: falseAn identifier for the end user making the request. This value is passed through to the runtime container.
messages(HarnessMessage)/set_messages(Option<Vec::<HarnessMessage>>):
required: trueThe messages to send to the agent.
model(HarnessModelConfiguration)/set_model(Option<HarnessModelConfiguration>):
required: falseThe model configuration to use for this invocation. If specified, overrides the harness default.
system_prompt(HarnessSystemContentBlock)/set_system_prompt(Option<Vec::<HarnessSystemContentBlock>>):
required: falseThe system prompt to use for this invocation. If specified, overrides the harness default.
tools(HarnessTool)/set_tools(Option<Vec::<HarnessTool>>):
required: falseThe tools available to the agent for this invocation. If specified, overrides the harness default.
skills(HarnessSkill)/set_skills(Option<Vec::<HarnessSkill>>):
required: falseThe skills available to the agent for this invocation. If specified, overrides the harness default.
allowed_tools(impl Into<String>)/set_allowed_tools(Option<Vec::<String>>):
required: falseThe tools that the agent is allowed to use for this invocation. If specified, overrides the harness default.
max_iterations(i32)/set_max_iterations(Option<i32>):
required: falseThe maximum number of iterations the agent loop can execute. If specified, overrides the harness default.
max_tokens(i32)/set_max_tokens(Option<i32>):
required: falseThe maximum number of tokens the agent can generate per iteration. If specified, overrides the harness default.
timeout_seconds(i32)/set_timeout_seconds(Option<i32>):
required: falseThe maximum duration in seconds for the agent loop execution. If specified, overrides the harness default.
actor_id(impl Into<String>)/set_actor_id(Option<String>):
required: falseThe actor ID for memory operations. Overrides the actor ID configured on the harness.
- On success, responds with
InvokeHarnessOutputwith field(s):stream(EventReceiver<InvokeHarnessStreamOutput, InvokeHarnessStreamOutputError>):The streaming output from the harness invocation.
- On failure, responds with
SdkError<InvokeHarnessError>
Source§impl Client
impl Client
Sourcepub fn list_ab_tests(&self) -> ListABTestsFluentBuilder
pub fn list_ab_tests(&self) -> ListABTestsFluentBuilder
Constructs a fluent builder for the ListABTests operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseIf the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
- On success, responds with
ListAbTestsOutputwith field(s):ab_tests(Vec::<AbTestSummary>):The list of A/B test summaries.
next_token(Option<String>):If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.
- On failure, responds with
SdkError<ListABTestsError>
Source§impl Client
impl Client
Sourcepub fn list_actors(&self) -> ListActorsFluentBuilder
pub fn list_actors(&self) -> ListActorsFluentBuilder
Constructs a fluent builder for the ListActors operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe identifier of the AgentCore Memory resource for which to list actors.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. The default value is 20.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- On success, responds with
ListActorsOutputwith field(s):actor_summaries(Vec::<ActorSummary>):The list of actor summaries.
next_token(Option<String>):The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
- On failure, responds with
SdkError<ListActorsError>
Source§impl Client
impl Client
Sourcepub fn list_batch_evaluations(&self) -> ListBatchEvaluationsFluentBuilder
pub fn list_batch_evaluations(&self) -> ListBatchEvaluationsFluentBuilder
Constructs a fluent builder for the ListBatchEvaluations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseIf the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
- On success, responds with
ListBatchEvaluationsOutputwith field(s):batch_evaluations(Vec::<BatchEvaluationSummary>):The list of batch evaluation summaries.
next_token(Option<String>):If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.
- On failure, responds with
SdkError<ListBatchEvaluationsError>
Source§impl Client
impl Client
Sourcepub fn list_browser_sessions(&self) -> ListBrowserSessionsFluentBuilder
pub fn list_browser_sessions(&self) -> ListBrowserSessionsFluentBuilder
Constructs a fluent builder for the ListBrowserSessions operation.
- The fluent builder is configurable:
browser_identifier(impl Into<String>)/set_browser_identifier(Option<String>):
required: trueThe unique identifier of the browser to list sessions for. If specified, only sessions for this browser are returned. If not specified, sessions for all browsers are returned.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. The default value is 10. Valid values range from 1 to 100. To retrieve the remaining results, make another call with the returned
nextTokenvalue.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. If not specified, Amazon Bedrock AgentCore returns the first page of results.
status(BrowserSessionStatus)/set_status(Option<BrowserSessionStatus>):
required: falseThe status of the browser sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.
- On success, responds with
ListBrowserSessionsOutputwith field(s):items(Vec::<BrowserSessionSummary>):The list of browser sessions that match the specified criteria.
next_token(Option<String>):The token to use in a subsequent
ListBrowserSessionsrequest to get the next set of results.
- On failure, responds with
SdkError<ListBrowserSessionsError>
Source§impl Client
impl Client
Sourcepub fn list_code_interpreter_sessions(
&self,
) -> ListCodeInterpreterSessionsFluentBuilder
pub fn list_code_interpreter_sessions( &self, ) -> ListCodeInterpreterSessionsFluentBuilder
Constructs a fluent builder for the ListCodeInterpreterSessions operation.
- The fluent builder is configurable:
code_interpreter_identifier(impl Into<String>)/set_code_interpreter_identifier(Option<String>):
required: trueThe unique identifier of the code interpreter to list sessions for. If specified, only sessions for this code interpreter are returned. If not specified, sessions for all code interpreters are returned.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. The default value is 10. Valid values range from 1 to 100. To retrieve the remaining results, make another call with the returned
nextTokenvalue.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. If not specified, Amazon Bedrock AgentCore returns the first page of results.
status(CodeInterpreterSessionStatus)/set_status(Option<CodeInterpreterSessionStatus>):
required: falseThe status of the code interpreter sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.
- On success, responds with
ListCodeInterpreterSessionsOutputwith field(s):items(Vec::<CodeInterpreterSessionSummary>):The list of code interpreter sessions that match the specified criteria.
next_token(Option<String>):The token to use in a subsequent
ListCodeInterpreterSessionsrequest to get the next set of results.
- On failure, responds with
SdkError<ListCodeInterpreterSessionsError>
Source§impl Client
impl Client
Sourcepub fn list_events(&self) -> ListEventsFluentBuilder
pub fn list_events(&self) -> ListEventsFluentBuilder
Constructs a fluent builder for the ListEvents operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe identifier of the AgentCore Memory resource for which to list events.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueThe identifier of the session for which to list events.
actor_id(impl Into<String>)/set_actor_id(Option<String>):
required: trueThe identifier of the actor for which to list events.
include_payloads(bool)/set_include_payloads(Option<bool>):
required: falseSpecifies whether to include event payloads in the response. Set to true to include payloads, or false to exclude them.
filter(FilterInput)/set_filter(Option<FilterInput>):
required: falseFilter criteria to apply when listing events.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. The default value is 20.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- On success, responds with
ListEventsOutputwith field(s):events(Vec::<Event>):The list of events that match the specified criteria.
next_token(Option<String>):The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
- On failure, responds with
SdkError<ListEventsError>
Source§impl Client
impl Client
Sourcepub fn list_memory_extraction_jobs(
&self,
) -> ListMemoryExtractionJobsFluentBuilder
pub fn list_memory_extraction_jobs( &self, ) -> ListMemoryExtractionJobsFluentBuilder
Constructs a fluent builder for the ListMemoryExtractionJobs operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe unique identifier of the memory to list extraction jobs for.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. The default value is 20.
filter(ExtractionJobFilterInput)/set_filter(Option<ExtractionJobFilterInput>):
required: falseFilter criteria to apply when listing extraction jobs.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- On success, responds with
ListMemoryExtractionJobsOutputwith field(s):jobs(Vec::<ExtractionJobMetadata>):List of extraction job metadata matching the specified criteria.
next_token(Option<String>):Token to retrieve the next page of results, if available.
- On failure, responds with
SdkError<ListMemoryExtractionJobsError>
Source§impl Client
impl Client
Sourcepub fn list_memory_records(&self) -> ListMemoryRecordsFluentBuilder
pub fn list_memory_records(&self) -> ListMemoryRecordsFluentBuilder
Constructs a fluent builder for the ListMemoryRecords operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe identifier of the AgentCore Memory resource for which to list memory records.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: falseThe namespace prefix to filter memory records by. Returns all memory records in namespaces that start with the provided prefix. Either
namespaceornamespacePathis required.namespace_path(impl Into<String>)/set_namespace_path(Option<String>):
required: falseUse namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy. Either
namespaceornamespacePathis required.memory_strategy_id(impl Into<String>)/set_memory_strategy_id(Option<String>):
required: falseThe memory strategy identifier to filter memory records by. If specified, only memory records with this strategy ID are returned.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. The default value is 20.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
metadata_filters(MemoryMetadataFilterExpression)/set_metadata_filters(Option<Vec::<MemoryMetadataFilterExpression>>):
required: falseA list of metadata filter expressions to scope the returned memory records.
- On success, responds with
ListMemoryRecordsOutputwith field(s):memory_record_summaries(Vec::<MemoryRecordSummary>):The list of memory record summaries that match the specified criteria.
next_token(Option<String>):The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
- On failure, responds with
SdkError<ListMemoryRecordsError>
Source§impl Client
impl Client
Sourcepub fn list_payment_instruments(&self) -> ListPaymentInstrumentsFluentBuilder
pub fn list_payment_instruments(&self) -> ListPaymentInstrumentsFluentBuilder
Constructs a fluent builder for the ListPaymentInstruments operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user ID associated with the payment instruments.
agent_name(impl Into<String>)/set_agent_name(Option<String>):
required: falseThe agent name associated with this request, used for observability.
payment_manager_arn(impl Into<String>)/set_payment_manager_arn(Option<String>):
required: trueThe ARN of the payment manager that owns the payment instruments.
payment_connector_id(impl Into<String>)/set_payment_connector_id(Option<String>):
required: falseThe ID of the payment connector to filter by.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseToken for pagination to retrieve the next set of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return in a single response.
- On success, responds with
ListPaymentInstrumentsOutputwith field(s):payment_instruments(Vec::<PaymentInstrumentSummary>):List of payment instrument summaries matching the request criteria.
next_token(Option<String>):Token for pagination to retrieve the next set of results.
- On failure, responds with
SdkError<ListPaymentInstrumentsError>
Source§impl Client
impl Client
Sourcepub fn list_payment_sessions(&self) -> ListPaymentSessionsFluentBuilder
pub fn list_payment_sessions(&self) -> ListPaymentSessionsFluentBuilder
Constructs a fluent builder for the ListPaymentSessions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user ID associated with the payment sessions.
agent_name(impl Into<String>)/set_agent_name(Option<String>):
required: falseThe agent name associated with this request, used for observability.
payment_manager_arn(impl Into<String>)/set_payment_manager_arn(Option<String>):
required: trueThe ARN of the payment manager that owns the sessions.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseToken for pagination to retrieve the next set of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return in a single response.
- On success, responds with
ListPaymentSessionsOutputwith field(s):payment_sessions(Vec::<PaymentSessionSummary>):List of payment session summaries matching the request criteria.
next_token(Option<String>):Token for pagination to retrieve the next set of results.
- On failure, responds with
SdkError<ListPaymentSessionsError>
Source§impl Client
impl Client
Sourcepub fn list_recommendations(&self) -> ListRecommendationsFluentBuilder
pub fn list_recommendations(&self) -> ListRecommendationsFluentBuilder
Constructs a fluent builder for the ListRecommendations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseIf the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.status_filter(RecommendationStatus)/set_status_filter(Option<RecommendationStatus>):
required: falseOptional filter to return only recommendations with the specified status.
- On success, responds with
ListRecommendationsOutputwith field(s):recommendation_summaries(Vec::<RecommendationSummary>):The list of recommendation summaries.
next_token(Option<String>):If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.
- On failure, responds with
SdkError<ListRecommendationsError>
Source§impl Client
impl Client
Sourcepub fn list_sessions(&self) -> ListSessionsFluentBuilder
pub fn list_sessions(&self) -> ListSessionsFluentBuilder
Constructs a fluent builder for the ListSessions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe identifier of the AgentCore Memory resource for which to list sessions.
actor_id(impl Into<String>)/set_actor_id(Option<String>):
required: trueThe identifier of the actor for which to list sessions.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. The default value is 20.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
filter(SessionFilter)/set_filter(Option<SessionFilter>):
required: falseFilter criteria to apply when listing sessions.
- On success, responds with
ListSessionsOutputwith field(s):session_summaries(Vec::<SessionSummary>):The list of session summaries that match the specified criteria.
next_token(Option<String>):The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
- On failure, responds with
SdkError<ListSessionsError>
Source§impl Client
impl Client
Sourcepub fn process_payment(&self) -> ProcessPaymentFluentBuilder
pub fn process_payment(&self) -> ProcessPaymentFluentBuilder
Constructs a fluent builder for the ProcessPayment operation.
- The fluent builder is configurable:
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user ID associated with this payment.
agent_name(impl Into<String>)/set_agent_name(Option<String>):
required: falseThe agent name associated with this request, used for observability.
payment_manager_arn(impl Into<String>)/set_payment_manager_arn(Option<String>):
required: trueThe ARN of the payment manager.
payment_session_id(impl Into<String>)/set_payment_session_id(Option<String>):
required: trueThe ID of the payment session.
payment_instrument_id(impl Into<String>)/set_payment_instrument_id(Option<String>):
required: trueThe ID of the payment instrument to use.
payment_type(PaymentType)/set_payment_type(Option<PaymentType>):
required: trueThe type of payment to process.
payment_input(PaymentInput)/set_payment_input(Option<PaymentInput>):
required: trueThe payment input details specific to the payment type.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- On success, responds with
ProcessPaymentOutputwith field(s):process_payment_id(String):The unique identifier of the processed payment.
payment_manager_arn(String):The ARN of the payment manager.
payment_session_id(String):The ID of the payment session used.
payment_instrument_id(String):The ID of the payment instrument used.
payment_type(PaymentType):The type of payment processed.
status(PaymentStatus):The status of the payment.
payment_output(Option<PaymentOutput>):The payment output details specific to the payment type.
created_at(DateTime):The timestamp when the payment was created.
updated_at(DateTime):The timestamp when the payment was last updated.
- On failure, responds with
SdkError<ProcessPaymentError>
Source§impl Client
impl Client
Sourcepub fn retrieve_memory_records(&self) -> RetrieveMemoryRecordsFluentBuilder
pub fn retrieve_memory_records(&self) -> RetrieveMemoryRecordsFluentBuilder
Constructs a fluent builder for the RetrieveMemoryRecords operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe identifier of the AgentCore Memory resource from which to retrieve memory records.
namespace(impl Into<String>)/set_namespace(Option<String>):
required: falseThe namespace prefix to filter memory records by. Searches for memory records in namespaces that start with the provided prefix. Either
namespaceornamespacePathis required.namespace_path(impl Into<String>)/set_namespace_path(Option<String>):
required: falseUse namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy. Either
namespaceornamespacePathis required.search_criteria(SearchCriteria)/set_search_criteria(Option<SearchCriteria>):
required: trueThe search criteria to use for finding relevant memory records. This includes the search query, memory strategy ID, and other search parameters.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. The default value is 20.
- On success, responds with
RetrieveMemoryRecordsOutputwith field(s):memory_record_summaries(Vec::<MemoryRecordSummary>):The list of memory record summaries that match the search criteria, ordered by relevance.
next_token(Option<String>):The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
- On failure, responds with
SdkError<RetrieveMemoryRecordsError>
Source§impl Client
impl Client
Sourcepub fn save_browser_session_profile(
&self,
) -> SaveBrowserSessionProfileFluentBuilder
pub fn save_browser_session_profile( &self, ) -> SaveBrowserSessionProfileFluentBuilder
Constructs a fluent builder for the SaveBrowserSessionProfile operation.
- The fluent builder is configurable:
trace_id(impl Into<String>)/set_trace_id(Option<String>):
required: falseThe trace identifier for request tracking.
trace_parent(impl Into<String>)/set_trace_parent(Option<String>):
required: falseThe parent trace information for distributed tracing.
profile_identifier(impl Into<String>)/set_profile_identifier(Option<String>):
required: trueThe unique identifier for the browser profile. This identifier is used to reference the profile when starting new browser sessions. The identifier must follow the pattern of an alphanumeric name (up to 48 characters) followed by a hyphen and a 10-character alphanumeric suffix.
browser_identifier(impl Into<String>)/set_browser_identifier(Option<String>):
required: trueThe unique identifier of the browser associated with the session from which to save the profile.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueThe unique identifier of the browser session from which to save the profile. The session must be active when saving the profile.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error.
- On success, responds with
SaveBrowserSessionProfileOutputwith field(s):profile_identifier(String):The unique identifier of the saved browser profile.
browser_identifier(String):The unique identifier of the browser associated with the session from which the profile was saved.
session_id(String):The unique identifier of the browser session from which the profile was saved.
last_updated_at(DateTime):The timestamp when the browser profile was last updated. This value is in ISO 8601 format.
- On failure, responds with
SdkError<SaveBrowserSessionProfileError>
Source§impl Client
impl Client
Sourcepub fn search_registry_records(&self) -> SearchRegistryRecordsFluentBuilder
pub fn search_registry_records(&self) -> SearchRegistryRecordsFluentBuilder
Constructs a fluent builder for the SearchRegistryRecords operation.
- The fluent builder is configurable:
search_query(impl Into<String>)/set_search_query(Option<String>):
required: trueThe search query to find matching registry records.
registry_ids(impl Into<String>)/set_registry_ids(Option<Vec::<String>>):
required: trueThe list of registry identifiers to search within. Currently, you can specify exactly one registry identifier. You can provide either the full Amazon Web Services Resource Name (ARN) or the 12-character alphanumeric registry ID.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of records to return in a single call. Valid values are 1 through 20. The default value is 10.
filters(Document)/set_filters(Option<Document>):
required: falseA metadata filter expression to narrow search results. Uses structured JSON operators including field-level operators (
$eq,$ne,$in) and logical operators ($and,$or) on filterable fields (name,descriptorType,version). For example, to filter by descriptor type:{“descriptorType”: {“$eq”: “MCP”}}. To combine filters:{“$and”: [{“descriptorType”: {“$eq”: “MCP”}}, {“name”: {“$eq”: “my-tool”}}]}.
- On success, responds with
SearchRegistryRecordsOutputwith field(s):registry_records(Vec::<RegistryRecordSummary>):The list of registry records that match the search query, ordered by relevance.
- On failure, responds with
SdkError<SearchRegistryRecordsError>
Source§impl Client
impl Client
Sourcepub fn start_batch_evaluation(&self) -> StartBatchEvaluationFluentBuilder
pub fn start_batch_evaluation(&self) -> StartBatchEvaluationFluentBuilder
Constructs a fluent builder for the StartBatchEvaluation operation.
- The fluent builder is configurable:
batch_evaluation_name(impl Into<String>)/set_batch_evaluation_name(Option<String>):
required: trueThe name of the batch evaluation. Must be unique within your account.
evaluators(Evaluator)/set_evaluators(Option<Vec::<Evaluator>>):
required: falseThe list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.
insights(Insight)/set_insights(Option<Vec::<Insight>>):
required: falseThe list of insight analyses to run against sessions during the batch evaluation. Maximum of 10 insights.
data_source_config(DataSourceConfig)/set_data_source_config(Option<DataSourceConfig>):
required: trueThe data source configuration that specifies where to pull agent session traces from for evaluation.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
evaluation_metadata(EvaluationMetadata)/set_evaluation_metadata(Option<EvaluationMetadata>):
required: falseOptional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to associate with the batch evaluation.
kms_key_arn(impl Into<String>)/set_kms_key_arn(Option<String>):
required: falseThe ARN of the KMS key used to encrypt evaluation data. If provided, customer data is encrypted at rest with the specified key.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the batch evaluation.
- On success, responds with
StartBatchEvaluationOutputwith field(s):batch_evaluation_id(String):The unique identifier of the created batch evaluation.
batch_evaluation_arn(String):The Amazon Resource Name (ARN) of the created batch evaluation.
batch_evaluation_name(String):The name of the batch evaluation.
evaluators(Option<Vec::<Evaluator>>):The list of evaluators applied during the batch evaluation.
insights(Option<Vec::<Insight>>):The list of insight analyses applied during the batch evaluation.
status(BatchEvaluationStatus):The status of the batch evaluation.
created_at(DateTime):The timestamp when the batch evaluation was created.
output_config(Option<OutputConfig>):The output configuration specifying where evaluation results are written.
tags(Option<HashMap::<String, String>>):The tags associated with the batch evaluation.
kms_key_arn(Option<String>):The ARN of the KMS key used to encrypt evaluation data.
description(Option<String>):The description of the batch evaluation.
- On failure, responds with
SdkError<StartBatchEvaluationError>
Source§impl Client
impl Client
Sourcepub fn start_browser_session(&self) -> StartBrowserSessionFluentBuilder
pub fn start_browser_session(&self) -> StartBrowserSessionFluentBuilder
Constructs a fluent builder for the StartBrowserSession operation.
- The fluent builder is configurable:
trace_id(impl Into<String>)/set_trace_id(Option<String>):
required: falseThe trace identifier for request tracking.
trace_parent(impl Into<String>)/set_trace_parent(Option<String>):
required: falseThe parent trace information for distributed tracing.
browser_identifier(impl Into<String>)/set_browser_identifier(Option<String>):
required: trueThe unique identifier of the browser to use for this session. This identifier specifies which browser environment to initialize for the session.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe name of the browser session. This name helps you identify and manage the session. The name does not need to be unique.
session_timeout_seconds(i32)/set_session_timeout_seconds(Option<i32>):
required: falseThe duration in seconds (time-to-live) after which the session automatically terminates, regardless of ongoing activity. Defaults to 3600 seconds (1 hour). Recommended minimum: 60 seconds. Maximum allowed: 28,800 seconds (8 hours).
view_port(ViewPort)/set_view_port(Option<ViewPort>):
required: falseThe dimensions of the browser viewport for this session. This determines the visible area of the web content and affects how web pages are rendered. If not specified, Amazon Bedrock AgentCore uses a default viewport size.
extensions(BrowserExtension)/set_extensions(Option<Vec::<BrowserExtension>>):
required: falseA list of browser extensions to load into the browser session.
profile_configuration(BrowserProfileConfiguration)/set_profile_configuration(Option<BrowserProfileConfiguration>):
required: falseThe browser profile configuration to use for this session. A browser profile contains persistent data such as cookies and local storage that can be reused across multiple browser sessions. If specified, the session initializes with the profile’s stored data, enabling continuity for tasks that require authentication or personalized settings.
proxy_configuration(ProxyConfiguration)/set_proxy_configuration(Option<ProxyConfiguration>):
required: falseOptional proxy configuration for routing browser traffic through customer-specified proxy servers. When provided, enables HTTP Basic authentication via Amazon Web Services Secrets Manager and domain-based routing rules. Requires
secretsmanager:GetSecretValueIAM permission for the specified secret ARNs.enterprise_policies(BrowserEnterprisePolicy)/set_enterprise_policies(Option<Vec::<BrowserEnterprisePolicy>>):
required: falseA list of files containing enterprise policies for the browser.
certificates(Certificate)/set_certificates(Option<Vec::<Certificate>>):
required: falseA list of certificates to install in the browser session.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.
- On success, responds with
StartBrowserSessionOutputwith field(s):browser_identifier(String):The identifier of the browser.
session_id(String):The unique identifier of the created browser session.
created_at(DateTime):The timestamp when the browser session was created.
streams(Option<BrowserSessionStream>):The streams associated with this browser session. These include the automation stream and live view stream.
- On failure, responds with
SdkError<StartBrowserSessionError>
Source§impl Client
impl Client
Sourcepub fn start_code_interpreter_session(
&self,
) -> StartCodeInterpreterSessionFluentBuilder
pub fn start_code_interpreter_session( &self, ) -> StartCodeInterpreterSessionFluentBuilder
Constructs a fluent builder for the StartCodeInterpreterSession operation.
- The fluent builder is configurable:
trace_id(impl Into<String>)/set_trace_id(Option<String>):
required: falseThe trace identifier for request tracking.
trace_parent(impl Into<String>)/set_trace_parent(Option<String>):
required: falseThe parent trace information for distributed tracing.
code_interpreter_identifier(impl Into<String>)/set_code_interpreter_identifier(Option<String>):
required: trueThe unique identifier of the code interpreter to use for this session. This identifier specifies which code interpreter environment to initialize for the session.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe name of the code interpreter session. This name helps you identify and manage the session. The name does not need to be unique.
session_timeout_seconds(i32)/set_session_timeout_seconds(Option<i32>):
required: falseThe duration in seconds (time-to-live) after which the session automatically terminates, regardless of ongoing activity. Defaults to 900 seconds (15 minutes). Recommended minimum: 60 seconds. Maximum allowed: 28,800 seconds (8 hours).
certificates(Certificate)/set_certificates(Option<Vec::<Certificate>>):
required: falseA list of certificates to install in the code interpreter session.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.
- On success, responds with
StartCodeInterpreterSessionOutputwith field(s):code_interpreter_identifier(String):The identifier of the code interpreter.
session_id(String):The unique identifier of the created code interpreter session.
created_at(DateTime):The time at which the code interpreter session was created.
- On failure, responds with
SdkError<StartCodeInterpreterSessionError>
Source§impl Client
impl Client
Sourcepub fn start_memory_extraction_job(
&self,
) -> StartMemoryExtractionJobFluentBuilder
pub fn start_memory_extraction_job( &self, ) -> StartMemoryExtractionJobFluentBuilder
Constructs a fluent builder for the StartMemoryExtractionJob operation.
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe unique identifier of the memory for which to start extraction jobs.
extraction_job(ExtractionJob)/set_extraction_job(Option<ExtractionJob>):
required: trueExtraction job to start in this operation.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotent processing of the request.
- On success, responds with
StartMemoryExtractionJobOutputwith field(s):job_id(String):Extraction Job ID that was attempted to start.
- On failure, responds with
SdkError<StartMemoryExtractionJobError>
Source§impl Client
impl Client
Sourcepub fn start_recommendation(&self) -> StartRecommendationFluentBuilder
pub fn start_recommendation(&self) -> StartRecommendationFluentBuilder
Constructs a fluent builder for the StartRecommendation operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the recommendation. Must be unique within your account.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the recommendation.
r#type(RecommendationType)/set_type(Option<RecommendationType>):
required: trueThe type of recommendation to generate. Valid values are
SYSTEM_PROMPT_RECOMMENDATIONfor system prompt optimization orTOOL_DESCRIPTION_RECOMMENDATIONfor tool description optimization.recommendation_config(RecommendationConfig)/set_recommendation_config(Option<RecommendationConfig>):
required: trueThe configuration for the recommendation, including the input to optimize, agent traces to analyze, and evaluation settings.
kms_key_arn(impl Into<String>)/set_kms_key_arn(Option<String>):
required: falseThe ARN of the KMS key used to encrypt recommendation data. If provided, customer data is encrypted at rest with the specified key.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to associate with the recommendation.
- On success, responds with
StartRecommendationOutputwith field(s):recommendation_id(String):The unique identifier of the created recommendation.
recommendation_arn(String):The Amazon Resource Name (ARN) of the created recommendation.
name(String):The name of the recommendation.
description(Option<String>):The description of the recommendation.
r#type(RecommendationType):The type of recommendation.
recommendation_config(Option<RecommendationConfig>):The configuration for the recommendation.
status(RecommendationStatus):The status of the recommendation.
created_at(DateTime):The timestamp when the recommendation was created.
updated_at(DateTime):The timestamp when the recommendation was last updated.
- On failure, responds with
SdkError<StartRecommendationError>
Source§impl Client
impl Client
Sourcepub fn stop_batch_evaluation(&self) -> StopBatchEvaluationFluentBuilder
pub fn stop_batch_evaluation(&self) -> StopBatchEvaluationFluentBuilder
Constructs a fluent builder for the StopBatchEvaluation operation.
- The fluent builder is configurable:
batch_evaluation_id(impl Into<String>)/set_batch_evaluation_id(Option<String>):
required: trueThe unique identifier of the batch evaluation to stop.
- On success, responds with
StopBatchEvaluationOutputwith field(s):batch_evaluation_id(String):The unique identifier of the stopped batch evaluation.
batch_evaluation_arn(String):The Amazon Resource Name (ARN) of the stopped batch evaluation.
status(BatchEvaluationStatus):The status of the batch evaluation after the stop request.
description(Option<String>):The description of the batch evaluation.
- On failure, responds with
SdkError<StopBatchEvaluationError>
Source§impl Client
impl Client
Sourcepub fn stop_browser_session(&self) -> StopBrowserSessionFluentBuilder
pub fn stop_browser_session(&self) -> StopBrowserSessionFluentBuilder
Constructs a fluent builder for the StopBrowserSession operation.
- The fluent builder is configurable:
trace_id(impl Into<String>)/set_trace_id(Option<String>):
required: falseThe trace identifier for request tracking.
trace_parent(impl Into<String>)/set_trace_parent(Option<String>):
required: falseThe parent trace information for distributed tracing.
browser_identifier(impl Into<String>)/set_browser_identifier(Option<String>):
required: trueThe unique identifier of the browser associated with the session.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueThe unique identifier of the browser session to stop.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error.
- On success, responds with
StopBrowserSessionOutputwith field(s):browser_identifier(String):The identifier of the browser.
session_id(String):The identifier of the browser session.
last_updated_at(DateTime):The time at which the browser session was last updated.
- On failure, responds with
SdkError<StopBrowserSessionError>
Source§impl Client
impl Client
Sourcepub fn stop_code_interpreter_session(
&self,
) -> StopCodeInterpreterSessionFluentBuilder
pub fn stop_code_interpreter_session( &self, ) -> StopCodeInterpreterSessionFluentBuilder
Constructs a fluent builder for the StopCodeInterpreterSession operation.
- The fluent builder is configurable:
trace_id(impl Into<String>)/set_trace_id(Option<String>):
required: falseThe trace identifier for request tracking.
trace_parent(impl Into<String>)/set_trace_parent(Option<String>):
required: falseThe parent trace information for distributed tracing.
code_interpreter_identifier(impl Into<String>)/set_code_interpreter_identifier(Option<String>):
required: trueThe unique identifier of the code interpreter associated with the session.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueThe unique identifier of the code interpreter session to stop.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error.
- On success, responds with
StopCodeInterpreterSessionOutputwith field(s):code_interpreter_identifier(String):The identifier of the code interpreter.
session_id(String):The identifier of the code interpreter session.
last_updated_at(DateTime):The timestamp when the code interpreter session was last updated.
- On failure, responds with
SdkError<StopCodeInterpreterSessionError>
Source§impl Client
impl Client
Sourcepub fn stop_runtime_session(&self) -> StopRuntimeSessionFluentBuilder
pub fn stop_runtime_session(&self) -> StopRuntimeSessionFluentBuilder
Constructs a fluent builder for the StopRuntimeSession operation.
- The fluent builder is configurable:
runtime_session_id(impl Into<String>)/set_runtime_session_id(Option<String>):
required: trueThe ID of the session that you want to stop.
agent_runtime_arn(impl Into<String>)/set_agent_runtime_arn(Option<String>):
required: trueThe ARN of the agent that contains the session that you want to stop.
qualifier(impl Into<String>)/set_qualifier(Option<String>):
required: falseOptional qualifier to specify an agent alias, such as
prodcode> ordev. If you don’t provide a value, the DEFAULT alias is used.client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseIdempotent token used to identify the request. If you use the same token with multiple requests, the same response is returned. Use ClientToken to prevent the same request from being processed more than once.
- On success, responds with
StopRuntimeSessionOutputwith field(s):runtime_session_id(Option<String>):The ID of the session that you requested to stop.
status_code(Option<i32>):The status code of the request to stop the session.
- On failure, responds with
SdkError<StopRuntimeSessionError>
Source§impl Client
impl Client
Sourcepub fn update_ab_test(&self) -> UpdateABTestFluentBuilder
pub fn update_ab_test(&self) -> UpdateABTestFluentBuilder
Constructs a fluent builder for the UpdateABTest operation.
- The fluent builder is configurable:
ab_test_id(impl Into<String>)/set_ab_test_id(Option<String>):
required: trueThe unique identifier of the A/B test to update.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe updated name of the A/B test.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description of the A/B test.
variants(Variant)/set_variants(Option<Vec::<Variant>>):
required: falseThe updated list of variants.
gateway_filter(GatewayFilter)/set_gateway_filter(Option<GatewayFilter>):
required: falseThe updated gateway filter.
evaluation_config(AbTestEvaluationConfig)/set_evaluation_config(Option<AbTestEvaluationConfig>):
required: falseThe updated evaluation configuration.
role_arn(impl Into<String>)/set_role_arn(Option<String>):
required: falseThe updated IAM role ARN.
execution_status(AbTestExecutionStatus)/set_execution_status(Option<AbTestExecutionStatus>):
required: falseThe updated execution status to enable or disable the A/B test.
- On success, responds with
UpdateAbTestOutputwith field(s):ab_test_id(String):The unique identifier of the updated A/B test.
ab_test_arn(String):The Amazon Resource Name (ARN) of the updated A/B test.
status(AbTestStatus):The status of the A/B test.
execution_status(AbTestExecutionStatus):The execution status of the A/B test.
updated_at(DateTime):The timestamp when the A/B test was updated.
- On failure, responds with
SdkError<UpdateABTestError>
Source§impl Client
impl Client
Sourcepub fn update_browser_stream(&self) -> UpdateBrowserStreamFluentBuilder
pub fn update_browser_stream(&self) -> UpdateBrowserStreamFluentBuilder
Constructs a fluent builder for the UpdateBrowserStream operation.
- The fluent builder is configurable:
browser_identifier(impl Into<String>)/set_browser_identifier(Option<String>):
required: trueThe identifier of the browser.
session_id(impl Into<String>)/set_session_id(Option<String>):
required: trueThe identifier of the browser session.
stream_update(StreamUpdate)/set_stream_update(Option<StreamUpdate>):
required: trueThe update to apply to the browser stream.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.
- On success, responds with
UpdateBrowserStreamOutputwith field(s):browser_identifier(String):The identifier of the browser.
session_id(String):The identifier of the browser session.
streams(Option<BrowserSessionStream>):The collection of streams associated with a browser session in Amazon Bedrock AgentCore. These streams provide different ways to interact with and observe the browser session, including programmatic control and visual representation of the browser content.
updated_at(DateTime):The time at which the browser stream was updated.
- On failure, responds with
SdkError<UpdateBrowserStreamError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo feature.
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for Client
impl !UnwindSafe for Client
impl Freeze for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl UnsafeUnpin for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);