aws-sdk-bedrockagentcorecontrol 1.49.0

AWS SDK for Amazon Bedrock AgentCore Control
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[derive(Debug)]
pub(crate) struct Handle {
    pub(crate) conf: crate::Config,
    #[allow(dead_code)] // unused when a service does not provide any operations
    pub(crate) runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
}

/// 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:
/// ```rust,no_run
/// # async fn wrapper() {
/// 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`](crate::config::Builder) struct implements `From<&SdkConfig>`, so setting these specific settings can be
/// done as follows:
///
/// ```rust,no_run
/// # async fn wrapper() {
/// 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.
///
/// [`Config`]: crate::Config
/// [`ConfigLoader`]: https://docs.rs/aws-config/*/aws_config/struct.ConfigLoader.html
/// [`SdkConfig`]: https://docs.rs/aws-config/*/aws_config/struct.SdkConfig.html
/// [`aws-config` docs]: https://docs.rs/aws-config/*
/// [`aws-config`]: https://crates.io/crates/aws-config
/// [`aws_config::from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.from_env.html
/// [`aws_config::load_from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.load_from_env.html
/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
/// # Using the `Client`
///
/// A client has a function for every operation that can be performed by the service.
/// For example, the [`CreateAgentRuntime`](crate::operation::create_agent_runtime) 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:
///
/// ```rust,ignore
/// 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`](crate::client::customize) module for more
/// information.
/// # Waiters
///
/// This client provides `wait_until` methods behind the [`Waiters`](crate::client::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:
/// ```rust,ignore
/// let result = client.wait_until_thing()
///     .thing_id("someId")
///     .wait(Duration::from_secs(120))
///     .await;
/// ```
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct Client {
    handle: ::std::sync::Arc<Handle>,
}

impl Client {
    /// Creates a new client from the service [`Config`](crate::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.
    #[track_caller]
    pub fn from_conf(conf: crate::Config) -> Self {
        let handle = Handle {
            conf: conf.clone(),
            runtime_plugins: crate::config::base_client_runtime_plugins(conf),
        };
        if let Err(err) = Self::validate_config(&handle) {
            panic!("Invalid client configuration: {err}");
        }
        Self {
            handle: ::std::sync::Arc::new(handle),
        }
    }

    /// Returns the client's configuration.
    pub fn config(&self) -> &crate::Config {
        &self.handle.conf
    }

    fn validate_config(handle: &Handle) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
        handle
            .runtime_plugins
            .apply_client_configuration(&mut cfg)?
            .validate_base_client_config(&cfg)?;
        Ok(())
    }
}

///
/// Waiter functions for the client.
///
/// Import this trait to get `wait_until` methods on the client.
///
pub trait Waiters {
    /// Wait for `memory_created`
    fn wait_until_memory_created(&self) -> crate::waiters::memory_created::MemoryCreatedFluentBuilder;
    /// Wait until a Policy is active
    fn wait_until_policy_active(&self) -> crate::waiters::policy_active::PolicyActiveFluentBuilder;
    /// Wait until a Policy is deleted
    fn wait_until_policy_deleted(&self) -> crate::waiters::policy_deleted::PolicyDeletedFluentBuilder;
    /// Wait until a PolicyEngine is active
    fn wait_until_policy_engine_active(&self) -> crate::waiters::policy_engine_active::PolicyEngineActiveFluentBuilder;
    /// Wait until a PolicyEngine is deleted
    fn wait_until_policy_engine_deleted(&self) -> crate::waiters::policy_engine_deleted::PolicyEngineDeletedFluentBuilder;
    /// Wait until policy generation is completed
    fn wait_until_policy_generation_completed(&self) -> crate::waiters::policy_generation_completed::PolicyGenerationCompletedFluentBuilder;
}
impl Waiters for Client {
    fn wait_until_memory_created(&self) -> crate::waiters::memory_created::MemoryCreatedFluentBuilder {
        crate::waiters::memory_created::MemoryCreatedFluentBuilder::new(self.handle.clone())
    }
    fn wait_until_policy_active(&self) -> crate::waiters::policy_active::PolicyActiveFluentBuilder {
        crate::waiters::policy_active::PolicyActiveFluentBuilder::new(self.handle.clone())
    }
    fn wait_until_policy_deleted(&self) -> crate::waiters::policy_deleted::PolicyDeletedFluentBuilder {
        crate::waiters::policy_deleted::PolicyDeletedFluentBuilder::new(self.handle.clone())
    }
    fn wait_until_policy_engine_active(&self) -> crate::waiters::policy_engine_active::PolicyEngineActiveFluentBuilder {
        crate::waiters::policy_engine_active::PolicyEngineActiveFluentBuilder::new(self.handle.clone())
    }
    fn wait_until_policy_engine_deleted(&self) -> crate::waiters::policy_engine_deleted::PolicyEngineDeletedFluentBuilder {
        crate::waiters::policy_engine_deleted::PolicyEngineDeletedFluentBuilder::new(self.handle.clone())
    }
    fn wait_until_policy_generation_completed(&self) -> crate::waiters::policy_generation_completed::PolicyGenerationCompletedFluentBuilder {
        crate::waiters::policy_generation_completed::PolicyGenerationCompletedFluentBuilder::new(self.handle.clone())
    }
}

