aws_sdk_signin/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(clippy::deprecated_semver)]
16#![allow(rustdoc::bare_urls)]
17#![allow(rustdoc::redundant_explicit_links)]
18#![allow(rustdoc::broken_intra_doc_links)]
19#![allow(rustdoc::invalid_html_tags)]
20
21#![forbid(unsafe_code)]
22#![warn(missing_docs)]
23#![cfg_attr(docsrs, feature(doc_cfg))]
24//! AWS Sign-In manages authentication for AWS services. This service provides secure authentication flows for accessing AWS resources from the console and developer tools.
25//!
26//! ## Getting Started
27//!
28//! > Examples are available for many services and operations, check out the
29//! > [usage examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1).
30//!
31//! The SDK provides one crate per AWS service. You must add [Tokio](https://crates.io/crates/tokio)
32//! as a dependency within your Rust project to execute asynchronous code. To add `aws-sdk-signin` to
33//! your project, add the following to your **Cargo.toml** file:
34//!
35//! ```toml
36//! [dependencies]
37//! aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
38//! aws-sdk-signin = "0.0.0-local"
39//! tokio = { version = "1", features = ["full"] }
40//! ```
41//!
42//! Then in code, a client can be created with the following:
43//!
44//! ```rust,ignore
45//! use aws_sdk_signin as signin;
46//!
47//! #[::tokio::main]
48//! async fn main() -> Result<(), signin::Error> {
49//! let config = aws_config::load_from_env().await;
50//! let client = aws_sdk_signin::Client::new(&config);
51//!
52//! // ... make some calls with the client
53//!
54//! Ok(())
55//! }
56//! ```
57//!
58//! See the [client documentation](https://docs.rs/aws-sdk-signin/latest/aws_sdk_signin/client/struct.Client.html)
59//! for information on what calls can be made, and the inputs and outputs for each of those calls.
60//!
61//! ## Using the SDK
62//!
63//! Until the SDK is released, we will be adding information about using the SDK to the
64//! [Developer Guide](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/welcome.html). Feel free to suggest
65//! additional sections for the guide by opening an issue and describing what you are trying to do.
66//!
67//! ## Getting Help
68//!
69//! * [GitHub discussions](https://github.com/awslabs/aws-sdk-rust/discussions) - For ideas, RFCs & general questions
70//! * [GitHub issues](https://github.com/awslabs/aws-sdk-rust/issues/new/choose) - For bug reports & feature requests
71//! * [Generated Docs (latest version)](https://awslabs.github.io/aws-sdk-rust/)
72//! * [Usage examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1)
73//!
74//!
75//! # Crate Organization
76//!
77//! The entry point for most customers will be [`Client`], which exposes one method for each API
78//! offered by AWS Sign-In Service. The return value of each of these methods is a "fluent builder",
79//! where the different inputs for that API are added by builder-style function call chaining,
80//! followed by calling `send()` to get a [`Future`](std::future::Future) that will result in
81//! either a successful output or a [`SdkError`](crate::error::SdkError).
82//!
83//! Some of these API inputs may be structs or enums to provide more complex structured information.
84//! These structs and enums live in [`types`](crate::types). There are some simpler types for
85//! representing data such as date times or binary blobs that live in [`primitives`](crate::primitives).
86//!
87//! All types required to configure a client via the [`Config`](crate::Config) struct live
88//! in [`config`](crate::config).
89//!
90//! The [`operation`](crate::operation) module has a submodule for every API, and in each submodule
91//! is the input, output, and error type for that API, as well as builders to construct each of those.
92//!
93//! There is a top-level [`Error`](crate::Error) type that encompasses all the errors that the
94//! client can return. Any other error type can be converted to this `Error` type via the
95//! [`From`](std::convert::From) trait.
96//!
97//! The other modules within this crate are not required for normal usage.
98
99
100// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
101pub use error_meta::Error;
102
103#[doc(inline)]
104pub use config::Config;
105
106/// Client for calling AWS Sign-In Service.
107pub mod client;
108
109/// Configuration for AWS Sign-In Service.
110pub mod config;
111
112/// Common errors and error handling utilities.
113pub mod error;
114
115mod error_meta;
116
117/// Information about this crate.
118pub mod meta;
119
120/// All operations that this crate can perform.
121pub mod operation;
122
123/// Primitives such as `Blob` or `DateTime` used by other types.
124pub mod primitives;
125
126/// Data structures used by operation inputs/outputs.
127pub mod types;
128
129mod observability_feature;
130
131pub(crate) mod protocol_serde;
132
133mod sdk_feature_tracker;
134
135mod serialization_settings;
136
137mod endpoint_lib;
138
139mod serde_util;
140
141mod json_errors;
142
143#[doc(inline)]
144pub use client::Client;
145