Struct Client 

pub struct Client { /* private fields */ }

Client for Amazon Bedrock AgentCore Control

Client for invoking operations on Amazon Bedrock AgentCore Control. Each operation on Amazon Bedrock AgentCore Control 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_bedrockagentcorecontrol::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_bedrockagentcorecontrol::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 CreateAgentRuntime operation has a Client::create_agent_runtime, 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.create_agent_runtime()
    .agent_runtime_name("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.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn create_agent_runtime(&self) -> CreateAgentRuntimeFluentBuilder

Constructs a fluent builder for the CreateAgentRuntime operation.

• The fluent builder is configurable:
  • agent_runtime_name(impl Into<String>) / set_agent_runtime_name(Option<String>):
    required: true
    

    The name of the AgentCore Runtime.

    
    
  • agent_runtime_artifact(AgentRuntimeArtifact) / set_agent_runtime_artifact(Option<AgentRuntimeArtifact>):
    required: true
    

    The artifact of the AgentCore Runtime.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The IAM role ARN that provides permissions for the AgentCore Runtime.

    
    
  • network_configuration(NetworkConfiguration) / set_network_configuration(Option<NetworkConfiguration>):
    required: true
    

    The network configuration for the AgentCore Runtime.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the AgentCore Runtime.

    
    
  • authorizer_configuration(AuthorizerConfiguration) / set_authorizer_configuration(Option<AuthorizerConfiguration>):
    required: false
    

    The authorizer configuration for the AgentCore Runtime.

    
    
  • request_header_configuration(RequestHeaderConfiguration) / set_request_header_configuration(Option<RequestHeaderConfiguration>):
    required: false
    

    Configuration for HTTP request headers that will be passed through to the runtime.

    
    
  • protocol_configuration(ProtocolConfiguration) / set_protocol_configuration(Option<ProtocolConfiguration>):
    required: false
    

    The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.

    
    
  • lifecycle_configuration(LifecycleConfiguration) / set_lifecycle_configuration(Option<LifecycleConfiguration>):
    required: false
    

    The life cycle configuration for the AgentCore Runtime.

    
    
  • environment_variables(impl Into<String>, impl Into<String>) / set_environment_variables(Option<HashMap::<String, String>>):
    required: false
    

    Environment variables to set in the AgentCore Runtime environment.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of tag keys and values to assign to the agent runtime. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

    
    
• On success, responds with CreateAgentRuntimeOutput with field(s):
  • agent_runtime_arn(String):

    The Amazon Resource Name (ARN) of the AgentCore Runtime.

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the AgentCore Runtime.

  • agent_runtime_id(String):

    The unique identifier of the AgentCore Runtime.

  • agent_runtime_version(String):

    The version of the AgentCore Runtime.

  • created_at(DateTime):

    The timestamp when the AgentCore Runtime was created.

  • status(AgentRuntimeStatus):

    The current status of the AgentCore Runtime.

• On failure, responds with SdkError<CreateAgentRuntimeError>

impl Client

pub fn create_agent_runtime_endpoint( &self, ) -> CreateAgentRuntimeEndpointFluentBuilder

Constructs a fluent builder for the CreateAgentRuntimeEndpoint operation.

• The fluent builder is configurable:
  • agent_runtime_id(impl Into<String>) / set_agent_runtime_id(Option<String>):
    required: true
    

    The unique identifier of the AgentCore Runtime to create an endpoint for.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the AgentCore Runtime endpoint.

    
    
  • agent_runtime_version(impl Into<String>) / set_agent_runtime_version(Option<String>):
    required: false
    

    The version of the AgentCore Runtime to use for the endpoint.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the AgentCore Runtime endpoint.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of tag keys and values to assign to the agent runtime endpoint. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

    
    
• On success, responds with CreateAgentRuntimeEndpointOutput with field(s):
  • target_version(String):

    The target version of the AgentCore Runtime for the endpoint.

  • agent_runtime_endpoint_arn(String):

    The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

  • agent_runtime_arn(String):

    The Amazon Resource Name (ARN) of the AgentCore Runtime.

  • agent_runtime_id(Option<String>):

    The unique identifier of the AgentCore Runtime.

  • endpoint_name(Option<String>):

    The name of the AgentCore Runtime endpoint.

  • status(AgentRuntimeEndpointStatus):

    The current status of the AgentCore Runtime endpoint.

  • created_at(DateTime):

    The timestamp when the AgentCore Runtime endpoint was created.

• On failure, responds with SdkError<CreateAgentRuntimeEndpointError>

impl Client

pub fn create_api_key_credential_provider( &self, ) -> CreateApiKeyCredentialProviderFluentBuilder

Constructs a fluent builder for the CreateApiKeyCredentialProvider operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the API key credential provider. The name must be unique within your account.

    
    
  • api_key(impl Into<String>) / set_api_key(Option<String>):
    required: true
    

    The API key to use for authentication. This value is encrypted and stored securely.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

    
    
• On success, responds with CreateApiKeyCredentialProviderOutput with field(s):
  • api_key_secret_arn(Option<Secret>):

    The Amazon Resource Name (ARN) of the secret containing the API key.

  • name(String):

    The name of the created API key credential provider.

  • credential_provider_arn(String):

    The Amazon Resource Name (ARN) of the created API key credential provider.

• On failure, responds with SdkError<CreateApiKeyCredentialProviderError>

impl Client

pub fn create_browser(&self) -> CreateBrowserFluentBuilder

Constructs a fluent builder for the CreateBrowser operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the browser. The name must be unique within your account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the browser.

    
    
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role that provides permissions for the browser to access Amazon Web Services services.

    
    
  • network_configuration(BrowserNetworkConfiguration) / set_network_configuration(Option<BrowserNetworkConfiguration>):
    required: true
    

    The network configuration for the browser. This configuration specifies the network mode for the browser.

    
    
  • recording(RecordingConfig) / set_recording(Option<RecordingConfig>):
    required: false
    

    The recording configuration for the browser. When enabled, browser sessions are recorded and stored in the specified Amazon S3 location.

    
    
  • browser_signing(BrowserSigningConfigInput) / set_browser_signing(Option<BrowserSigningConfigInput>):
    required: false
    

    The browser signing configuration that enables cryptographic agent identification using HTTP message signatures for web bot authentication.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A 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.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

    
    
• On success, responds with CreateBrowserOutput with field(s):
  • browser_id(String):

    The unique identifier of the created browser.

  • browser_arn(String):

    The Amazon Resource Name (ARN) of the created browser.

  • created_at(DateTime):

    The timestamp when the browser was created.

  • status(BrowserStatus):

    The current status of the browser.

• On failure, responds with SdkError<CreateBrowserError>

impl Client

pub fn create_code_interpreter(&self) -> CreateCodeInterpreterFluentBuilder

Constructs a fluent builder for the CreateCodeInterpreter operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the code interpreter. The name must be unique within your account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the code interpreter.

    
    
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role that provides permissions for the code interpreter to access Amazon Web Services services.

    
    
  • network_configuration(CodeInterpreterNetworkConfiguration) / set_network_configuration(Option<CodeInterpreterNetworkConfiguration>):
    required: true
    

    The network configuration for the code interpreter. This configuration specifies the network mode for the code interpreter.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A 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.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of tag keys and values to assign to the code interpreter. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

    
    
• On success, responds with CreateCodeInterpreterOutput with field(s):
  • code_interpreter_id(String):

    The unique identifier of the created code interpreter.

  • code_interpreter_arn(String):

    The Amazon Resource Name (ARN) of the created code interpreter.

  • created_at(DateTime):

    The timestamp when the code interpreter was created.

  • status(CodeInterpreterStatus):

    The current status of the code interpreter.

• On failure, responds with SdkError<CreateCodeInterpreterError>

impl Client

pub fn create_evaluator(&self) -> CreateEvaluatorFluentBuilder

Constructs a fluent builder for the CreateEvaluator operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.

    
    
  • evaluator_name(impl Into<String>) / set_evaluator_name(Option<String>):
    required: true
    

    The name of the evaluator. Must be unique within your account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the evaluator that explains its purpose and evaluation criteria.

    
    
  • evaluator_config(EvaluatorConfig) / set_evaluator_config(Option<EvaluatorConfig>):
    required: true
    

    The configuration for the evaluator, including LLM-as-a-Judge settings with instructions, rating scale, and model configuration.

    
    
  • level(EvaluatorLevel) / set_level(Option<EvaluatorLevel>):
    required: true
    

    The evaluation level that determines the scope of evaluation. Valid values are TOOL_CALL for individual tool invocations, TRACE for single request-response interactions, or SESSION for entire conversation sessions.

    
    
• On success, responds with CreateEvaluatorOutput with field(s):
  • evaluator_arn(String):

    The Amazon Resource Name (ARN) of the created evaluator.

  • evaluator_id(String):

    The unique identifier of the created evaluator.

  • created_at(DateTime):

    The timestamp when the evaluator was created.

  • status(EvaluatorStatus):

    The status of the evaluator creation operation.

• On failure, responds with SdkError<CreateEvaluatorError>

impl Client

pub fn create_gateway(&self) -> CreateGatewayFluentBuilder

Constructs a fluent builder for the CreateGateway operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the gateway. The name must be unique within your account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the gateway.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.

    
    
  • protocol_type(GatewayProtocolType) / set_protocol_type(Option<GatewayProtocolType>):
    required: true
    

    The protocol type for the gateway.

    
    
  • protocol_configuration(GatewayProtocolConfiguration) / set_protocol_configuration(Option<GatewayProtocolConfiguration>):
    required: false
    

    The configuration settings for the protocol specified in the protocolType parameter.

    
    
  • authorizer_type(AuthorizerType) / set_authorizer_type(Option<AuthorizerType>):
    required: true
    

    The type of authorizer to use for the gateway.

    • CUSTOM_JWT - Authorize with a bearer token.

    • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

    • NONE - No authorization

    
    
  • authorizer_configuration(AuthorizerConfiguration) / set_authorizer_configuration(Option<AuthorizerConfiguration>):
    required: false
    

    The authorizer configuration for the gateway. Required if authorizerType is CUSTOM_JWT.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.

    
    
  • interceptor_configurations(GatewayInterceptorConfiguration) / set_interceptor_configurations(Option<Vec::<GatewayInterceptorConfiguration>>):
    required: false
    

    A list of configuration settings for a gateway interceptor. Gateway interceptors allow custom code to be invoked during gateway invocations.

    
    
  • policy_engine_configuration(GatewayPolicyEngineConfiguration) / set_policy_engine_configuration(Option<GatewayPolicyEngineConfiguration>):
    required: false
    

    The policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

    
    
  • exception_level(ExceptionLevel) / set_exception_level(Option<ExceptionLevel>):
    required: false
    

    The level of detail in error messages returned when invoking the gateway.

    • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

    • If the value is omitted, a generic error message is returned to the end user.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of key-value pairs to associate with the gateway as metadata tags.

    
    
• On success, responds with CreateGatewayOutput with field(s):
  • gateway_arn(String):

    The Amazon Resource Name (ARN) of the created gateway.

  • gateway_id(String):

    The unique identifier of the created gateway.

  • gateway_url(Option<String>):

    The URL endpoint for the created gateway.

  • created_at(DateTime):

    The timestamp when the gateway was created.

  • updated_at(DateTime):

    The timestamp when the gateway was last updated.

  • status(GatewayStatus):

    The current status of the gateway.

  • status_reasons(Option<Vec::<String>>):

    The reasons for the current status of the gateway.

  • name(String):

    The name of the gateway.

  • description(Option<String>):

    The description of the gateway.

  • role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role associated with the gateway.

  • protocol_type(GatewayProtocolType):

    The protocol type of the gateway.

  • protocol_configuration(Option<GatewayProtocolConfiguration>):

    The configuration settings for the protocol used by the gateway.

  • authorizer_type(AuthorizerType):

    The type of authorizer used by the gateway.

  • authorizer_configuration(Option<AuthorizerConfiguration>):

    The authorizer configuration for the created gateway.

  • kms_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.

  • interceptor_configurations(Option<Vec::<GatewayInterceptorConfiguration>>):

    The list of interceptor configurations for the created gateway.

  • policy_engine_configuration(Option<GatewayPolicyEngineConfiguration>):

    The policy engine configuration for the created gateway.

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the created gateway.

  • exception_level(Option<ExceptionLevel>):

    The level of detail in error messages returned when invoking the gateway.

    • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

    • If the value is omitted, a generic error message is returned to the end user.

• On failure, responds with SdkError<CreateGatewayError>

impl Client

pub fn create_gateway_target(&self) -> CreateGatewayTargetFluentBuilder

Constructs a fluent builder for the CreateGatewayTarget operation.

• The fluent builder is configurable:
  • gateway_identifier(impl Into<String>) / set_gateway_identifier(Option<String>):
    required: true
    

    The identifier of the gateway to create a target for.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the gateway target. The name must be unique within the gateway.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the gateway target.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.

    
    
  • target_configuration(TargetConfiguration) / set_target_configuration(Option<TargetConfiguration>):
    required: true
    

    The configuration settings for the target, including endpoint information and schema definitions.

    
    
  • credential_provider_configurations(CredentialProviderConfiguration) / set_credential_provider_configurations(Option<Vec::<CredentialProviderConfiguration>>):
    required: false
    

    The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.

    
    
• On success, responds with CreateGatewayTargetOutput with field(s):
  • gateway_arn(String):

    The Amazon Resource Name (ARN) of the gateway.

  • target_id(String):

    The unique identifier of the created target.

  • created_at(DateTime):

    The timestamp when the target was created.

  • updated_at(DateTime):

    The timestamp when the target was last updated.

  • status(TargetStatus):

    The current status of the target.

  • status_reasons(Option<Vec::<String>>):

    The reasons for the current status of the target.

  • name(String):

    The name of the target.

  • description(Option<String>):

    The description of the target.

  • target_configuration(Option<TargetConfiguration>):

    The configuration settings for the target.

  • credential_provider_configurations(Vec::<CredentialProviderConfiguration>):

    The credential provider configurations for the target.

  • last_synchronized_at(Option<DateTime>):

    The last synchronization of the target.

• On failure, responds with SdkError<CreateGatewayTargetError>

impl Client

pub fn create_memory(&self) -> CreateMemoryFluentBuilder

Constructs a fluent builder for the CreateMemory operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A 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.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the memory. The name must be unique within your account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the memory.

    
    
  • encryption_key_arn(impl Into<String>) / set_encryption_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the KMS key used to encrypt the memory data.

    
    
  • memory_execution_role_arn(impl Into<String>) / set_memory_execution_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role that provides permissions for the memory to access Amazon Web Services services.

    
    
  • event_expiry_duration(i32) / set_event_expiry_duration(Option<i32>):
    required: true
    

    The duration after which memory events expire. Specified as an ISO 8601 duration.

    
    
  • memory_strategies(MemoryStrategyInput) / set_memory_strategies(Option<Vec::<MemoryStrategyInput>>):
    required: false
    

    The memory strategies to use for this memory. Strategies define how information is extracted, processed, and consolidated.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of tag keys and values to assign to an AgentCore Memory. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

    
    
• On success, responds with CreateMemoryOutput with field(s):
  • memory(Option<Memory>):

    The details of the created memory, including its ID, ARN, name, description, and configuration settings.

• On failure, responds with SdkError<CreateMemoryError>

impl Client

pub fn create_oauth2_credential_provider( &self, ) -> CreateOauth2CredentialProviderFluentBuilder

Constructs a fluent builder for the CreateOauth2CredentialProvider operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the OAuth2 credential provider. The name must be unique within your account.

    
    
  • credential_provider_vendor(CredentialProviderVendorType) / set_credential_provider_vendor(Option<CredentialProviderVendorType>):
    required: true
    

    The vendor of the OAuth2 credential provider. This specifies which OAuth2 implementation to use.

    
    
  • oauth2_provider_config_input(Oauth2ProviderConfigInput) / set_oauth2_provider_config_input(Option<Oauth2ProviderConfigInput>):
    required: true
    

    The configuration settings for the OAuth2 provider, including client ID, client secret, and other vendor-specific settings.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of tag keys and values to assign to the OAuth2 credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

    
    
• On success, responds with CreateOauth2CredentialProviderOutput with field(s):
  • client_secret_arn(Option<Secret>):

    The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager.

  • name(String):

    The name of the OAuth2 credential provider.

  • credential_provider_arn(String):

    The Amazon Resource Name (ARN) of the OAuth2 credential provider.

  • callback_url(Option<String>):

    Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.

  • oauth2_provider_config_output(Option<Oauth2ProviderConfigOutput>):

    Contains the output configuration for an OAuth2 provider.

• On failure, responds with SdkError<CreateOauth2CredentialProviderError>

impl Client

pub fn create_online_evaluation_config( &self, ) -> CreateOnlineEvaluationConfigFluentBuilder

Constructs a fluent builder for the CreateOnlineEvaluationConfig operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.

    
    
  • online_evaluation_config_name(impl Into<String>) / set_online_evaluation_config_name(Option<String>):
    required: true
    

    The name of the online evaluation configuration. Must be unique within your account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the online evaluation configuration that explains its monitoring purpose and scope.

    
    
  • rule(Rule) / set_rule(Option<Rule>):
    required: true
    

    The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.

    
    
  • data_source_config(DataSourceConfig) / set_data_source_config(Option<DataSourceConfig>):
    required: true
    

    The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.

    
    
  • evaluators(EvaluatorReference) / set_evaluators(Option<Vec::<EvaluatorReference>>):
    required: true
    

    The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.

    
    
  • evaluation_execution_role_arn(impl Into<String>) / set_evaluation_execution_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation.

    
    
  • enable_on_create(bool) / set_enable_on_create(Option<bool>):
    required: true
    

    Whether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.

    
    
• On success, responds with CreateOnlineEvaluationConfigOutput with field(s):
  • online_evaluation_config_arn(String):

    The Amazon Resource Name (ARN) of the created online evaluation configuration.

  • online_evaluation_config_id(String):

    The unique identifier of the created online evaluation configuration.

  • created_at(DateTime):

    The timestamp when the online evaluation configuration was created.

  • output_config(Option<OutputConfig>):

    The configuration that specifies where evaluation results should be written for monitoring and analysis.

  • status(OnlineEvaluationConfigStatus):

    The status of the online evaluation configuration.

  • execution_status(OnlineEvaluationExecutionStatus):

    The execution status indicating whether the online evaluation is currently running.

  • failure_reason(Option<String>):

    The reason for failure if the online evaluation configuration creation or execution failed.

• On failure, responds with SdkError<CreateOnlineEvaluationConfigError>

impl Client

pub fn create_policy(&self) -> CreatePolicyFluentBuilder

Constructs a fluent builder for the CreatePolicy operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The customer-assigned immutable name for the policy. Must be unique within the account. This name is used for policy identification and cannot be changed after creation.

    
    
  • definition(PolicyDefinition) / set_definition(Option<PolicyDefinition>):
    required: true
    

    The Cedar policy statement that defines the access control rules. This contains the actual policy logic written in Cedar policy language, specifying effect (permit or forbid), principals, actions, resources, and conditions for agent behavior control.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A human-readable description of the policy’s purpose and functionality (1-4,096 characters). This helps policy administrators understand the policy’s intent, business rules, and operational scope. Use this field to document why the policy exists, what business requirement it addresses, and any special considerations for maintenance. Clear descriptions are essential for policy governance, auditing, and troubleshooting.

    
    
  • validation_mode(PolicyValidationMode) / set_validation_mode(Option<PolicyValidationMode>):
    required: false
    

    The validation mode for the policy creation. Determines how Cedar analyzer validation results are handled during policy creation. FAIL_ON_ANY_FINDINGS (default) runs the Cedar analyzer to validate the policy against the Cedar schema and tool context, failing creation if the analyzer detects any validation issues to ensure strict conformance. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows policy creation even if validation issues are detected, useful for testing or when the policy schema is evolving. Use FAIL_ON_ANY_FINDINGS for production policies to ensure correctness, and IGNORE_ALL_FINDINGS only when you understand and accept the analyzer findings.

    
    
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The identifier of the policy engine which contains this policy. Policy engines group related policies and provide the execution context for policy evaluation.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don’t need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy.

    
    
• On success, responds with CreatePolicyOutput with field(s):
  • policy_id(String):

    The unique identifier for the created policy. This is a system-generated identifier consisting of the user name plus a 10-character generated suffix, used for all subsequent policy operations.

  • name(String):

    The customer-assigned name of the created policy. This matches the name provided in the request and serves as the human-readable identifier for the policy.

  • policy_engine_id(String):

    The identifier of the policy engine that manages this policy. This confirms the policy engine assignment and is used for policy evaluation routing.

  • definition(Option<PolicyDefinition>):

    The Cedar policy statement that was created. This is the validated policy definition that will be used for agent behavior control and access decisions.

  • description(Option<String>):

    The human-readable description of the policy’s purpose and functionality. This helps administrators understand and manage the policy.

  • created_at(DateTime):

    The timestamp when the policy was created. This is automatically set by the service and used for auditing and lifecycle management.

  • updated_at(DateTime):

    The timestamp when the policy was last updated. For newly created policies, this matches the createdAt timestamp.

  • policy_arn(String):

    The Amazon Resource Name (ARN) of the created policy. This globally unique identifier can be used for cross-service references and IAM policy statements.

  • status(PolicyStatus):

    The current status of the policy. A status of ACTIVE indicates the policy is ready for use.

  • status_reasons(Vec::<String>):

    Additional information about the policy status. This provides details about any failures or the current state of the policy creation process.

• On failure, responds with SdkError<CreatePolicyError>

impl Client

pub fn create_policy_engine(&self) -> CreatePolicyEngineFluentBuilder

Constructs a fluent builder for the CreatePolicyEngine operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The customer-assigned immutable name for the policy engine. This name identifies the policy engine and cannot be changed after creation.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A human-readable description of the policy engine’s purpose and scope (1-4,096 characters). This helps administrators understand the policy engine’s role in the overall governance strategy. Document which Gateway this engine will be associated with, what types of tools or workflows it governs, and the team or service responsible for maintaining it. Clear descriptions are essential when managing multiple policy engines across different services or environments.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy engine.

    
    
• On success, responds with CreatePolicyEngineOutput with field(s):
  • policy_engine_id(String):

    The unique identifier for the created policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and is used for all subsequent policy engine operations.

  • name(String):

    The customer-assigned name of the created policy engine. This matches the name provided in the request and serves as the human-readable identifier.

  • description(Option<String>):

    A human-readable description of the policy engine’s purpose.

  • created_at(DateTime):

    The timestamp when the policy engine was created. This is automatically set by the service and used for auditing and lifecycle management.

  • updated_at(DateTime):

    The timestamp when the policy engine was last updated. For newly created policy engines, this matches the createdAt timestamp.

  • policy_engine_arn(String):

    The Amazon Resource Name (ARN) of the created policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.

  • status(PolicyEngineStatus):

    The current status of the policy engine. A status of ACTIVE indicates the policy engine is ready for use.

  • status_reasons(Vec::<String>):

    Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine creation process.

• On failure, responds with SdkError<CreatePolicyEngineError>

impl Client

pub fn create_workload_identity(&self) -> CreateWorkloadIdentityFluentBuilder

Constructs a fluent builder for the CreateWorkloadIdentity operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the workload identity. The name must be unique within your account.

    
    
  • allowed_resource_oauth2_return_urls(impl Into<String>) / set_allowed_resource_oauth2_return_urls(Option<Vec::<String>>):
    required: false
    

    The list of allowed OAuth2 return URLs for resources associated with this workload identity.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of tag keys and values to assign to the workload identity. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

    
    
• On success, responds with CreateWorkloadIdentityOutput with field(s):
  • name(String):

    The name of the workload identity.

  • workload_identity_arn(String):

    The Amazon Resource Name (ARN) of the workload identity.

  • allowed_resource_oauth2_return_urls(Option<Vec::<String>>):

    The list of allowed OAuth2 return URLs for resources associated with this workload identity.

• On failure, responds with SdkError<CreateWorkloadIdentityError>

impl Client

pub fn delete_agent_runtime(&self) -> DeleteAgentRuntimeFluentBuilder

Constructs a fluent builder for the DeleteAgentRuntime operation.

• The fluent builder is configurable:
  • agent_runtime_id(impl Into<String>) / set_agent_runtime_id(Option<String>):
    required: true
    

    The unique identifier of the AgentCore Runtime to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

    
    
• On success, responds with DeleteAgentRuntimeOutput with field(s):
  • status(AgentRuntimeStatus):

    The current status of the AgentCore Runtime deletion.

  • agent_runtime_id(Option<String>):

    The unique identifier of the AgentCore Runtime.

• On failure, responds with SdkError<DeleteAgentRuntimeError>

impl Client

pub fn delete_agent_runtime_endpoint( &self, ) -> DeleteAgentRuntimeEndpointFluentBuilder

Constructs a fluent builder for the DeleteAgentRuntimeEndpoint operation.

• The fluent builder is configurable:
  • agent_runtime_id(impl Into<String>) / set_agent_runtime_id(Option<String>):
    required: true
    

    The unique identifier of the AgentCore Runtime associated with the endpoint.

    
    
  • endpoint_name(impl Into<String>) / set_endpoint_name(Option<String>):
    required: true
    

    The name of the AgentCore Runtime endpoint to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with DeleteAgentRuntimeEndpointOutput with field(s):
  • status(AgentRuntimeEndpointStatus):

    The current status of the AgentCore Runtime endpoint deletion.

  • agent_runtime_id(Option<String>):

    The unique identifier of the AgentCore Runtime.

  • endpoint_name(Option<String>):

    The name of the AgentCore Runtime endpoint.

• On failure, responds with SdkError<DeleteAgentRuntimeEndpointError>

impl Client

pub fn delete_api_key_credential_provider( &self, ) -> DeleteApiKeyCredentialProviderFluentBuilder

Constructs a fluent builder for the DeleteApiKeyCredentialProvider operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the API key credential provider to delete.

    
    
• On success, responds with DeleteApiKeyCredentialProviderOutput
• On failure, responds with SdkError<DeleteApiKeyCredentialProviderError>

impl Client

pub fn delete_browser(&self) -> DeleteBrowserFluentBuilder

Constructs a fluent builder for the DeleteBrowser operation.

• The fluent builder is configurable:
  • browser_id(impl Into<String>) / set_browser_id(Option<String>):
    required: true
    

    The unique identifier of the browser to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with DeleteBrowserOutput with field(s):
  • browser_id(String):

    The unique identifier of the deleted browser.

  • status(BrowserStatus):

    The current status of the browser deletion.

  • last_updated_at(DateTime):

    The timestamp when the browser was last updated.

• On failure, responds with SdkError<DeleteBrowserError>

impl Client

pub fn delete_code_interpreter(&self) -> DeleteCodeInterpreterFluentBuilder

Constructs a fluent builder for the DeleteCodeInterpreter operation.

• The fluent builder is configurable:
  • code_interpreter_id(impl Into<String>) / set_code_interpreter_id(Option<String>):
    required: true
    

    The unique identifier of the code interpreter to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with DeleteCodeInterpreterOutput with field(s):
  • code_interpreter_id(String):

    The unique identifier of the deleted code interpreter.

  • status(CodeInterpreterStatus):

    The current status of the code interpreter deletion.

  • last_updated_at(DateTime):

    The timestamp when the code interpreter was last updated.

• On failure, responds with SdkError<DeleteCodeInterpreterError>

impl Client

pub fn delete_evaluator(&self) -> DeleteEvaluatorFluentBuilder

Constructs a fluent builder for the DeleteEvaluator operation.

• The fluent builder is configurable:
  • evaluator_id(impl Into<String>) / set_evaluator_id(Option<String>):
    required: true
    

    The unique identifier of the evaluator to delete.

    
    
• On success, responds with DeleteEvaluatorOutput with field(s):
  • evaluator_arn(String):

    The Amazon Resource Name (ARN) of the deleted evaluator.

  • evaluator_id(String):

    The unique identifier of the deleted evaluator.

  • status(EvaluatorStatus):

    The status of the evaluator deletion operation.

• On failure, responds with SdkError<DeleteEvaluatorError>

impl Client

pub fn delete_gateway(&self) -> DeleteGatewayFluentBuilder

Constructs a fluent builder for the DeleteGateway operation.

• The fluent builder is configurable:
  • gateway_identifier(impl Into<String>) / set_gateway_identifier(Option<String>):
    required: true
    

    The identifier of the gateway to delete.

    
    
• On success, responds with DeleteGatewayOutput with field(s):
  • gateway_id(String):

    The unique identifier of the deleted gateway.

  • status(GatewayStatus):

    The current status of the gateway deletion.

  • status_reasons(Option<Vec::<String>>):

    The reasons for the current status of the gateway deletion.

• On failure, responds with SdkError<DeleteGatewayError>

impl Client

pub fn delete_gateway_target(&self) -> DeleteGatewayTargetFluentBuilder

Constructs a fluent builder for the DeleteGatewayTarget operation.

• The fluent builder is configurable:
  • gateway_identifier(impl Into<String>) / set_gateway_identifier(Option<String>):
    required: true
    

    The unique identifier of the gateway associated with the target.

    
    
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: true
    

    The unique identifier of the gateway target to delete.

    
    
• On success, responds with DeleteGatewayTargetOutput with field(s):
  • gateway_arn(String):

    The Amazon Resource Name (ARN) of the gateway.

  • target_id(String):

    The unique identifier of the deleted gateway target.

  • status(TargetStatus):

    The current status of the gateway target deletion.

  • status_reasons(Option<Vec::<String>>):

    The reasons for the current status of the gateway target deletion.

• On failure, responds with SdkError<DeleteGatewayTargetError>

impl Client

pub fn delete_memory(&self) -> DeleteMemoryFluentBuilder

Constructs a fluent builder for the DeleteMemory operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique AWS identifier.

    
    
  • memory_id(impl Into<String>) / set_memory_id(Option<String>):
    required: true
    

    The unique identifier of the memory to delete.

    
    
• On success, responds with DeleteMemoryOutput with field(s):
  • memory_id(String):

    The unique identifier of the deleted AgentCore Memory resource.

  • status(Option<MemoryStatus>):

    The current status of the AgentCore Memory resource deletion.

• On failure, responds with SdkError<DeleteMemoryError>

impl Client

pub fn delete_oauth2_credential_provider( &self, ) -> DeleteOauth2CredentialProviderFluentBuilder

Constructs a fluent builder for the DeleteOauth2CredentialProvider operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the OAuth2 credential provider to delete.

    
    
• On success, responds with DeleteOauth2CredentialProviderOutput
• On failure, responds with SdkError<DeleteOauth2CredentialProviderError>

impl Client

pub fn delete_online_evaluation_config( &self, ) -> DeleteOnlineEvaluationConfigFluentBuilder

Constructs a fluent builder for the DeleteOnlineEvaluationConfig operation.

• The fluent builder is configurable:
  • online_evaluation_config_id(impl Into<String>) / set_online_evaluation_config_id(Option<String>):
    required: true
    

    The unique identifier of the online evaluation configuration to delete.

    
    
• On success, responds with DeleteOnlineEvaluationConfigOutput with field(s):
  • online_evaluation_config_arn(String):

    The Amazon Resource Name (ARN) of the deleted online evaluation configuration.

  • online_evaluation_config_id(String):

    The unique identifier of the deleted online evaluation configuration.

  • status(OnlineEvaluationConfigStatus):

    The status of the online evaluation configuration deletion operation.

• On failure, responds with SdkError<DeleteOnlineEvaluationConfigError>

impl Client

pub fn delete_policy(&self) -> DeletePolicyFluentBuilder

Constructs a fluent builder for the DeletePolicy operation.

• The fluent builder is configurable:
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The identifier of the policy engine that manages the policy to be deleted. This ensures the policy is deleted from the correct policy engine context.

    
    
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The unique identifier of the policy to be deleted. This must be a valid policy ID that exists within the specified policy engine.

    
    
• On success, responds with DeletePolicyOutput with field(s):
  • policy_id(String):

    The unique identifier of the policy being deleted. This confirms which policy the deletion operation targets.

  • name(String):

    The customer-assigned name of the deleted policy. This confirms which policy was successfully removed from the system and matches the name that was originally assigned during policy creation.

  • policy_engine_id(String):

    The identifier of the policy engine from which the policy was deleted. This confirms the policy engine context for the deletion operation.

  • definition(Option<PolicyDefinition>):

    Represents the definition structure for policies within the AgentCore Policy system. This structure encapsulates different policy formats and languages that can be used to define access control rules.

  • description(Option<String>):

    The human-readable description of the deleted policy.

  • created_at(DateTime):

    The timestamp when the deleted policy was originally created.

  • updated_at(DateTime):

    The timestamp when the deleted policy was last modified before deletion. This tracks the final state of the policy before it was removed from the system.

  • policy_arn(String):

    The Amazon Resource Name (ARN) of the deleted policy. This globally unique identifier confirms which policy resource was successfully removed.

  • status(PolicyStatus):

    The status of the policy deletion operation. This provides information about any issues that occurred during the deletion process.

  • status_reasons(Vec::<String>):

    Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.

• On failure, responds with SdkError<DeletePolicyError>

impl Client

pub fn delete_policy_engine(&self) -> DeletePolicyEngineFluentBuilder

Constructs a fluent builder for the DeletePolicyEngine operation.

• The fluent builder is configurable:
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The unique identifier of the policy engine to be deleted. This must be a valid policy engine ID that exists within the account.

    
    
• On success, responds with DeletePolicyEngineOutput with field(s):
  • policy_engine_id(String):

    The unique identifier of the policy engine being deleted. This confirms which policy engine the deletion operation targets.

  • name(String):

    The customer-assigned name of the deleted policy engine.

  • description(Option<String>):

    The human-readable description of the deleted policy engine.

  • created_at(DateTime):

    The timestamp when the deleted policy engine was originally created.

  • updated_at(DateTime):

    The timestamp when the deleted policy engine was last modified before deletion. This tracks the final state of the policy engine before it was removed from the system.

  • policy_engine_arn(String):

    The Amazon Resource Name (ARN) of the deleted policy engine. This globally unique identifier confirms which policy engine resource was successfully removed.

  • status(PolicyEngineStatus):

    The status of the policy engine deletion operation. This provides status about any issues that occurred during the deletion process.

  • status_reasons(Vec::<String>):

    Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.

• On failure, responds with SdkError<DeletePolicyEngineError>

impl Client

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource for which to delete the resource policy.

    
    
• On success, responds with DeleteResourcePolicyOutput
• On failure, responds with SdkError<DeleteResourcePolicyError>

impl Client

pub fn delete_workload_identity(&self) -> DeleteWorkloadIdentityFluentBuilder

Constructs a fluent builder for the DeleteWorkloadIdentity operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the workload identity to delete.

    
    
• On success, responds with DeleteWorkloadIdentityOutput
• On failure, responds with SdkError<DeleteWorkloadIdentityError>

impl Client

pub fn get_agent_runtime(&self) -> GetAgentRuntimeFluentBuilder

Constructs a fluent builder for the GetAgentRuntime operation.

• The fluent builder is configurable:
  • agent_runtime_id(impl Into<String>) / set_agent_runtime_id(Option<String>):
    required: true
    

    The unique identifier of the AgentCore Runtime to retrieve.

    
    
  • agent_runtime_version(impl Into<String>) / set_agent_runtime_version(Option<String>):
    required: false
    

    The version of the AgentCore Runtime to retrieve.

    
    
• On success, responds with GetAgentRuntimeOutput with field(s):
  • agent_runtime_arn(String):

    The Amazon Resource Name (ARN) of the AgentCore Runtime.

  • agent_runtime_name(String):

    The name of the AgentCore Runtime.

  • agent_runtime_id(String):

    The unique identifier of the AgentCore Runtime.

  • agent_runtime_version(String):

    The version of the AgentCore Runtime.

  • created_at(DateTime):

    The timestamp when the AgentCore Runtime was created.

  • last_updated_at(DateTime):

    The timestamp when the AgentCore Runtime was last updated.

  • role_arn(String):

    The IAM role ARN that provides permissions for the AgentCore Runtime.

  • network_configuration(Option<NetworkConfiguration>):

    The network configuration for the AgentCore Runtime.

  • status(AgentRuntimeStatus):

    The current status of the AgentCore Runtime.

  • lifecycle_configuration(Option<LifecycleConfiguration>):

    The life cycle configuration for the AgentCore Runtime.

  • failure_reason(Option<String>):

    The reason for failure if the AgentCore Runtime is in a failed state.

  • description(Option<String>):

    The description of the AgentCore Runtime.

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the AgentCore Runtime.

  • agent_runtime_artifact(Option<AgentRuntimeArtifact>):

    The artifact of the AgentCore Runtime.

  • protocol_configuration(Option<ProtocolConfiguration>):

    The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.

  • environment_variables(Option<HashMap::<String, String>>):

    Environment variables set in the AgentCore Runtime environment.

  • authorizer_configuration(Option<AuthorizerConfiguration>):

    The authorizer configuration for the AgentCore Runtime.

  • request_header_configuration(Option<RequestHeaderConfiguration>):

    Configuration for HTTP request headers that will be passed through to the runtime.

• On failure, responds with SdkError<GetAgentRuntimeError>

impl Client

pub fn get_agent_runtime_endpoint(&self) -> GetAgentRuntimeEndpointFluentBuilder

Constructs a fluent builder for the GetAgentRuntimeEndpoint operation.

• The fluent builder is configurable:
  • agent_runtime_id(impl Into<String>) / set_agent_runtime_id(Option<String>):
    required: true
    

    The unique identifier of the AgentCore Runtime associated with the endpoint.

    
    
  • endpoint_name(impl Into<String>) / set_endpoint_name(Option<String>):
    required: true
    

    The name of the AgentCore Runtime endpoint to retrieve.

    
    
• On success, responds with GetAgentRuntimeEndpointOutput with field(s):
  • live_version(Option<String>):

    The currently deployed version of the AgentCore Runtime on the endpoint.

  • target_version(Option<String>):

    The target version of the AgentCore Runtime for the endpoint.

  • agent_runtime_endpoint_arn(String):

    The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

  • agent_runtime_arn(String):

    The Amazon Resource Name (ARN) of the AgentCore Runtime.

  • description(Option<String>):

    The description of the AgentCore Runtime endpoint.

  • status(AgentRuntimeEndpointStatus):

    The current status of the AgentCore Runtime endpoint.

  • created_at(DateTime):

    The timestamp when the AgentCore Runtime endpoint was created.

  • last_updated_at(DateTime):

    The timestamp when the AgentCore Runtime endpoint was last updated.

  • failure_reason(Option<String>):

    The reason for failure if the AgentCore Runtime endpoint is in a failed state.

  • name(String):

    The name of the AgentCore Runtime endpoint.

  • id(String):

    The unique identifier of the AgentCore Runtime endpoint.

• On failure, responds with SdkError<GetAgentRuntimeEndpointError>

impl Client

pub fn get_api_key_credential_provider( &self, ) -> GetApiKeyCredentialProviderFluentBuilder

Constructs a fluent builder for the GetApiKeyCredentialProvider operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the API key credential provider to retrieve.

    
    
• On success, responds with GetApiKeyCredentialProviderOutput with field(s):
  • api_key_secret_arn(Option<Secret>):

    The Amazon Resource Name (ARN) of the API key secret in AWS Secrets Manager.

  • name(String):

    The name of the API key credential provider.

  • credential_provider_arn(String):

    The Amazon Resource Name (ARN) of the API key credential provider.

  • created_time(DateTime):

    The timestamp when the API key credential provider was created.

  • last_updated_time(DateTime):

    The timestamp when the API key credential provider was last updated.

• On failure, responds with SdkError<GetApiKeyCredentialProviderError>

impl Client

pub fn get_browser(&self) -> GetBrowserFluentBuilder

Constructs a fluent builder for the GetBrowser operation.

• The fluent builder is configurable:
  • browser_id(impl Into<String>) / set_browser_id(Option<String>):
    required: true
    

    The unique identifier of the browser to retrieve.

    
    
• On success, responds with GetBrowserOutput with field(s):
  • browser_id(String):

    The unique identifier of the browser.

  • browser_arn(String):

    The Amazon Resource Name (ARN) of the browser.

  • name(String):

    The name of the browser.

  • description(Option<String>):

    The description of the browser.

  • execution_role_arn(Option<String>):

    The IAM role ARN that provides permissions for the browser.

  • network_configuration(Option<BrowserNetworkConfiguration>):

    The network configuration for a browser. This structure defines how the browser connects to the network.

  • recording(Option<RecordingConfig>):

    The recording configuration for a browser. This structure defines how browser sessions are recorded.

  • browser_signing(Option<BrowserSigningConfigOutput>):

    The browser signing configuration that shows whether cryptographic agent identification is enabled for web bot authentication.

  • status(BrowserStatus):

    The current status of the browser.

  • failure_reason(Option<String>):

    The reason for failure if the browser is in a failed state.

  • created_at(DateTime):

    The timestamp when the browser was created.

  • last_updated_at(DateTime):

    The timestamp when the browser was last updated.

• On failure, responds with SdkError<GetBrowserError>

impl Client

pub fn get_code_interpreter(&self) -> GetCodeInterpreterFluentBuilder

Constructs a fluent builder for the GetCodeInterpreter operation.

• The fluent builder is configurable:
  • code_interpreter_id(impl Into<String>) / set_code_interpreter_id(Option<String>):
    required: true
    

    The unique identifier of the code interpreter to retrieve.

    
    
• On success, responds with GetCodeInterpreterOutput with field(s):
  • code_interpreter_id(String):

    The unique identifier of the code interpreter.

  • code_interpreter_arn(String):

    The Amazon Resource Name (ARN) of the code interpreter.

  • name(String):

    The name of the code interpreter.

  • description(Option<String>):

    The description of the code interpreter.

  • execution_role_arn(Option<String>):

    The IAM role ARN that provides permissions for the code interpreter.

  • network_configuration(Option<CodeInterpreterNetworkConfiguration>):

    The network configuration for a code interpreter. This structure defines how the code interpreter connects to the network.

  • status(CodeInterpreterStatus):

    The current status of the code interpreter.

  • failure_reason(Option<String>):

    The reason for failure if the code interpreter is in a failed state.

  • created_at(DateTime):

    The timestamp when the code interpreter was created.

  • last_updated_at(DateTime):

    The timestamp when the code interpreter was last updated.

• On failure, responds with SdkError<GetCodeInterpreterError>

impl Client

pub fn get_evaluator(&self) -> GetEvaluatorFluentBuilder

Constructs a fluent builder for the GetEvaluator operation.

• The fluent builder is configurable:
  • evaluator_id(impl Into<String>) / set_evaluator_id(Option<String>):
    required: true
    

    The unique identifier of the evaluator to retrieve. Can be a built-in evaluator ID (e.g., Builtin.Helpfulness) or a custom evaluator ID.

    
    
• On success, responds with GetEvaluatorOutput with field(s):
  • evaluator_arn(String):

    The Amazon Resource Name (ARN) of the evaluator.

  • evaluator_id(String):

    The unique identifier of the evaluator.

  • evaluator_name(String):

    The name of the evaluator.

  • description(Option<String>):

    The description of the evaluator.

  • evaluator_config(Option<EvaluatorConfig>):

    The configuration of the evaluator, including LLM-as-a-Judge settings for custom evaluators.

  • level(EvaluatorLevel):

    The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

  • status(EvaluatorStatus):

    The current status of the evaluator.

  • created_at(DateTime):

    The timestamp when the evaluator was created.

  • updated_at(DateTime):

    The timestamp when the evaluator was last updated.

  • locked_for_modification(Option<bool>):

    Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.

• On failure, responds with SdkError<GetEvaluatorError>

impl Client

pub fn get_gateway(&self) -> GetGatewayFluentBuilder

Constructs a fluent builder for the GetGateway operation.

• The fluent builder is configurable:
  • gateway_identifier(impl Into<String>) / set_gateway_identifier(Option<String>):
    required: true
    

    The identifier of the gateway to retrieve.

    
    
• On success, responds with GetGatewayOutput with field(s):
  • gateway_arn(String):

    The Amazon Resource Name (ARN) of the gateway.

  • gateway_id(String):

    The unique identifier of the gateway.

  • gateway_url(Option<String>):

    An endpoint for invoking gateway.

  • created_at(DateTime):

    The timestamp when the gateway was created.

  • updated_at(DateTime):

    The timestamp when the gateway was last updated.

  • status(GatewayStatus):

    The current status of the gateway.

  • status_reasons(Option<Vec::<String>>):

    The reasons for the current status of the gateway.

  • name(String):

    The name of the gateway.

  • description(Option<String>):

    The description of the gateway.

  • role_arn(Option<String>):

    The IAM role ARN that provides permissions for the gateway.

  • protocol_type(GatewayProtocolType):

    Protocol applied to a gateway.

  • protocol_configuration(Option<GatewayProtocolConfiguration>):

    The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.

  • authorizer_type(AuthorizerType):

    Authorizer type for the gateway.

  • authorizer_configuration(Option<AuthorizerConfiguration>):

    The authorizer configuration for the gateway.

  • kms_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key used to encrypt the gateway.

  • interceptor_configurations(Option<Vec::<GatewayInterceptorConfiguration>>):

    The interceptors configured on the gateway.

  • policy_engine_configuration(Option<GatewayPolicyEngineConfiguration>):

    The policy engine configuration for the gateway.

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the gateway.

  • exception_level(Option<ExceptionLevel>):

    The level of detail in error messages returned when invoking the gateway.

    • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

    • If the value is omitted, a generic error message is returned to the end user.

• On failure, responds with SdkError<GetGatewayError>

impl Client

pub fn get_gateway_target(&self) -> GetGatewayTargetFluentBuilder

Constructs a fluent builder for the GetGatewayTarget operation.

• The fluent builder is configurable:
  • gateway_identifier(impl Into<String>) / set_gateway_identifier(Option<String>):
    required: true
    

    The identifier of the gateway that contains the target.

    
    
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: true
    

    The unique identifier of the target to retrieve.

    
    
• On success, responds with GetGatewayTargetOutput with field(s):
  • gateway_arn(String):

    The Amazon Resource Name (ARN) of the gateway.

  • target_id(String):

    The unique identifier of the gateway target.

  • created_at(DateTime):

    The timestamp when the gateway target was created.

  • updated_at(DateTime):

    The timestamp when the gateway target was last updated.

  • status(TargetStatus):

    The current status of the gateway target.

  • status_reasons(Option<Vec::<String>>):

    The reasons for the current status of the gateway target.

  • name(String):

    The name of the gateway target.

  • description(Option<String>):

    The description of the gateway target.

  • target_configuration(Option<TargetConfiguration>):

    The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.

  • credential_provider_configurations(Vec::<CredentialProviderConfiguration>):

    The credential provider configurations for the gateway target.

  • last_synchronized_at(Option<DateTime>):

    The last synchronization of the target.

• On failure, responds with SdkError<GetGatewayTargetError>

impl Client

pub fn get_memory(&self) -> GetMemoryFluentBuilder

Constructs a fluent builder for the GetMemory operation.

• The fluent builder is configurable:
  • memory_id(impl Into<String>) / set_memory_id(Option<String>):
    required: true
    

    The unique identifier of the memory to retrieve.

    
    
• On success, responds with GetMemoryOutput with field(s):
  • memory(Option<Memory>):

    The retrieved AgentCore Memory resource details.

• On failure, responds with SdkError<GetMemoryError>

impl Client

pub fn get_oauth2_credential_provider( &self, ) -> GetOauth2CredentialProviderFluentBuilder

Constructs a fluent builder for the GetOauth2CredentialProvider operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the OAuth2 credential provider to retrieve.

    
    
• On success, responds with GetOauth2CredentialProviderOutput with field(s):
  • client_secret_arn(Option<Secret>):

    The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager.

  • name(String):

    The name of the OAuth2 credential provider.

  • credential_provider_arn(String):

    ARN of the credential provider requested.

  • credential_provider_vendor(CredentialProviderVendorType):

    The vendor of the OAuth2 credential provider.

  • callback_url(Option<String>):

    Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.

  • oauth2_provider_config_output(Option<Oauth2ProviderConfigOutput>):

    The configuration output for the OAuth2 provider.

  • created_time(DateTime):

    The timestamp when the OAuth2 credential provider was created.

  • last_updated_time(DateTime):

    The timestamp when the OAuth2 credential provider was last updated.

• On failure, responds with SdkError<GetOauth2CredentialProviderError>

impl Client

pub fn get_online_evaluation_config( &self, ) -> GetOnlineEvaluationConfigFluentBuilder

Constructs a fluent builder for the GetOnlineEvaluationConfig operation.

• The fluent builder is configurable:
  • online_evaluation_config_id(impl Into<String>) / set_online_evaluation_config_id(Option<String>):
    required: true
    

    The unique identifier of the online evaluation configuration to retrieve.

    
    
• On success, responds with GetOnlineEvaluationConfigOutput with field(s):
  • online_evaluation_config_arn(String):

    The Amazon Resource Name (ARN) of the online evaluation configuration.

  • online_evaluation_config_id(String):

    The unique identifier of the online evaluation configuration.

  • online_evaluation_config_name(String):

    The name of the online evaluation configuration.

  • description(Option<String>):

    The description of the online evaluation configuration.

  • rule(Option<Rule>):

    The evaluation rule containing sampling configuration, filters, and session settings.

  • data_source_config(Option<DataSourceConfig>):

    The data source configuration specifying CloudWatch log groups and service names to monitor.

  • evaluators(Vec::<EvaluatorReference>):

    The list of evaluators applied during online evaluation.

  • output_config(Option<OutputConfig>):

    The output configuration specifying where evaluation results are written.

  • evaluation_execution_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role used for evaluation execution.

  • status(OnlineEvaluationConfigStatus):

    The status of the online evaluation configuration.

  • execution_status(OnlineEvaluationExecutionStatus):

    The execution status indicating whether the online evaluation is currently running.

  • created_at(DateTime):

    The timestamp when the online evaluation configuration was created.

  • updated_at(DateTime):

    The timestamp when the online evaluation configuration was last updated.

  • failure_reason(Option<String>):

    The reason for failure if the online evaluation configuration execution failed.

• On failure, responds with SdkError<GetOnlineEvaluationConfigError>

impl Client

pub fn get_policy(&self) -> GetPolicyFluentBuilder

Constructs a fluent builder for the GetPolicy operation.

• The fluent builder is configurable:
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The identifier of the policy engine that manages the policy to be retrieved.

    
    
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The unique identifier of the policy to be retrieved. This must be a valid policy ID that exists within the specified policy engine.

    
    
• On success, responds with GetPolicyOutput with field(s):
  • policy_id(String):

    The unique identifier of the retrieved policy. This matches the policy ID provided in the request and serves as the system identifier for the policy.

  • name(String):

    The customer-assigned name of the policy. This is the human-readable identifier that was specified when the policy was created.

  • policy_engine_id(String):

    The identifier of the policy engine that manages this policy. This confirms the policy engine context for the retrieved policy.

  • definition(Option<PolicyDefinition>):

    The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.

  • description(Option<String>):

    The human-readable description of the policy’s purpose and functionality. This helps administrators understand and manage the policy.

  • created_at(DateTime):

    The timestamp when the policy was originally created.

  • updated_at(DateTime):

    The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration.

  • policy_arn(String):

    The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.

  • status(PolicyStatus):

    The current status of the policy.

  • status_reasons(Vec::<String>):

    Additional information about the policy status. This provides details about any failures or the current state of the policy.

• On failure, responds with SdkError<GetPolicyError>

impl Client

pub fn get_policy_engine(&self) -> GetPolicyEngineFluentBuilder

Constructs a fluent builder for the GetPolicyEngine operation.

• The fluent builder is configurable:
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The unique identifier of the policy engine to be retrieved. This must be a valid policy engine ID that exists within the account.

    
    
• On success, responds with GetPolicyEngineOutput with field(s):
  • policy_engine_id(String):

    The unique identifier of the retrieved policy engine. This matches the policy engine ID provided in the request and serves as the system identifier.

  • name(String):

    The customer-assigned name of the policy engine. This is the human-readable identifier that was specified when the policy engine was created.

  • description(Option<String>):

    The human-readable description of the policy engine’s purpose and scope. This helps administrators understand the policy engine’s role in governance.

  • created_at(DateTime):

    The timestamp when the policy engine was originally created.

  • updated_at(DateTime):

    The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration.

  • policy_engine_arn(String):

    The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.

  • status(PolicyEngineStatus):

    The current status of the policy engine.

  • status_reasons(Vec::<String>):

    Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine.

• On failure, responds with SdkError<GetPolicyEngineError>

impl Client

pub fn get_policy_generation(&self) -> GetPolicyGenerationFluentBuilder

Constructs a fluent builder for the GetPolicyGeneration operation.

• The fluent builder is configurable:
  • policy_generation_id(impl Into<String>) / set_policy_generation_id(Option<String>):
    required: true
    

    The unique identifier of the policy generation request to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call.

    
    
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and schema validation.

    
    
• On success, responds with GetPolicyGenerationOutput with field(s):
  • policy_engine_id(String):

    The identifier of the policy engine associated with this policy generation. This confirms the policy engine context for the generation operation.

  • policy_generation_id(String):

    The unique identifier of the policy generation request. This matches the generation ID provided in the request and serves as the tracking identifier.

  • name(String):

    The customer-assigned name for the policy generation request. This helps identify and track generation operations across multiple requests.

  • policy_generation_arn(String):

    The Amazon Resource Name (ARN) of the policy generation. This globally unique identifier can be used for tracking, auditing, and cross-service references.

  • resource(Option<Resource>):

    The resource information associated with the policy generation. This provides context about the target resources for which the policies are being generated.

  • created_at(DateTime):

    The timestamp when the policy generation request was created. This is used for tracking and auditing generation operations and their lifecycle.

  • updated_at(DateTime):

    The timestamp when the policy generation was last updated. This tracks the progress of the generation process and any status changes.

  • status(PolicyGenerationStatus):

    The current status of the policy generation. This indicates whether the generation is in progress, completed successfully, or failed during processing.

  • status_reasons(Vec::<String>):

    Additional information about the generation status. This provides details about any failures, warnings, or the current state of the generation process.

  • findings(Option<String>):

    The findings and results from the policy generation process. This includes any issues, recommendations, validation results, or insights from the generated policies.

• On failure, responds with SdkError<GetPolicyGenerationError>

impl Client

pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder

Constructs a fluent builder for the GetResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource for which to retrieve the resource policy.

    
    
• On success, responds with GetResourcePolicyOutput with field(s):
  • policy(Option<String>):

    The resource policy associated with the specified resource.

• On failure, responds with SdkError<GetResourcePolicyError>

impl Client

pub fn get_token_vault(&self) -> GetTokenVaultFluentBuilder

Constructs a fluent builder for the GetTokenVault operation.

• The fluent builder is configurable:
  • token_vault_id(impl Into<String>) / set_token_vault_id(Option<String>):
    required: false
    

    The unique identifier of the token vault to retrieve.

    
    
• On success, responds with GetTokenVaultOutput with field(s):
  • token_vault_id(String):

    The ID of the token vault.

  • kms_configuration(Option<KmsConfiguration>):

    The KMS configuration for the token vault.

  • last_modified_date(DateTime):

    The timestamp when the token vault was last modified.

• On failure, responds with SdkError<GetTokenVaultError>

impl Client

pub fn get_workload_identity(&self) -> GetWorkloadIdentityFluentBuilder

Constructs a fluent builder for the GetWorkloadIdentity operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the workload identity to retrieve.

    
    
• On success, responds with GetWorkloadIdentityOutput with field(s):
  • name(String):

    The name of the workload identity.

  • workload_identity_arn(String):

    The Amazon Resource Name (ARN) of the workload identity.

  • allowed_resource_oauth2_return_urls(Option<Vec::<String>>):

    The list of allowed OAuth2 return URLs for resources associated with this workload identity.

  • created_time(DateTime):

    The timestamp when the workload identity was created.

  • last_updated_time(DateTime):

    The timestamp when the workload identity was last updated.

• On failure, responds with SdkError<GetWorkloadIdentityError>

impl Client

pub fn list_agent_runtime_endpoints( &self, ) -> ListAgentRuntimeEndpointsFluentBuilder

Constructs a fluent builder for the ListAgentRuntimeEndpoints operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agent_runtime_id(impl Into<String>) / set_agent_runtime_id(Option<String>):
    required: true
    

    The unique identifier of the AgentCore Runtime to list endpoints for.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
• On success, responds with ListAgentRuntimeEndpointsOutput with field(s):
  • runtime_endpoints(Vec::<AgentRuntimeEndpoint>):

    The list of AgentCore Runtime endpoints.

  • next_token(Option<String>):

    A token to retrieve the next page of results.

• On failure, responds with SdkError<ListAgentRuntimeEndpointsError>

impl Client

pub fn list_agent_runtime_versions( &self, ) -> ListAgentRuntimeVersionsFluentBuilder

Constructs a fluent builder for the ListAgentRuntimeVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agent_runtime_id(impl Into<String>) / set_agent_runtime_id(Option<String>):
    required: true
    

    The unique identifier of the AgentCore Runtime to list versions for.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
• On success, responds with ListAgentRuntimeVersionsOutput with field(s):
  • agent_runtimes(Vec::<AgentRuntime>):

    The list of AgentCore Runtime versions.

  • next_token(Option<String>):

    A token to retrieve the next page of results.

• On failure, responds with SdkError<ListAgentRuntimeVersionsError>

impl Client

pub fn list_agent_runtimes(&self) -> ListAgentRuntimesFluentBuilder

Constructs a fluent builder for the ListAgentRuntimes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
• On success, responds with ListAgentRuntimesOutput with field(s):
  • agent_runtimes(Vec::<AgentRuntime>):

    The list of AgentCore Runtime resources.

  • next_token(Option<String>):

    A token to retrieve the next page of results.

• On failure, responds with SdkError<ListAgentRuntimesError>

impl Client

pub fn list_api_key_credential_providers( &self, ) -> ListApiKeyCredentialProvidersFluentBuilder

Constructs a fluent builder for the ListApiKeyCredentialProviders operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of results to return.

    
    
• On success, responds with ListApiKeyCredentialProvidersOutput with field(s):
  • credential_providers(Vec::<ApiKeyCredentialProviderItem>):

    The list of API key credential providers.

  • next_token(Option<String>):

    Pagination token for the next page of results.

• On failure, responds with SdkError<ListApiKeyCredentialProvidersError>

impl Client

pub fn list_browsers(&self) -> ListBrowsersFluentBuilder

Constructs a fluent builder for the ListBrowsers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The 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.

    
    
  • r#type(ResourceType) / set_type(Option<ResourceType>):
    required: false
    

    The type of browsers to list. If not specified, all browser types are returned.

    
    
• On success, responds with ListBrowsersOutput with field(s):
  • browser_summaries(Vec::<BrowserSummary>):

    The list of browser summaries.

  • next_token(Option<String>):

    A token to retrieve the next page of results.

• On failure, responds with SdkError<ListBrowsersError>

impl Client

pub fn list_code_interpreters(&self) -> ListCodeInterpretersFluentBuilder

Constructs a fluent builder for the ListCodeInterpreters operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next page of results.

    
    
  • r#type(ResourceType) / set_type(Option<ResourceType>):
    required: false
    

    The type of code interpreters to list.

    
    
• On success, responds with ListCodeInterpretersOutput with field(s):
  • code_interpreter_summaries(Vec::<CodeInterpreterSummary>):

    The list of code interpreter summaries.

  • next_token(Option<String>):

    A token to retrieve the next page of results.

• On failure, responds with SdkError<ListCodeInterpretersError>

impl Client

pub fn list_evaluators(&self) -> ListEvaluatorsFluentBuilder

Constructs a fluent builder for the ListEvaluators operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from a previous request to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of evaluators to return in a single response.

    
    
• On success, responds with ListEvaluatorsOutput with field(s):
  • evaluators(Vec::<EvaluatorSummary>):

    The list of evaluator summaries containing basic information about each evaluator.

  • next_token(Option<String>):

    The pagination token to use in a subsequent request to retrieve the next page of results.

• On failure, responds with SdkError<ListEvaluatorsError>

impl Client

pub fn list_gateway_targets(&self) -> ListGatewayTargetsFluentBuilder

Constructs a fluent builder for the ListGatewayTargets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • gateway_identifier(impl Into<String>) / set_gateway_identifier(Option<String>):
    required: true
    

    The identifier of the gateway to list targets for.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListGatewayTargetsOutput with field(s):
  • items(Vec::<TargetSummary>):

    The list of gateway target summaries.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListGatewayTargetsError>

impl Client

pub fn list_gateways(&self) -> ListGatewaysFluentBuilder

Constructs a fluent builder for the ListGateways operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListGatewaysOutput with field(s):
  • items(Vec::<GatewaySummary>):

    The list of gateway summaries.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListGatewaysError>

impl Client

pub fn list_memories(&self) -> ListMemoriesFluentBuilder

Constructs a fluent builder for the ListMemories operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The 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 ListMemoriesOutput with field(s):
  • memories(Vec::<MemorySummary>):

    The list of AgentCore Memory resource summaries.

  • next_token(Option<String>):

    A token to retrieve the next page of results.

• On failure, responds with SdkError<ListMemoriesError>

impl Client

pub fn list_oauth2_credential_providers( &self, ) -> ListOauth2CredentialProvidersFluentBuilder

Constructs a fluent builder for the ListOauth2CredentialProviders operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of results to return.

    
    
• On success, responds with ListOauth2CredentialProvidersOutput with field(s):
  • credential_providers(Vec::<Oauth2CredentialProviderItem>):

    The list of OAuth2 credential providers.

  • next_token(Option<String>):

    Pagination token for the next page of results.

• On failure, responds with SdkError<ListOauth2CredentialProvidersError>

impl Client

pub fn list_online_evaluation_configs( &self, ) -> ListOnlineEvaluationConfigsFluentBuilder

Constructs a fluent builder for the ListOnlineEvaluationConfigs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from a previous request to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of online evaluation configurations to return in a single response.

    
    
• On success, responds with ListOnlineEvaluationConfigsOutput with field(s):
  • online_evaluation_configs(Vec::<OnlineEvaluationConfigSummary>):

    The list of online evaluation configuration summaries containing basic information about each configuration.

  • next_token(Option<String>):

    The pagination token to use in a subsequent request to retrieve the next page of results.

• On failure, responds with SdkError<ListOnlineEvaluationConfigsError>

impl Client

pub fn list_policies(&self) -> ListPoliciesFluentBuilder

Constructs a fluent builder for the ListPolicies operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token returned from a previous ListPolicies call. Use this token to retrieve the next page of results when the response is paginated.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of policies to return in a single response. If not specified, the default is 10 policies per page, with a maximum of 100 per page.

    
    
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The identifier of the policy engine whose policies to retrieve.

    
    
  • target_resource_scope(impl Into<String>) / set_target_resource_scope(Option<String>):
    required: false
    

    Optional filter to list policies that apply to a specific resource scope or resource type. This helps narrow down policy results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.

    
    
• On success, responds with ListPoliciesOutput with field(s):
  • policies(Vec::<Policy>):

    An array of policy objects that match the specified criteria. Each policy object contains the policy metadata, status, and key identifiers for further operations.

  • next_token(Option<String>):

    A pagination token that can be used in subsequent ListPolicies calls to retrieve additional results. This token is only present when there are more results available.

• On failure, responds with SdkError<ListPoliciesError>

impl Client

pub fn list_policy_engines(&self) -> ListPolicyEnginesFluentBuilder

Constructs a fluent builder for the ListPolicyEngines operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token returned from a previous ListPolicyEngines call. Use this token to retrieve the next page of results when the response is paginated.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of policy engines to return in a single response. If not specified, the default is 10 policy engines per page, with a maximum of 100 per page.

    
    
• On success, responds with ListPolicyEnginesOutput with field(s):
  • policy_engines(Vec::<PolicyEngine>):

    An array of policy engine objects that exist in the account. Each policy engine object contains the engine metadata, status, and key identifiers for further operations.

  • next_token(Option<String>):

    A pagination token that can be used in subsequent ListPolicyEngines calls to retrieve additional results. This token is only present when there are more results available.

• On failure, responds with SdkError<ListPolicyEnginesError>

impl Client

pub fn list_policy_generation_assets( &self, ) -> ListPolicyGenerationAssetsFluentBuilder

Constructs a fluent builder for the ListPolicyGenerationAssets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • policy_generation_id(impl Into<String>) / set_policy_generation_id(Option<String>):
    required: true
    

    The unique identifier of the policy generation request whose assets are to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call that has completed processing.

    
    
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The unique identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and ensures assets are retrieved from the correct policy engine.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token returned from a previous ListPolicyGenerationAssets call. Use this token to retrieve the next page of assets when the response is paginated due to large numbers of generated policy options.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of policy generation assets to return in a single response. If not specified, the default is 10 assets per page, with a maximum of 100 per page. This helps control response size when dealing with policy generations that produce many alternative policy options.

    
    
• On success, responds with ListPolicyGenerationAssetsOutput with field(s):
  • policy_generation_assets(Option<Vec::<PolicyGenerationAsset>>):

    An array of generated policy assets including Cedar policies and related artifacts from the AI-powered policy generation process. Each asset represents a different policy option or variation generated from the original natural language input.

  • next_token(Option<String>):

    A pagination token that can be used in subsequent ListPolicyGenerationAssets calls to retrieve additional assets. This token is only present when there are more generated policy assets available beyond the current response.

• On failure, responds with SdkError<ListPolicyGenerationAssetsError>

impl Client

pub fn list_policy_generations(&self) -> ListPolicyGenerationsFluentBuilder

Constructs a fluent builder for the ListPolicyGenerations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token for retrieving additional policy generations when results are paginated.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of policy generations to return in a single response.

    
    
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The identifier of the policy engine whose policy generations to retrieve.

    
    
• On success, responds with ListPolicyGenerationsOutput with field(s):
  • policy_generations(Vec::<PolicyGeneration>):

    An array of policy generation objects that match the specified criteria.

  • next_token(Option<String>):

    A pagination token for retrieving additional policy generations if more results are available.

• On failure, responds with SdkError<ListPolicyGenerationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource for which you want to list tags.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_workload_identities(&self) -> ListWorkloadIdentitiesFluentBuilder

Constructs a fluent builder for the ListWorkloadIdentities operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of results to return.

    
    
• On success, responds with ListWorkloadIdentitiesOutput with field(s):
  • workload_identities(Vec::<WorkloadIdentityType>):

    The list of workload identities.

  • next_token(Option<String>):

    Pagination token for the next page of results.

• On failure, responds with SdkError<ListWorkloadIdentitiesError>

impl Client

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource for which to create or update the resource policy.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The resource policy to create or update.

    
    
• On success, responds with PutResourcePolicyOutput with field(s):
  • policy(String):

    The resource policy that was created or updated.

• On failure, responds with SdkError<PutResourcePolicyError>

impl Client

pub fn set_token_vault_cmk(&self) -> SetTokenVaultCMKFluentBuilder

Constructs a fluent builder for the SetTokenVaultCMK operation.

• The fluent builder is configurable:
  • token_vault_id(impl Into<String>) / set_token_vault_id(Option<String>):
    required: false
    

    The unique identifier of the token vault to update.

    
    
  • kms_configuration(KmsConfiguration) / set_kms_configuration(Option<KmsConfiguration>):
    required: true
    

    The KMS configuration for the token vault, including the key type and KMS key ARN.

    
    
• On success, responds with SetTokenVaultCmkOutput with field(s):
  • token_vault_id(String):

    The ID of the token vault.

  • kms_configuration(Option<KmsConfiguration>):

    The KMS configuration for the token vault.

  • last_modified_date(DateTime):

    The timestamp when the token vault was last modified.

• On failure, responds with SdkError<SetTokenVaultCMKError>

impl Client

pub fn start_policy_generation(&self) -> StartPolicyGenerationFluentBuilder

Constructs a fluent builder for the StartPolicyGeneration operation.

• The fluent builder is configurable:
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The identifier of the policy engine that provides the context for policy generation. This engine’s schema and tool context are used to ensure generated policies are valid and applicable.

    
    
  • resource(Resource) / set_resource(Option<Resource>):
    required: true
    

    The resource information that provides context for policy generation. This helps the AI understand the target resources and generate appropriate access control rules.

    
    
  • content(Content) / set_content(Option<Content>):
    required: true
    

    The natural language description of the desired policy behavior. This content is processed by AI to generate corresponding Cedar policy statements that match the described intent.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A customer-assigned name for the policy generation request. This helps track and identify generation operations, especially when running multiple generations simultaneously.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don’t need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without starting a duplicate generation.

    
    
• On success, responds with StartPolicyGenerationOutput with field(s):
  • policy_engine_id(String):

    The identifier of the policy engine associated with the started policy generation.

  • policy_generation_id(String):

    The unique identifier assigned to the policy generation request for tracking progress.

  • name(String):

    The customer-assigned name for the policy generation request.

  • policy_generation_arn(String):

    The ARN of the created policy generation request.

  • resource(Option<Resource>):

    The resource information associated with the policy generation request.

  • created_at(DateTime):

    The timestamp when the policy generation request was created.

  • updated_at(DateTime):

    The timestamp when the policy generation was last updated.

  • status(PolicyGenerationStatus):

    The initial status of the policy generation request.

  • status_reasons(Vec::<String>):

    Additional information about the generation status.

  • findings(Option<String>):

    Initial findings from the policy generation process.

• On failure, responds with SdkError<StartPolicyGenerationError>

impl Client

pub fn synchronize_gateway_targets( &self, ) -> SynchronizeGatewayTargetsFluentBuilder

Constructs a fluent builder for the SynchronizeGatewayTargets operation.

• The fluent builder is configurable:
  • gateway_identifier(impl Into<String>) / set_gateway_identifier(Option<String>):
    required: true
    

    The gateway Identifier.

    
    
  • target_id_list(impl Into<String>) / set_target_id_list(Option<Vec::<String>>):
    required: true
    

    The target ID list.

    
    
• On success, responds with SynchronizeGatewayTargetsOutput with field(s):
  • targets(Option<Vec::<GatewayTarget>>):

    The gateway targets for synchronization.

• On failure, responds with SdkError<SynchronizeGatewayTargetsError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource that you want to tag.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags to add to the resource. A tag is a key-value pair.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource that you want to untag.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys of the tags to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_agent_runtime(&self) -> UpdateAgentRuntimeFluentBuilder

Constructs a fluent builder for the UpdateAgentRuntime operation.

• The fluent builder is configurable:
  • agent_runtime_id(impl Into<String>) / set_agent_runtime_id(Option<String>):
    required: true
    

    The unique identifier of the AgentCore Runtime to update.

    
    
  • agent_runtime_artifact(AgentRuntimeArtifact) / set_agent_runtime_artifact(Option<AgentRuntimeArtifact>):
    required: true
    

    The updated artifact of the AgentCore Runtime.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The updated IAM role ARN that provides permissions for the AgentCore Runtime.

    
    
  • network_configuration(NetworkConfiguration) / set_network_configuration(Option<NetworkConfiguration>):
    required: true
    

    The updated network configuration for the AgentCore Runtime.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the AgentCore Runtime.

    
    
  • authorizer_configuration(AuthorizerConfiguration) / set_authorizer_configuration(Option<AuthorizerConfiguration>):
    required: false
    

    The updated authorizer configuration for the AgentCore Runtime.

    
    
  • request_header_configuration(RequestHeaderConfiguration) / set_request_header_configuration(Option<RequestHeaderConfiguration>):
    required: false
    

    The updated configuration for HTTP request headers that will be passed through to the runtime.

    
    
  • protocol_configuration(ProtocolConfiguration) / set_protocol_configuration(Option<ProtocolConfiguration>):
    required: false
    

    The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.

    
    
  • lifecycle_configuration(LifecycleConfiguration) / set_lifecycle_configuration(Option<LifecycleConfiguration>):
    required: false
    

    The updated life cycle configuration for the AgentCore Runtime.

    
    
  • environment_variables(impl Into<String>, impl Into<String>) / set_environment_variables(Option<HashMap::<String, String>>):
    required: false
    

    Updated environment variables to set in the AgentCore Runtime environment.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with UpdateAgentRuntimeOutput with field(s):
  • agent_runtime_arn(String):

    The Amazon Resource Name (ARN) of the updated AgentCore Runtime.

  • agent_runtime_id(String):

    The unique identifier of the updated AgentCore Runtime.

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the updated AgentCore Runtime.

  • agent_runtime_version(String):

    The version of the updated AgentCore Runtime.

  • created_at(DateTime):

    The timestamp when the AgentCore Runtime was created.

  • last_updated_at(DateTime):

    The timestamp when the AgentCore Runtime was last updated.

  • status(AgentRuntimeStatus):

    The current status of the updated AgentCore Runtime.

• On failure, responds with SdkError<UpdateAgentRuntimeError>

impl Client

pub fn update_agent_runtime_endpoint( &self, ) -> UpdateAgentRuntimeEndpointFluentBuilder

Constructs a fluent builder for the UpdateAgentRuntimeEndpoint operation.

• The fluent builder is configurable:
  • agent_runtime_id(impl Into<String>) / set_agent_runtime_id(Option<String>):
    required: true
    

    The unique identifier of the AgentCore Runtime associated with the endpoint.

    
    
  • endpoint_name(impl Into<String>) / set_endpoint_name(Option<String>):
    required: true
    

    The name of the AgentCore Runtime endpoint to update.

    
    
  • agent_runtime_version(impl Into<String>) / set_agent_runtime_version(Option<String>):
    required: false
    

    The updated version of the AgentCore Runtime for the endpoint.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the AgentCore Runtime endpoint.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with UpdateAgentRuntimeEndpointOutput with field(s):
  • live_version(Option<String>):

    The currently deployed version of the AgentCore Runtime on the endpoint.

  • target_version(Option<String>):

    The target version of the AgentCore Runtime for the endpoint.

  • agent_runtime_endpoint_arn(String):

    The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

  • agent_runtime_arn(String):

    The Amazon Resource Name (ARN) of the AgentCore Runtime.

  • status(AgentRuntimeEndpointStatus):

    The current status of the updated AgentCore Runtime endpoint.

  • created_at(DateTime):

    The timestamp when the AgentCore Runtime endpoint was created.

  • last_updated_at(DateTime):

    The timestamp when the AgentCore Runtime endpoint was last updated.

• On failure, responds with SdkError<UpdateAgentRuntimeEndpointError>

impl Client

pub fn update_api_key_credential_provider( &self, ) -> UpdateApiKeyCredentialProviderFluentBuilder

Constructs a fluent builder for the UpdateApiKeyCredentialProvider operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the API key credential provider to update.

    
    
  • api_key(impl Into<String>) / set_api_key(Option<String>):
    required: true
    

    The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.

    
    
• On success, responds with UpdateApiKeyCredentialProviderOutput with field(s):
  • api_key_secret_arn(Option<Secret>):

    The Amazon Resource Name (ARN) of the API key secret in AWS Secrets Manager.

  • name(String):

    The name of the API key credential provider.

  • credential_provider_arn(String):

    The Amazon Resource Name (ARN) of the API key credential provider.

  • created_time(DateTime):

    The timestamp when the API key credential provider was created.

  • last_updated_time(DateTime):

    The timestamp when the API key credential provider was last updated.

• On failure, responds with SdkError<UpdateApiKeyCredentialProviderError>

impl Client

pub fn update_evaluator(&self) -> UpdateEvaluatorFluentBuilder

Constructs a fluent builder for the UpdateEvaluator operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.

    
    
  • evaluator_id(impl Into<String>) / set_evaluator_id(Option<String>):
    required: true
    

    The unique identifier of the evaluator to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the evaluator.

    
    
  • evaluator_config(EvaluatorConfig) / set_evaluator_config(Option<EvaluatorConfig>):
    required: false
    

    The updated configuration for the evaluator, including LLM-as-a-Judge settings with instructions, rating scale, and model configuration.

    
    
  • level(EvaluatorLevel) / set_level(Option<EvaluatorLevel>):
    required: false
    

    The updated evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

    
    
• On success, responds with UpdateEvaluatorOutput with field(s):
  • evaluator_arn(String):

    The Amazon Resource Name (ARN) of the updated evaluator.

  • evaluator_id(String):

    The unique identifier of the updated evaluator.

  • updated_at(DateTime):

    The timestamp when the evaluator was last updated.

  • status(EvaluatorStatus):

    The status of the evaluator update operation.

• On failure, responds with SdkError<UpdateEvaluatorError>

impl Client

pub fn update_gateway(&self) -> UpdateGatewayFluentBuilder

Constructs a fluent builder for the UpdateGateway operation.

• The fluent builder is configurable:
  • gateway_identifier(impl Into<String>) / set_gateway_identifier(Option<String>):
    required: true
    

    The identifier of the gateway to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the gateway. This name must be the same as the one when the gateway was created.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description for the gateway.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The updated IAM role ARN that provides permissions for the gateway.

    
    
  • protocol_type(GatewayProtocolType) / set_protocol_type(Option<GatewayProtocolType>):
    required: true
    

    The updated protocol type for the gateway.

    
    
  • protocol_configuration(GatewayProtocolConfiguration) / set_protocol_configuration(Option<GatewayProtocolConfiguration>):
    required: false
    

    The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.

    
    
  • authorizer_type(AuthorizerType) / set_authorizer_type(Option<AuthorizerType>):
    required: true
    

    The updated authorizer type for the gateway.

    
    
  • authorizer_configuration(AuthorizerConfiguration) / set_authorizer_configuration(Option<AuthorizerConfiguration>):
    required: false
    

    The updated authorizer configuration for the gateway.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

    The updated ARN of the KMS key used to encrypt the gateway.

    
    
  • interceptor_configurations(GatewayInterceptorConfiguration) / set_interceptor_configurations(Option<Vec::<GatewayInterceptorConfiguration>>):
    required: false
    

    The updated interceptor configurations for the gateway.

    
    
  • policy_engine_configuration(GatewayPolicyEngineConfiguration) / set_policy_engine_configuration(Option<GatewayPolicyEngineConfiguration>):
    required: false
    

    The updated policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

    
    
  • exception_level(ExceptionLevel) / set_exception_level(Option<ExceptionLevel>):
    required: false
    

    The level of detail in error messages returned when invoking the gateway.

    • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

    • If the value is omitted, a generic error message is returned to the end user.

    
    
• On success, responds with UpdateGatewayOutput with field(s):
  • gateway_arn(String):

    The Amazon Resource Name (ARN) of the updated gateway.

  • gateway_id(String):

    The unique identifier of the updated gateway.

  • gateway_url(Option<String>):

    An endpoint for invoking the updated gateway.

  • created_at(DateTime):

    The timestamp when the gateway was created.

  • updated_at(DateTime):

    The timestamp when the gateway was last updated.

  • status(GatewayStatus):

    The current status of the updated gateway.

  • status_reasons(Option<Vec::<String>>):

    The reasons for the current status of the updated gateway.

  • name(String):

    The name of the gateway.

  • description(Option<String>):

    The updated description of the gateway.

  • role_arn(Option<String>):

    The updated IAM role ARN that provides permissions for the gateway.

  • protocol_type(GatewayProtocolType):

    The updated protocol type for the gateway.

  • protocol_configuration(Option<GatewayProtocolConfiguration>):

    The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.

  • authorizer_type(AuthorizerType):

    The updated authorizer type for the gateway.

  • authorizer_configuration(Option<AuthorizerConfiguration>):

    The updated authorizer configuration for the gateway.

  • kms_key_arn(Option<String>):

    The updated ARN of the KMS key used to encrypt the gateway.

  • interceptor_configurations(Option<Vec::<GatewayInterceptorConfiguration>>):

    The updated interceptor configurations for the gateway.

  • policy_engine_configuration(Option<GatewayPolicyEngineConfiguration>):

    The updated policy engine configuration for the gateway.

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the updated gateway.

  • exception_level(Option<ExceptionLevel>):

    The level of detail in error messages returned when invoking the gateway.

    • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

    • If the value is omitted, a generic error message is returned to the end user.

• On failure, responds with SdkError<UpdateGatewayError>

impl Client

pub fn update_gateway_target(&self) -> UpdateGatewayTargetFluentBuilder

Constructs a fluent builder for the UpdateGatewayTarget operation.

• The fluent builder is configurable:
  • gateway_identifier(impl Into<String>) / set_gateway_identifier(Option<String>):
    required: true
    

    The unique identifier of the gateway associated with the target.

    
    
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: true
    

    The unique identifier of the gateway target to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The updated name for the gateway target.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description for the gateway target.

    
    
  • target_configuration(TargetConfiguration) / set_target_configuration(Option<TargetConfiguration>):
    required: true
    

    The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.

    
    
  • credential_provider_configurations(CredentialProviderConfiguration) / set_credential_provider_configurations(Option<Vec::<CredentialProviderConfiguration>>):
    required: false
    

    The updated credential provider configurations for the gateway target.

    
    
• On success, responds with UpdateGatewayTargetOutput with field(s):
  • gateway_arn(String):

    The Amazon Resource Name (ARN) of the gateway.

  • target_id(String):

    The unique identifier of the updated gateway target.

  • created_at(DateTime):

    The timestamp when the gateway target was created.

  • updated_at(DateTime):

    The timestamp when the gateway target was last updated.

  • status(TargetStatus):

    The current status of the updated gateway target.

  • status_reasons(Option<Vec::<String>>):

    The reasons for the current status of the updated gateway target.

  • name(String):

    The updated name of the gateway target.

  • description(Option<String>):

    The updated description of the gateway target.

  • target_configuration(Option<TargetConfiguration>):

    The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.

  • credential_provider_configurations(Vec::<CredentialProviderConfiguration>):

    The updated credential provider configurations for the gateway target.

  • last_synchronized_at(Option<DateTime>):

    The date and time at which the targets were last synchronized.

• On failure, responds with SdkError<UpdateGatewayTargetError>

impl Client

pub fn update_memory(&self) -> UpdateMemoryFluentBuilder

Constructs a fluent builder for the UpdateMemory operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique AWS identifier.

    
    
  • memory_id(impl Into<String>) / set_memory_id(Option<String>):
    required: true
    

    The unique identifier of the memory to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the AgentCore Memory resource.

    
    
  • event_expiry_duration(i32) / set_event_expiry_duration(Option<i32>):
    required: false
    

    The number of days after which memory events will expire, between 7 and 365 days.

    
    
  • memory_execution_role_arn(impl Into<String>) / set_memory_execution_role_arn(Option<String>):
    required: false
    

    The ARN of the IAM role that provides permissions for the AgentCore Memory resource.

    
    
  • memory_strategies(ModifyMemoryStrategies) / set_memory_strategies(Option<ModifyMemoryStrategies>):
    required: false
    

    The memory strategies to add, modify, or delete.

    
    
• On success, responds with UpdateMemoryOutput with field(s):
  • memory(Option<Memory>):

    The updated AgentCore Memory resource details.

• On failure, responds with SdkError<UpdateMemoryError>

impl Client

pub fn update_oauth2_credential_provider( &self, ) -> UpdateOauth2CredentialProviderFluentBuilder

Constructs a fluent builder for the UpdateOauth2CredentialProvider operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the OAuth2 credential provider to update.

    
    
  • credential_provider_vendor(CredentialProviderVendorType) / set_credential_provider_vendor(Option<CredentialProviderVendorType>):
    required: true
    

    The vendor of the OAuth2 credential provider.

    
    
  • oauth2_provider_config_input(Oauth2ProviderConfigInput) / set_oauth2_provider_config_input(Option<Oauth2ProviderConfigInput>):
    required: true
    

    The configuration input for the OAuth2 provider.

    
    
• On success, responds with UpdateOauth2CredentialProviderOutput with field(s):
  • client_secret_arn(Option<Secret>):

    The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager.

  • name(String):

    The name of the OAuth2 credential provider.

  • credential_provider_vendor(CredentialProviderVendorType):

    The vendor of the OAuth2 credential provider.

  • credential_provider_arn(String):

    The Amazon Resource Name (ARN) of the OAuth2 credential provider.

  • callback_url(Option<String>):

    Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.

  • oauth2_provider_config_output(Option<Oauth2ProviderConfigOutput>):

    The configuration output for the OAuth2 provider.

  • created_time(DateTime):

    The timestamp when the OAuth2 credential provider was created.

  • last_updated_time(DateTime):

    The timestamp when the OAuth2 credential provider was last updated.

• On failure, responds with SdkError<UpdateOauth2CredentialProviderError>

impl Client

pub fn update_online_evaluation_config( &self, ) -> UpdateOnlineEvaluationConfigFluentBuilder

Constructs a fluent builder for the UpdateOnlineEvaluationConfig operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.

    
    
  • online_evaluation_config_id(impl Into<String>) / set_online_evaluation_config_id(Option<String>):
    required: true
    

    The unique identifier of the online evaluation configuration to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the online evaluation configuration.

    
    
  • rule(Rule) / set_rule(Option<Rule>):
    required: false
    

    The updated evaluation rule containing sampling configuration, filters, and session settings.

    
    
  • data_source_config(DataSourceConfig) / set_data_source_config(Option<DataSourceConfig>):
    required: false
    

    The updated data source configuration specifying CloudWatch log groups and service names to monitor.

    
    
  • evaluators(EvaluatorReference) / set_evaluators(Option<Vec::<EvaluatorReference>>):
    required: false
    

    The updated list of evaluators to apply during online evaluation.

    
    
  • evaluation_execution_role_arn(impl Into<String>) / set_evaluation_execution_role_arn(Option<String>):
    required: false
    

    The updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution.

    
    
  • execution_status(OnlineEvaluationExecutionStatus) / set_execution_status(Option<OnlineEvaluationExecutionStatus>):
    required: false
    

    The updated execution status to enable or disable the online evaluation.

    
    
• On success, responds with UpdateOnlineEvaluationConfigOutput with field(s):
  • online_evaluation_config_arn(String):

    The Amazon Resource Name (ARN) of the updated online evaluation configuration.

  • online_evaluation_config_id(String):

    The unique identifier of the updated online evaluation configuration.

  • updated_at(DateTime):

    The timestamp when the online evaluation configuration was last updated.

  • status(OnlineEvaluationConfigStatus):

    The status of the online evaluation configuration.

  • execution_status(OnlineEvaluationExecutionStatus):

    The execution status indicating whether the online evaluation is currently running.

  • failure_reason(Option<String>):

    The reason for failure if the online evaluation configuration update or execution failed.

• On failure, responds with SdkError<UpdateOnlineEvaluationConfigError>

impl Client

pub fn update_policy(&self) -> UpdatePolicyFluentBuilder

Constructs a fluent builder for the UpdatePolicy operation.

• The fluent builder is configurable:
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The identifier of the policy engine that manages the policy to be updated. This ensures the policy is updated within the correct policy engine context.

    
    
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The unique identifier of the policy to be updated. This must be a valid policy ID that exists within the specified policy engine.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The new human-readable description for the policy. This optional field allows updating the policy’s documentation while keeping the same policy logic.

    
    
  • definition(PolicyDefinition) / set_definition(Option<PolicyDefinition>):
    required: true
    

    The new Cedar policy statement that defines the access control rules. This replaces the existing policy definition with new logic while maintaining the policy’s identity.

    
    
  • validation_mode(PolicyValidationMode) / set_validation_mode(Option<PolicyValidationMode>):
    required: false
    

    The validation mode for the policy update. Determines how Cedar analyzer validation results are handled during policy updates. FAIL_ON_ANY_FINDINGS runs the Cedar analyzer and fails the update if validation issues are detected, ensuring the policy conforms to the Cedar schema and tool context. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows updates despite validation warnings. Use FAIL_ON_ANY_FINDINGS to ensure policy correctness during updates, especially when modifying policy logic or conditions.

    
    
• On success, responds with UpdatePolicyOutput with field(s):
  • policy_id(String):

    The unique identifier of the updated policy.

  • name(String):

    The name of the updated policy.

  • policy_engine_id(String):

    The identifier of the policy engine managing the updated policy.

  • definition(Option<PolicyDefinition>):

    The updated Cedar policy statement.

  • description(Option<String>):

    The updated description of the policy.

  • created_at(DateTime):

    The original creation timestamp of the policy.

  • updated_at(DateTime):

    The timestamp when the policy was last updated.

  • policy_arn(String):

    The ARN of the updated policy.

  • status(PolicyStatus):

    The current status of the updated policy.

  • status_reasons(Vec::<String>):

    Additional information about the update status.

• On failure, responds with SdkError<UpdatePolicyError>

impl Client

pub fn update_policy_engine(&self) -> UpdatePolicyEngineFluentBuilder

Constructs a fluent builder for the UpdatePolicyEngine operation.

• The fluent builder is configurable:
  • policy_engine_id(impl Into<String>) / set_policy_engine_id(Option<String>):
    required: true
    

    The unique identifier of the policy engine to be updated.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The new description for the policy engine.

    
    
• On success, responds with UpdatePolicyEngineOutput with field(s):
  • policy_engine_id(String):

    The unique identifier of the updated policy engine.

  • name(String):

    The name of the updated policy engine.

  • description(Option<String>):

    The updated description of the policy engine.

  • created_at(DateTime):

    The original creation timestamp of the policy engine.

  • updated_at(DateTime):

    The timestamp when the policy engine was last updated.

  • policy_engine_arn(String):

    The ARN of the updated policy engine.

  • status(PolicyEngineStatus):

    The current status of the updated policy engine.

  • status_reasons(Vec::<String>):

    Additional information about the update status.

• On failure, responds with SdkError<UpdatePolicyEngineError>

impl Client

pub fn update_workload_identity(&self) -> UpdateWorkloadIdentityFluentBuilder

Constructs a fluent builder for the UpdateWorkloadIdentity operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the workload identity to update.

    
    
  • allowed_resource_oauth2_return_urls(impl Into<String>) / set_allowed_resource_oauth2_return_urls(Option<Vec::<String>>):
    required: false
    

    The new list of allowed OAuth2 return URLs for resources associated with this workload identity. This list replaces the existing list.

    
    
• On success, responds with UpdateWorkloadIdentityOutput with field(s):
  • name(String):

    The name of the workload identity.

  • workload_identity_arn(String):

    The Amazon Resource Name (ARN) of the workload identity.

  • allowed_resource_oauth2_return_urls(Option<Vec::<String>>):

    The list of allowed OAuth2 return URLs for resources associated with this workload identity.

  • created_time(DateTime):

    The timestamp when the workload identity was created.

  • last_updated_time(DateTime):

    The timestamp when the workload identity was last updated.

• On failure, responds with SdkError<UpdateWorkloadIdentityError>

impl Client

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_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_memory_created(&self) -> MemoryCreatedFluentBuilder

Wait for memory_created

fn wait_until_policy_active(&self) -> PolicyActiveFluentBuilder

Wait until a Policy is active

fn wait_until_policy_deleted(&self) -> PolicyDeletedFluentBuilder

Wait until a Policy is deleted

fn wait_until_policy_engine_active(&self) -> PolicyEngineActiveFluentBuilder

Wait until a PolicyEngine is active

fn wait_until_policy_engine_deleted(&self) -> PolicyEngineDeletedFluentBuilder

Wait until a PolicyEngine is deleted

fn wait_until_policy_generation_completed( &self, ) -> PolicyGenerationCompletedFluentBuilder

Wait until policy generation is completed