impl Client {
    /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
    ///
    /// # 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.
    #[track_caller]
    pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
        Self::from_conf(sdk_config.into())
    }
}

mod create_agent_runtime;

mod create_agent_runtime_endpoint;

mod create_api_key_credential_provider;

mod create_browser;

mod create_browser_profile;

mod create_code_interpreter;

mod create_configuration_bundle;

mod create_evaluator;

mod create_gateway;

mod create_gateway_rule;

mod create_gateway_target;

mod create_harness;

mod create_memory;

mod create_oauth2_credential_provider;

mod create_online_evaluation_config;

mod create_policy;

mod create_policy_engine;

mod create_registry;

mod create_registry_record;

mod create_workload_identity;

/// Operation customization and supporting types.
///
/// The underlying HTTP requests made during an operation can be customized
/// by calling the `customize()` method on the builder returned from a client
/// operation call. For example, this can be used to add an additional HTTP header:
///
/// ```ignore
/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_bedrockagentcorecontrol::Error> {
/// # let client: aws_sdk_bedrockagentcorecontrol::Client = unimplemented!();
/// use ::http_1x::header::{HeaderName, HeaderValue};
///
/// let result = client.create_agent_runtime()
///     .customize()
///     .mutate_request(|req| {
///         // Add `x-example-header` with value
///         req.headers_mut()
///             .insert(
///                 HeaderName::from_static("x-example-header"),
///                 HeaderValue::from_static("1"),
///             );
///     })
///     .send()
///     .await;
/// # }
/// ```
pub mod customize;

mod delete_agent_runtime;

mod delete_agent_runtime_endpoint;

mod delete_api_key_credential_provider;

mod delete_browser;

mod delete_browser_profile;

mod delete_code_interpreter;

mod delete_configuration_bundle;

mod delete_evaluator;

mod delete_gateway;

mod delete_gateway_rule;

mod delete_gateway_target;

mod delete_harness;

mod delete_memory;

mod delete_oauth2_credential_provider;

mod delete_online_evaluation_config;

mod delete_policy;

mod delete_policy_engine;

mod delete_registry;

mod delete_registry_record;

mod delete_resource_policy;

mod delete_workload_identity;

mod get_agent_runtime;

mod get_agent_runtime_endpoint;

mod get_api_key_credential_provider;

mod get_browser;

mod get_browser_profile;

mod get_code_interpreter;

mod get_configuration_bundle;

mod get_configuration_bundle_version;

mod get_evaluator;

mod get_gateway;

mod get_gateway_rule;

mod get_gateway_target;

mod get_harness;

mod get_memory;

mod get_oauth2_credential_provider;

mod get_online_evaluation_config;

mod get_policy;

mod get_policy_engine;

mod get_policy_generation;

mod get_registry;

mod get_registry_record;

mod get_resource_policy;

mod get_token_vault;

mod get_workload_identity;

mod list_agent_runtime_endpoints;

mod list_agent_runtime_versions;

mod list_agent_runtimes;

mod list_api_key_credential_providers;

mod list_browser_profiles;

mod list_browsers;

mod list_code_interpreters;

mod list_configuration_bundle_versions;

mod list_configuration_bundles;

mod list_evaluators;

mod list_gateway_rules;

mod list_gateway_targets;

mod list_gateways;

mod list_harnesses;

mod list_memories;

mod list_oauth2_credential_providers;

mod list_online_evaluation_configs;

mod list_policies;

mod list_policy_engines;

mod list_policy_generation_assets;

mod list_policy_generations;

mod list_registries;

mod list_registry_records;

mod list_tags_for_resource;

mod list_workload_identities;

mod put_resource_policy;

mod set_token_vault_cmk;

mod start_policy_generation;

mod submit_registry_record_for_approval;

mod synchronize_gateway_targets;

mod tag_resource;

mod untag_resource;

mod update_agent_runtime;

mod update_agent_runtime_endpoint;

mod update_api_key_credential_provider;

mod update_configuration_bundle;

mod update_evaluator;

mod update_gateway;

mod update_gateway_rule;

mod update_gateway_target;

mod update_harness;

mod update_memory;

mod update_oauth2_credential_provider;

mod update_online_evaluation_config;

mod update_policy;

mod update_policy_engine;

mod update_registry;

mod update_registry_record;

mod update_registry_record_status;

mod update_workload_identity;