aws-sdk-cognitoidentity

Crates.ioaws-sdk-cognitoidentity
lib.rsaws-sdk-cognitoidentity
version1.51.0
sourcesrc
created_at2021-05-07 20:08:45.565959
updated_at2024-12-04 05:36:13.689127
descriptionAWS SDK for Amazon Cognito Identity
homepage
repositoryhttps://github.com/awslabs/aws-sdk-rust
max_upload_size
id394418
size1,773,992
AWS SDK Rust Bot (aws-sdk-rust-ci)

documentation

README

aws-sdk-cognitoidentity

Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow.

For more information see Amazon Cognito Federated Identities.

Getting Started

Examples are available for many services and operations, check out the examples folder in GitHub.

The SDK provides one crate per AWS service. You must add Tokio as a dependency within your Rust project to execute asynchronous code. To add aws-sdk-cognitoidentity to your project, add the following to your Cargo.toml file:

[dependencies]
aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
aws-sdk-cognitoidentity = "1.51.0"
tokio = { version = "1", features = ["full"] }

Then in code, a client can be created with the following:

use aws_sdk_cognitoidentity as cognitoidentity;

#[::tokio::main]
async fn main() -> Result<(), cognitoidentity::Error> {
    let config = aws_config::load_from_env().await;
    let client = aws_sdk_cognitoidentity::Client::new(&config);

    // ... make some calls with the client

    Ok(())
}

See the client documentation for information on what calls can be made, and the inputs and outputs for each of those calls.

Using the SDK

Until the SDK is released, we will be adding information about using the SDK to the Developer Guide. Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do.

Getting Help

License

This project is licensed under the Apache-2.0 License.

Commit count: 1103

cargo fmt