aws_sdk_codeartifact/
client.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[derive(Debug)]
3pub(crate) struct Handle {
4    pub(crate) conf: crate::Config,
5    #[allow(dead_code)] // unused when a service does not provide any operations
6    pub(crate) runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
7}
8
9/// Client for CodeArtifact
10///
11/// Client for invoking operations on CodeArtifact. Each operation on CodeArtifact is a method on this
12/// this struct. `.send()` MUST be invoked on the generated operations to dispatch the request to the service.
13/// ## Constructing a `Client`
14///
15/// A [`Config`] is required to construct a client. For most use cases, the [`aws-config`]
16/// crate should be used to automatically resolve this config using
17/// [`aws_config::load_from_env()`], since this will resolve an [`SdkConfig`] which can be shared
18/// across multiple different AWS SDK clients. This config resolution process can be customized
19/// by calling [`aws_config::from_env()`] instead, which returns a [`ConfigLoader`] that uses
20/// the [builder pattern] to customize the default config.
21///
22/// In the simplest case, creating a client looks as follows:
23/// ```rust,no_run
24/// # async fn wrapper() {
25/// let config = aws_config::load_from_env().await;
26/// let client = aws_sdk_codeartifact::Client::new(&config);
27/// # }
28/// ```
29///
30/// Occasionally, SDKs may have additional service-specific values that can be set on the [`Config`] that
31/// is absent from [`SdkConfig`], or slightly different settings for a specific client may be desired.
32/// The [`Builder`](crate::config::Builder) struct implements `From<&SdkConfig>`, so setting these specific settings can be
33/// done as follows:
34///
35/// ```rust,no_run
36/// # async fn wrapper() {
37/// let sdk_config = ::aws_config::load_from_env().await;
38/// let config = aws_sdk_codeartifact::config::Builder::from(&sdk_config)
39/// # /*
40///     .some_service_specific_setting("value")
41/// # */
42///     .build();
43/// # }
44/// ```
45///
46/// See the [`aws-config` docs] and [`Config`] for more information on customizing configuration.
47///
48/// _Note:_ Client construction is expensive due to connection thread pool initialization, and should
49/// be done once at application start-up.
50///
51/// [`Config`]: crate::Config
52/// [`ConfigLoader`]: https://docs.rs/aws-config/*/aws_config/struct.ConfigLoader.html
53/// [`SdkConfig`]: https://docs.rs/aws-config/*/aws_config/struct.SdkConfig.html
54/// [`aws-config` docs]: https://docs.rs/aws-config/*
55/// [`aws-config`]: https://crates.io/crates/aws-config
56/// [`aws_config::from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.from_env.html
57/// [`aws_config::load_from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.load_from_env.html
58/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
59/// # Using the `Client`
60///
61/// A client has a function for every operation that can be performed by the service.
62/// For example, the [`AssociateExternalConnection`](crate::operation::associate_external_connection) operation has
63/// a [`Client::associate_external_connection`], function which returns a builder for that operation.
64/// The fluent builder ultimately has a `send()` function that returns an async future that
65/// returns a result, as illustrated below:
66///
67/// ```rust,ignore
68/// let result = client.associate_external_connection()
69///     .domain("example")
70///     .send()
71///     .await;
72/// ```
73///
74/// The underlying HTTP requests that get made by this can be modified with the `customize_operation`
75/// function on the fluent builder. See the [`customize`](crate::client::customize) module for more
76/// information.
77#[derive(::std::clone::Clone, ::std::fmt::Debug)]
78pub struct Client {
79    handle: ::std::sync::Arc<Handle>,
80}
81
82impl Client {
83    /// Creates a new client from the service [`Config`](crate::Config).
84    ///
85    /// # Panics
86    ///
87    /// This method will panic in the following cases:
88    ///
89    /// - Retries or timeouts are enabled without a `sleep_impl` configured.
90    /// - Identity caching is enabled without a `sleep_impl` and `time_source` configured.
91    /// - No `behavior_version` is provided.
92    ///
93    /// The panic message for each of these will have instructions on how to resolve them.
94    #[track_caller]
95    pub fn from_conf(conf: crate::Config) -> Self {
96        let handle = Handle {
97            conf: conf.clone(),
98            runtime_plugins: crate::config::base_client_runtime_plugins(conf),
99        };
100        if let Err(err) = Self::validate_config(&handle) {
101            panic!("Invalid client configuration: {err}");
102        }
103        Self {
104            handle: ::std::sync::Arc::new(handle),
105        }
106    }
107
108    /// Returns the client's configuration.
109    pub fn config(&self) -> &crate::Config {
110        &self.handle.conf
111    }
112
113    fn validate_config(handle: &Handle) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
114        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
115        handle
116            .runtime_plugins
117            .apply_client_configuration(&mut cfg)?
118            .validate_base_client_config(&cfg)?;
119        Ok(())
120    }
121}
122
123impl Client {
124    /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
125    ///
126    /// # Panics
127    ///
128    /// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
129    ///     the `sleep_impl` on the Config passed into this function to fix it.
130    /// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
131    ///     `http_connector` on the Config passed into this function to fix it.
132    /// - 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.
133    #[track_caller]
134    pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
135        Self::from_conf(sdk_config.into())
136    }
137}
138
139mod associate_external_connection;
140
141mod copy_package_versions;
142
143mod create_domain;
144
145mod create_package_group;
146
147mod create_repository;
148
149/// Operation customization and supporting types.
150///
151/// The underlying HTTP requests made during an operation can be customized
152/// by calling the `customize()` method on the builder returned from a client
153/// operation call. For example, this can be used to add an additional HTTP header:
154///
155/// ```ignore
156/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_codeartifact::Error> {
157/// # let client: aws_sdk_codeartifact::Client = unimplemented!();
158/// use ::http::header::{HeaderName, HeaderValue};
159///
160/// let result = client.associate_external_connection()
161///     .customize()
162///     .mutate_request(|req| {
163///         // Add `x-example-header` with value
164///         req.headers_mut()
165///             .insert(
166///                 HeaderName::from_static("x-example-header"),
167///                 HeaderValue::from_static("1"),
168///             );
169///     })
170///     .send()
171///     .await;
172/// # }
173/// ```
174pub mod customize;
175
176mod delete_domain;
177
178mod delete_domain_permissions_policy;
179
180mod delete_package;
181
182mod delete_package_group;
183
184mod delete_package_versions;
185
186mod delete_repository;
187
188mod delete_repository_permissions_policy;
189
190mod describe_domain;
191
192mod describe_package;
193
194mod describe_package_group;
195
196mod describe_package_version;
197
198mod describe_repository;
199
200mod disassociate_external_connection;
201
202mod dispose_package_versions;
203
204mod get_associated_package_group;
205
206mod get_authorization_token;
207
208mod get_domain_permissions_policy;
209
210mod get_package_version_asset;
211
212mod get_package_version_readme;
213
214mod get_repository_endpoint;
215
216mod get_repository_permissions_policy;
217
218mod list_allowed_repositories_for_group;
219
220mod list_associated_packages;
221
222mod list_domains;
223
224mod list_package_groups;
225
226mod list_package_version_assets;
227
228mod list_package_version_dependencies;
229
230mod list_package_versions;
231
232mod list_packages;
233
234mod list_repositories;
235
236mod list_repositories_in_domain;
237
238mod list_sub_package_groups;
239
240mod list_tags_for_resource;
241
242mod publish_package_version;
243
244mod put_domain_permissions_policy;
245
246mod put_package_origin_configuration;
247
248mod put_repository_permissions_policy;
249
250mod tag_resource;
251
252mod untag_resource;
253
254mod update_package_group;
255
256mod update_package_group_origin_configuration;
257
258mod update_package_versions_status;
259
260mod update_repository;