Struct aws_sdk_cognitoidentity::client::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Client for Amazon Cognito Identity

Client for invoking operations on Amazon Cognito Identity. Each operation on Amazon Cognito Identity is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_cognitoidentity::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_cognitoidentity::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_cognitoidentity::Client::from_conf(config);

Implementations

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn create_identity_pool(&self) -> CreateIdentityPool

Constructs a fluent builder for the CreateIdentityPool operation.

The fluent builder is configurable:
- identity_pool_name(impl Into<String>) / set_identity_pool_name(Option<String>):
 A string that you provide.
- allow_unauthenticated_identities(bool) / set_allow_unauthenticated_identities(bool):
 TRUE if the identity pool supports unauthenticated logins.
- allow_classic_flow(bool) / set_allow_classic_flow(Option<bool>):
 Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
- supported_login_providers(HashMap<String, String>) / set_supported_login_providers(Option<HashMap<String, String>>):
 Optional key:value pairs mapping provider names to provider app IDs.
- developer_provider_name(impl Into<String>) / set_developer_provider_name(Option<String>):
 The “domain” by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).
 
 Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
- open_id_connect_provider_ar_ns(Vec<String>) / set_open_id_connect_provider_ar_ns(Option<Vec<String>>):
 The Amazon Resource Names (ARN) of the OpenID Connect providers.
- cognito_identity_providers(Vec<CognitoIdentityProvider>) / set_cognito_identity_providers(Option<Vec<CognitoIdentityProvider>>):
 An array of Amazon Cognito user pools and their client IDs.
- saml_provider_ar_ns(Vec<String>) / set_saml_provider_ar_ns(Option<Vec<String>>):
 An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
- identity_pool_tags(HashMap<String, String>) / set_identity_pool_tags(Option<HashMap<String, String>>):
 Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
On success, responds with CreateIdentityPoolOutput with field(s):
- identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
- identity_pool_name(Option<String>):
 A string that you provide.
- allow_unauthenticated_identities(bool):
 TRUE if the identity pool supports unauthenticated logins.
- allow_classic_flow(Option<bool>):
 Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
- supported_login_providers(Option<HashMap<String, String>>):
 Optional key:value pairs mapping provider names to provider app IDs.
- developer_provider_name(Option<String>):
 The “domain” by which Cognito will refer to your users.
- open_id_connect_provider_ar_ns(Option<Vec<String>>):
 The ARNs of the OpenID Connect providers.
- cognito_identity_providers(Option<Vec<CognitoIdentityProvider>>):
 A list representing an Amazon Cognito user pool and its client ID.
- saml_provider_ar_ns(Option<Vec<String>>):
 An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
- identity_pool_tags(Option<HashMap<String, String>>):
 The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
On failure, responds with SdkError<CreateIdentityPoolError>

source

pub fn delete_identities(&self) -> DeleteIdentities

Constructs a fluent builder for the DeleteIdentities operation.

The fluent builder is configurable:
- identity_ids_to_delete(Vec<String>) / set_identity_ids_to_delete(Option<Vec<String>>):
 A list of 1-60 identities that you want to delete.
On success, responds with DeleteIdentitiesOutput with field(s):
- unprocessed_identity_ids(Option<Vec<UnprocessedIdentityId>>):
 An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
On failure, responds with SdkError<DeleteIdentitiesError>

source

pub fn delete_identity_pool(&self) -> DeleteIdentityPool

Constructs a fluent builder for the DeleteIdentityPool operation.

The fluent builder is configurable:
- identity_pool_id(impl Into<String>) / set_identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
On success, responds with DeleteIdentityPoolOutput
On failure, responds with SdkError<DeleteIdentityPoolError>

source

pub fn describe_identity(&self) -> DescribeIdentity

Constructs a fluent builder for the DescribeIdentity operation.

The fluent builder is configurable:
- identity_id(impl Into<String>) / set_identity_id(Option<String>):
 A unique identifier in the format REGION:GUID.
On success, responds with DescribeIdentityOutput with field(s):
- identity_id(Option<String>):
 A unique identifier in the format REGION:GUID.
- logins(Option<Vec<String>>):
 The provider names.
- creation_date(Option<DateTime>):
 Date on which the identity was created.
- last_modified_date(Option<DateTime>):
 Date on which the identity was last modified.
On failure, responds with SdkError<DescribeIdentityError>

source

pub fn describe_identity_pool(&self) -> DescribeIdentityPool

Constructs a fluent builder for the DescribeIdentityPool operation.

The fluent builder is configurable:
- identity_pool_id(impl Into<String>) / set_identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
On success, responds with DescribeIdentityPoolOutput with field(s):
- identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
- identity_pool_name(Option<String>):
 A string that you provide.
- allow_unauthenticated_identities(bool):
 TRUE if the identity pool supports unauthenticated logins.
- allow_classic_flow(Option<bool>):
 Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
- supported_login_providers(Option<HashMap<String, String>>):
 Optional key:value pairs mapping provider names to provider app IDs.
