aws_sdk_serverlessapplicationrepository/
lib.rs

1#![allow(deprecated)]
2#![allow(unknown_lints)]
3#![allow(clippy::module_inception)]
4#![allow(clippy::upper_case_acronyms)]
5#![allow(clippy::large_enum_variant)]
6#![allow(clippy::wrong_self_convention)]
7#![allow(clippy::should_implement_trait)]
8#![allow(clippy::disallowed_names)]
9#![allow(clippy::vec_init_then_push)]
10#![allow(clippy::type_complexity)]
11#![allow(clippy::needless_return)]
12#![allow(clippy::derive_partial_eq_without_eq)]
13#![allow(clippy::result_large_err)]
14#![allow(clippy::unnecessary_map_on_constructor)]
15#![allow(rustdoc::bare_urls)]
16#![allow(rustdoc::redundant_explicit_links)]
17#![allow(rustdoc::invalid_html_tags)]
18#![forbid(unsafe_code)]
19#![warn(missing_docs)]
20#![cfg_attr(docsrs, feature(doc_auto_cfg))]
21//! The AWS Serverless Application Repository makes it easy for developers and enterprises to quickly find and deploy serverless applications in the AWS Cloud. For more information about serverless applications, see Serverless Computing and Applications on the AWS website.
22//!
23//! The AWS Serverless Application Repository is deeply integrated with the AWS Lambda console, so that developers of all levels can get started with serverless computing without needing to learn anything new. You can use category keywords to browse for applications such as web and mobile backends, data processing applications, or chatbots. You can also search for applications by name, publisher, or event source. To use an application, you simply choose it, configure any required fields, and deploy it with a few clicks.
24//!
25//! You can also easily publish applications, sharing them publicly with the community at large, or privately within your team or across your organization. To publish a serverless application (or app), you can use the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS SDKs to upload the code. Along with the code, you upload a simple manifest file, also known as the AWS Serverless Application Model (AWS SAM) template. For more information about AWS SAM, see AWS Serverless Application Model (AWS SAM) on the AWS Labs GitHub repository.
26//!
27//! The AWS Serverless Application Repository Developer Guide contains more information about the two developer experiences available:
28//!   - Consuming Applications – Browse for applications and view information about them, including source code and readme files. Also install, configure, and deploy applications of your choosing. Publishing Applications – Configure and upload applications to make them available to other developers, and publish new versions of applications.
29//!
30//! ## Getting Started
31//!
32//! > Examples are available for many services and operations, check out the
33//! > [examples folder in GitHub](https://github.com/awslabs/aws-sdk-rust/tree/main/examples).
34//!
35//! The SDK provides one crate per AWS service. You must add [Tokio](https://crates.io/crates/tokio)
36//! as a dependency within your Rust project to execute asynchronous code. To add `aws-sdk-serverlessapplicationrepository` to
37//! your project, add the following to your **Cargo.toml** file:
38//!
39//! ```toml
40//! [dependencies]
41//! aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
42//! aws-sdk-serverlessapplicationrepository = "1.74.0"
43//! tokio = { version = "1", features = ["full"] }
44//! ```
45//!
46//! Then in code, a client can be created with the following:
47//!
48//! ```rust,no_run
49//! use aws_sdk_serverlessapplicationrepository as serverlessapplicationrepository;
50//!
51//! #[::tokio::main]
52//! async fn main() -> Result<(), serverlessapplicationrepository::Error> {
53//!     let config = aws_config::load_from_env().await;
54//!     let client = aws_sdk_serverlessapplicationrepository::Client::new(&config);
55//!
56//!     // ... make some calls with the client
57//!
58//!     Ok(())
59//! }
60//! ```
61//!
62//! See the [client documentation](https://docs.rs/aws-sdk-serverlessapplicationrepository/latest/aws_sdk_serverlessapplicationrepository/client/struct.Client.html)
63//! for information on what calls can be made, and the inputs and outputs for each of those calls.
64//!
65//! ## Using the SDK
66//!
67//! Until the SDK is released, we will be adding information about using the SDK to the
68//! [Developer Guide](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/welcome.html). Feel free to suggest
69//! additional sections for the guide by opening an issue and describing what you are trying to do.
70//!
71//! ## Getting Help
72//!
73//! * [GitHub discussions](https://github.com/awslabs/aws-sdk-rust/discussions) - For ideas, RFCs & general questions
74//! * [GitHub issues](https://github.com/awslabs/aws-sdk-rust/issues/new/choose) - For bug reports & feature requests
75//! * [Generated Docs (latest version)](https://awslabs.github.io/aws-sdk-rust/)
76//! * [Usage examples](https://github.com/awslabs/aws-sdk-rust/tree/main/examples)
77//!
78//!
79//! # Crate Organization
80//!
81//! The entry point for most customers will be [`Client`], which exposes one method for each API
82//! offered by AWSServerlessApplicationRepository. The return value of each of these methods is a "fluent builder",
83//! where the different inputs for that API are added by builder-style function call chaining,
84//! followed by calling `send()` to get a [`Future`](std::future::Future) that will result in
85//! either a successful output or a [`SdkError`](crate::error::SdkError).
86//!
87//! Some of these API inputs may be structs or enums to provide more complex structured information.
88//! These structs and enums live in [`types`](crate::types). There are some simpler types for
89//! representing data such as date times or binary blobs that live in [`primitives`](crate::primitives).
90//!
91//! All types required to configure a client via the [`Config`](crate::Config) struct live
92//! in [`config`](crate::config).
93//!
94//! The [`operation`](crate::operation) module has a submodule for every API, and in each submodule
95//! is the input, output, and error type for that API, as well as builders to construct each of those.
96//!
97//! There is a top-level [`Error`](crate::Error) type that encompasses all the errors that the
98//! client can return. Any other error type can be converted to this `Error` type via the
99//! [`From`](std::convert::From) trait.
100//!
101//! The other modules within this crate are not required for normal usage.
102
103// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
104pub use error_meta::Error;
105
106#[doc(inline)]
107pub use config::Config;
108
109/// Client for calling AWSServerlessApplicationRepository.
110/// ## Constructing a `Client`
111///
112/// A [`Config`] is required to construct a client. For most use cases, the [`aws-config`]
113/// crate should be used to automatically resolve this config using
114/// [`aws_config::load_from_env()`], since this will resolve an [`SdkConfig`] which can be shared
115/// across multiple different AWS SDK clients. This config resolution process can be customized
116/// by calling [`aws_config::from_env()`] instead, which returns a [`ConfigLoader`] that uses
117/// the [builder pattern] to customize the default config.
118///
119/// In the simplest case, creating a client looks as follows:
120/// ```rust,no_run
121/// # async fn wrapper() {
122/// let config = aws_config::load_from_env().await;
123/// let client = aws_sdk_serverlessapplicationrepository::Client::new(&config);
124/// # }
125/// ```
126///
127/// Occasionally, SDKs may have additional service-specific values that can be set on the [`Config`] that
128/// is absent from [`SdkConfig`], or slightly different settings for a specific client may be desired.
129/// The [`Builder`](crate::config::Builder) struct implements `From<&SdkConfig>`, so setting these specific settings can be
130/// done as follows:
131///
132/// ```rust,no_run
133/// # async fn wrapper() {
134/// let sdk_config = ::aws_config::load_from_env().await;
135/// let config = aws_sdk_serverlessapplicationrepository::config::Builder::from(&sdk_config)
136/// # /*
137///     .some_service_specific_setting("value")
138/// # */
139///     .build();
140/// # }
141/// ```
142///
143/// See the [`aws-config` docs] and [`Config`] for more information on customizing configuration.
144///
145/// _Note:_ Client construction is expensive due to connection thread pool initialization, and should
146/// be done once at application start-up.
147///
148/// [`Config`]: crate::Config
149/// [`ConfigLoader`]: https://docs.rs/aws-config/*/aws_config/struct.ConfigLoader.html
150/// [`SdkConfig`]: https://docs.rs/aws-config/*/aws_config/struct.SdkConfig.html
151/// [`aws-config` docs]: https://docs.rs/aws-config/*
152/// [`aws-config`]: https://crates.io/crates/aws-config
153/// [`aws_config::from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.from_env.html
154/// [`aws_config::load_from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.load_from_env.html
155/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
156/// # Using the `Client`
157///
158/// A client has a function for every operation that can be performed by the service.
159/// For example, the [`CreateApplication`](crate::operation::create_application) operation has
160/// a [`Client::create_application`], function which returns a builder for that operation.
161/// The fluent builder ultimately has a `send()` function that returns an async future that
162/// returns a result, as illustrated below:
163///
164/// ```rust,ignore
165/// let result = client.create_application()
166///     .author("example")
167///     .send()
168///     .await;
169/// ```
170///
171/// The underlying HTTP requests that get made by this can be modified with the `customize_operation`
172/// function on the fluent builder. See the [`customize`](crate::client::customize) module for more
173/// information.
174pub mod client;
175
176/// Configuration for AWSServerlessApplicationRepository.
177pub mod config;
178
179/// Common errors and error handling utilities.
180pub mod error;
181
182mod error_meta;
183
184/// Information about this crate.
185pub mod meta;
186
187/// All operations that this crate can perform.
188pub mod operation;
189
190/// Primitives such as `Blob` or `DateTime` used by other types.
191pub mod primitives;
192
193/// Data structures used by operation inputs/outputs.
194pub mod types;
195
196mod auth_plugin;
197
198pub(crate) mod protocol_serde;
199
200mod sdk_feature_tracker;
201
202mod serialization_settings;
203
204mod endpoint_lib;
205
206mod lens;
207
208mod json_errors;
209
210mod serde_util;
211
212#[doc(inline)]
213pub use client::Client;