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