- developer_provider_name(Option<String>):
 The “domain” by which Cognito will refer to your users.
- open_id_connect_provider_ar_ns(Option<Vec<String>>):
 The ARNs of the OpenID Connect providers.
- cognito_identity_providers(Option<Vec<CognitoIdentityProvider>>):
 A list representing an Amazon Cognito user pool and its client ID.
- saml_provider_ar_ns(Option<Vec<String>>):
 An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
- identity_pool_tags(Option<HashMap<String, String>>):
 The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
On failure, responds with SdkError<DescribeIdentityPoolError>

source

pub fn get_credentials_for_identity(&self) -> GetCredentialsForIdentity

Constructs a fluent builder for the GetCredentialsForIdentity operation.

The fluent builder is configurable:
- identity_id(impl Into<String>) / set_identity_id(Option<String>):
 A unique identifier in the format REGION:GUID.
- logins(HashMap<String, String>) / set_logins(Option<HashMap<String, String>>):
 A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax “provider_name”: “provider_user_identifier”.
 
 Logins should not be specified when trying to get credentials for an unauthenticated identity.
 
 The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.
- custom_role_arn(impl Into<String>) / set_custom_role_arn(Option<String>):
 The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.
On success, responds with GetCredentialsForIdentityOutput with field(s):
- identity_id(Option<String>):
 A unique identifier in the format REGION:GUID.
- credentials(Option<Credentials>):
 Credentials for the provided identity ID.
On failure, responds with SdkError<GetCredentialsForIdentityError>

source

pub fn get_id(&self) -> GetId

Constructs a fluent builder for the GetId operation.

The fluent builder is configurable:
- account_id(impl Into<String>) / set_account_id(Option<String>):
 A standard AWS account ID (9+ digits).
- identity_pool_id(impl Into<String>) / set_identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
- logins(HashMap<String, String>) / set_logins(Option<HashMap<String, String>>):
 A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows:
 - Facebook: graph.facebook.com
 - Amazon Cognito user pool: cognito-idp. .amazonaws.com/ <your_user_pool_id></your_user_pool_id> , for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
 - Google: accounts.google.com
 - Amazon: www.amazon.com
 - Twitter: api.twitter.com
 - Digits: www.digits.com
On success, responds with GetIdOutput with field(s):
- identity_id(Option<String>):
 A unique identifier in the format REGION:GUID.
On failure, responds with SdkError<GetIdError>

source

pub fn get_identity_pool_roles(&self) -> GetIdentityPoolRoles

Constructs a fluent builder for the GetIdentityPoolRoles operation.

The fluent builder is configurable:
- identity_pool_id(impl Into<String>) / set_identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
On success, responds with GetIdentityPoolRolesOutput with field(s):
- identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
- roles(Option<HashMap<String, String>>):
 The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
- role_mappings(Option<HashMap<String, RoleMapping>>):
 How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object map. The string identifies the identity provider, for example, “graph.facebook.com” or “cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id”.
On failure, responds with SdkError<GetIdentityPoolRolesError>

source

pub fn get_open_id_token(&self) -> GetOpenIdToken

Constructs a fluent builder for the GetOpenIdToken operation.

The fluent builder is configurable:
- identity_id(impl Into<String>) / set_identity_id(Option<String>):
 A unique identifier in the format REGION:GUID.
- logins(HashMap<String, String>) / set_logins(Option<HashMap<String, String>>):
 A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider’s authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenID Connect provider, always include the id_token.
On success, responds with GetOpenIdTokenOutput with field(s):
- identity_id(Option<String>):
 A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.
- token(Option<String>):
 An OpenID token, valid for 10 minutes.
On failure, responds with SdkError<GetOpenIdTokenError>

source

pub fn get_open_id_token_for_developer_identity(
&self
) -> GetOpenIdTokenForDeveloperIdentity

Constructs a fluent builder for the GetOpenIdTokenForDeveloperIdentity operation.

The fluent builder is configurable:
- identity_pool_id(impl Into<String>) / set_identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
- identity_id(impl Into<String>) / set_identity_id(Option<String>):
 A unique identifier in the format REGION:GUID.
- logins(HashMap<String, String>) / set_logins(Option<HashMap<String, String>>):
 A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax “developer_provider_name”: “developer_user_identifier”. The developer provider is the “domain” by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.
- principal_tags(HashMap<String, String>) / set_principal_tags(Option<HashMap<String, String>>):
 Use this operation to configure attribute mappings for custom providers.
- token_duration(i64) / set_token_duration(Option<i64>):
 The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don’t provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token’s duration.
 
 Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.
On success, responds with GetOpenIdTokenForDeveloperIdentityOutput with field(s):
- identity_id(Option<String>):
 A unique identifier in the format REGION:GUID.
- token(Option<String>):
 An OpenID token.
On failure, responds with SdkError<GetOpenIdTokenForDeveloperIdentityError>

source

pub fn get_principal_tag_attribute_map(&self) -> GetPrincipalTagAttributeMap

