Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Bedrock Agent Core Control Plane Fronting Layer

Client for invoking operations on Amazon Bedrock Agent Core Control Plane Fronting Layer. Each operation on Amazon Bedrock Agent Core Control Plane Fronting Layer 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 secure agent.

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

    The description of the agent runtime.

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

    The artifact of the agent.

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

    The IAM role ARN that provides permissions for the agent runtime.

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

    The network configuration for the agent 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.

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

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

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

    Environment variables to set in the agent runtime environment.

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

    The authorizer configuration for the agent runtime.

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

    The Amazon Resource Name (ARN) of the agent runtime.

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the agent runtime.

  • agent_runtime_id(String):

    The unique identifier of the agent runtime.

  • agent_runtime_version(String):

    The version of the agent runtime.

  • created_at(DateTime):

    The timestamp when the agent runtime was created.

  • status(AgentStatus):

    The current status of the agent 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 agent runtime to create an endpoint for.

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

    The name of the agent runtime endpoint.

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

    The version of the agent runtime to use for the endpoint.

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

    The description of the agent 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 CreateAgentRuntimeEndpointOutput with field(s):
  • target_version(String):

    The target version of the agent runtime for the endpoint.

  • agent_runtime_endpoint_arn(String):

    The Amazon Resource Name (ARN) of the agent runtime endpoint.

  • agent_runtime_arn(String):

    The Amazon Resource Name (ARN) of the agent runtime.

  • status(AgentEndpointStatus):

    The current status of the agent runtime endpoint.

  • created_at(DateTime):

    The timestamp when the agent 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.

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

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

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

    
    
• 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_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 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.

    
    
  • 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. Currently supports MCP (Model Context Protocol).

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

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

    The authorizer configuration for the Gateway.

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

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

    The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

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

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the created Gateway.

  • exception_level(Option<ExceptionLevel>):

    The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

• 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. This can be either the gateway ID or the gateway ARN.

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

    
    
  • 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: true
    

    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.

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

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

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

• On failure, responds with SdkError<CreateOauth2CredentialProviderError>

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.

    
    
• 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 agent runtime to delete.

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

    The current status of the agent runtime deletion.

• 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 agent runtime associated with the endpoint.

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

    The name of the agent 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(AgentEndpointStatus):

    The current status of the agent runtime endpoint deletion.

• 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_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. This can be either the gateway ID or the gateway ARN.

    
    
• 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 memory.

  • status(Option<MemoryStatus>):

    The current status of the memory 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_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 agent runtime to retrieve.

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

    The version of the agent runtime to retrieve.

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

    The Amazon Resource Name (ARN) of the agent runtime.

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the agent runtime.

  • agent_runtime_name(String):

    The name of the agent runtime.

  • description(Option<String>):

    The description of the agent runtime.

  • agent_runtime_id(String):

    The unique identifier of the agent runtime.

  • agent_runtime_version(String):

    The version of the agent runtime.

  • created_at(DateTime):

    The timestamp when the agent runtime was created.

  • last_updated_at(DateTime):

    The timestamp when the agent runtime was last updated.

  • role_arn(String):

    The IAM role ARN that provides permissions for the agent runtime.

  • agent_runtime_artifact(Option<AgentArtifact>):

    The artifact of the agent runtime.

  • network_configuration(Option<NetworkConfiguration>):

    The network configuration for the agent 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 agent runtime environment.

  • authorizer_configuration(Option<AuthorizerConfiguration>):

    The authorizer configuration for the agent runtime.

  • status(AgentStatus):

    The current status of the agent 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 agent runtime associated with the endpoint.

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

    The name of the agent runtime endpoint to retrieve.

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

    The currently deployed version of the agent runtime on the endpoint.

  • target_version(Option<String>):

    The target version of the agent runtime for the endpoint.

  • agent_runtime_endpoint_arn(String):

    The Amazon Resource Name (ARN) of the agent runtime endpoint.

  • agent_runtime_arn(String):

    The Amazon Resource Name (ARN) of the agent runtime.

  • description(Option<String>):

    The description of the agent runtime endpoint.

  • status(AgentEndpointStatus):

    The current status of the agent runtime endpoint.

  • created_at(DateTime):

    The timestamp when the agent runtime endpoint was created.

  • last_updated_at(DateTime):

    The timestamp when the agent runtime endpoint was last updated.

  • failure_reason(Option<String>):

    The reason for failure if the agent runtime endpoint is in a failed state.

  • name(String):

    The name of the agent runtime endpoint.

  • id(String):

    The unique identifier of the agent 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.

  • status(BrowserStatus):

    The current status of the browser.

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

  • 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_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. This can be either the gateway ID or the gateway ARN.

    
    
