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