Constructs a fluent builder for the GetPrincipalTagAttributeMap operation.

The fluent builder is configurable:
- identity_pool_id(impl Into<String>) / set_identity_pool_id(Option<String>):
 You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.
- identity_provider_name(impl Into<String>) / set_identity_provider_name(Option<String>):
 You can use this operation to get the provider name.
On success, responds with GetPrincipalTagAttributeMapOutput with field(s):
- identity_pool_id(Option<String>):
 You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.
- identity_provider_name(Option<String>):
 You can use this operation to get the provider name.
- use_defaults(Option<bool>):
 You can use this operation to list
- principal_tags(Option<HashMap<String, String>>):
 You can use this operation to add principal tags. The PrincipalTagsoperation enables you to reference user attributes in your IAM permissions policy.
On failure, responds with SdkError<GetPrincipalTagAttributeMapError>

source

pub fn list_identities(&self) -> ListIdentities

Constructs a fluent builder for the ListIdentities operation.

The fluent builder is configurable:
- identity_pool_id(impl Into<String>) / set_identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
- max_results(i32) / set_max_results(i32):
 The maximum number of identities to return.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A pagination token.
- hide_disabled(bool) / set_hide_disabled(bool):
 An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
On success, responds with ListIdentitiesOutput with field(s):
- identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
- identities(Option<Vec<IdentityDescription>>):
 An object containing a set of identities and associated mappings.
- next_token(Option<String>):
 A pagination token.
On failure, responds with SdkError<ListIdentitiesError>

source

pub fn list_identity_pools(&self) -> ListIdentityPools

Constructs a fluent builder for the ListIdentityPools operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- max_results(i32) / set_max_results(i32):
 The maximum number of identities to return.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A pagination token.
On success, responds with ListIdentityPoolsOutput with field(s):
- identity_pools(Option<Vec<IdentityPoolShortDescription>>):
 The identity pools returned by the ListIdentityPools action.
- next_token(Option<String>):
 A pagination token.
On failure, responds with SdkError<ListIdentityPoolsError>

source

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.
On success, responds with ListTagsForResourceOutput with field(s):
- tags(Option<HashMap<String, String>>):
 The tags that are assigned to the identity pool.
On failure, responds with SdkError<ListTagsForResourceError>

source

pub fn lookup_developer_identity(&self) -> LookupDeveloperIdentity

Constructs a fluent builder for the LookupDeveloperIdentity operation.

The fluent builder is configurable:
- identity_pool_id(impl Into<String>) / set_identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
- identity_id(impl Into<String>) / set_identity_id(Option<String>):
 A unique identifier in the format REGION:GUID.
- developer_user_identifier(impl Into<String>) / set_developer_user_identifier(Option<String>):
 A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
- max_results(i32) / set_max_results(i32):
 The maximum number of identities to return.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let’s say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
On success, responds with LookupDeveloperIdentityOutput with field(s):
- identity_id(Option<String>):
 A unique identifier in the format REGION:GUID.
- developer_user_identifier_list(Option<Vec<String>>):
 This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
- next_token(Option<String>):
 A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let’s say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
On failure, responds with SdkError<LookupDeveloperIdentityError>

source

pub fn merge_developer_identities(&self) -> MergeDeveloperIdentities

Constructs a fluent builder for the MergeDeveloperIdentities operation.

The fluent builder is configurable:
- source_user_identifier(impl Into<String>) / set_source_user_identifier(Option<String>):
 User identifier for the source user. The value should be a DeveloperUserIdentifier.
- destination_user_identifier(impl Into<String>) / set_destination_user_identifier(Option<String>):
 User identifier for the destination user. The value should be a DeveloperUserIdentifier.
- developer_provider_name(impl Into<String>) / set_developer_provider_name(Option<String>):
 The “domain” by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).
- identity_pool_id(impl Into<String>) / set_identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
On success, responds with MergeDeveloperIdentitiesOutput with field(s):
- identity_id(Option<String>):
 A unique identifier in the format REGION:GUID.
On failure, responds with SdkError<MergeDeveloperIdentitiesError>

source

pub fn set_identity_pool_roles(&self) -> SetIdentityPoolRoles

Constructs a fluent builder for the SetIdentityPoolRoles operation.

The fluent builder is configurable:
- identity_pool_id(impl Into<String>) / set_identity_pool_id(Option<String>):
 An identity pool ID in the format REGION:GUID.
- roles(HashMap<String, String>) / set_roles(Option<HashMap<String, String>>):
 The map of roles associated with this pool. For a given role, the key will be either “authenticated” or “unauthenticated” and the value will be the Role ARN.
- role_mappings(HashMap<String, RoleMapping>) / set_role_mappings(Option<HashMap<String, RoleMapping>>):
 How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, “graph.facebook.com” or “cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id”.
 
 Up to 25 rules can be specified per identity provider.
On success, responds with SetIdentityPoolRolesOutput
On failure, responds with SdkError<SetIdentityPoolRolesError>