aws_sdk_sso/
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::invalid_html_tags)]
19
20#![forbid(unsafe_code)]
21#![warn(missing_docs)]
22#![cfg_attr(docsrs, feature(doc_cfg))]
23//! AWS IAM Identity Center (successor to AWS Single Sign-On) Portal is a web service that makes it easy for you to assign user access to IAM Identity Center resources such as the AWS access portal. Users can get AWS account applications and roles assigned to them and get federated into the application.
24//! 
25//! This reference guide describes the IAM Identity Center Portal operations that you can call programatically and includes detailed information on data types and errors.
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-sso` 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-sso = "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_sso as sso;
47//! 
48//! #[::tokio::main]
49//! async fn main() -> Result<(), sso::Error> {
50//!     let config = aws_config::load_from_env().await;
51//!     let client = aws_sdk_sso::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-sso/latest/aws_sdk_sso/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 Single Sign-On. 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 Single Sign-On.
108/// # Using the `Client`
109/// 
110/// A client has a function for every operation that can be performed by the service.
111/// For example, the [`GetRoleCredentials`](crate::operation::get_role_credentials) operation has
112/// a [`Client::get_role_credentials`], function which returns a builder for that operation.
113/// The fluent builder ultimately has a `send()` function that returns an async future that
114/// returns a result, as illustrated below:
115/// 
116/// ```rust,ignore
117/// let result = client.get_role_credentials()
118///     .role_name("example")
119///     .send()
120///     .await;
121/// ```
122/// 
123/// The underlying HTTP requests that get made by this can be modified with the `customize_operation`
124/// function on the fluent builder. See the [`customize`](crate::client::customize) module for more
125/// information.
126pub mod client;
127
128/// Configuration for AWS Single Sign-On.
129pub mod config;
130
131/// Common errors and error handling utilities.
132pub mod error;
133
134mod error_meta;
135
136/// Information about this crate.
137pub mod meta;
138
139/// All operations that this crate can perform.
140pub mod operation;
141
142/// Primitives such as `Blob` or `DateTime` used by other types.
143pub mod primitives;
144
145/// Data structures used by operation inputs/outputs.
146pub mod types;
147
148pub(crate) mod protocol_serde;
149
150mod sdk_feature_tracker;
151
152mod serialization_settings;
153
154mod endpoint_lib;
155
156mod lens;
157
158mod json_errors;
159
160#[doc(inline)]
161pub use client::Client;
162