• 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 ARN of the KMS key used to encrypt the Gateway.

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the Gateway.

  • exception_level(Option<ExceptionLevel>):

    The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

• 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. This can be either the gateway ID or the gateway ARN.

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

• 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 memory 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.

  • 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_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 agent 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::<AgentEndpoint>):

    The list of agent 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 agent 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::<Agent>):

    The list of agent 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::<Agent>):

    The list of agent runtimes.

  • 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_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. This can be either the gateway ID or the gateway ARN.

    
    
  • 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 ListGatewayTargetsOutput with field(s):
  • items(Vec::<TargetSummary>):

    The list of Gateway Target summaries.

  • next_token(Option<String>):

    Opaque continuation token for the next paginated response.

• 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 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 ListGatewaysOutput with field(s):
  • items(Vec::<GatewaySummary>):

    The list of Gateway summaries.

  • next_token(Option<String>):

    Opaque continuation token for the next paginated response.

• 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 memory 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_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 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 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 agent runtime to update.

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

    The updated description of the agent runtime.

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

    The updated artifact of the agent runtime.

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

    The updated IAM role ARN that provides permissions for the agent runtime.

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

    The updated network configuration for the agent 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.

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

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

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

    Updated environment variables to set in the agent runtime environment.

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

    The updated authorizer configuration for the agent runtime.

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

    The Amazon Resource Name (ARN) of the updated agent runtime.

  • agent_runtime_id(String):

    The unique identifier of the updated agent runtime.

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the updated agent runtime.

  • agent_runtime_version(String):

    The version of the updated agent runtime.

  • created_at(DateTime):

    The timestamp when the agent runtime was created.

  • last_updated_at(DateTime):

    The timestamp when the agent runtime was last updated.

  • status(AgentStatus):

    The current status of the updated agent 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 agent runtime associated with the endpoint.

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

    The name of the agent runtime endpoint to update.

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

    The updated version of the agent runtime for the endpoint.

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

    The updated description of the agent 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 agent runtime on the endpoint.

  • target_version(Option<String>):

    The target version of the agent runtime for the endpoint.

  • agent_runtime_endpoint_arn(String):

    The Amazon Resource Name (ARN) of the agent runtime endpoint.

  • agent_runtime_arn(String):

    The Amazon Resource Name (ARN) of the agent runtime.

  • status(AgentEndpointStatus):

    The current status of the updated agent runtime endpoint.

  • created_at(DateTime):

    The timestamp when the agent runtime endpoint was created.

  • last_updated_at(DateTime):

    The timestamp when the agent 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_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. This can be either the gateway ID or the gateway ARN.

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

    The updated name for the Gateway.

    
    
  • 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: true
    

    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.

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

    The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

    
    
• 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 updated 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.

  • workload_identity_details(Option<WorkloadIdentityDetails>):

    The workload identity details for the updated Gateway.

  • exception_level(Option<ExceptionLevel>):

    The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

• 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: true
    

    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.

• 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 memory.

    
    
  • 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 memory.

    
    
  • 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 memory 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.

  • 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_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