Module Smaws_Client_CognitoIdentity

Cognito Identity client library built on EIO.

Types

type nonrec too_many_requests_exception = {
  1. message : string option;
    (*

    Message returned by a TooManyRequestsException

    *)
}

Thrown when a request is throttled.

type nonrec resource_not_found_exception = {
  1. message : string option;
    (*

    The message returned by a ResourceNotFoundException.

    *)
}

Thrown when the requested resource (for example, a dataset or record) does not exist.

type nonrec resource_conflict_exception = {
  1. message : string option;
    (*

    The message returned by a ResourceConflictException.

    *)
}

Thrown when a user tries to use a login which is already linked to another account.

type nonrec not_authorized_exception = {
  1. message : string option;
    (*

    The message returned by a NotAuthorizedException

    *)
}

Thrown when a user is not authorized to access the requested resource.

type nonrec limit_exceeded_exception = {
  1. message : string option;
    (*

    The message returned by a LimitExceededException.

    *)
}

Thrown when the total number of user pools has exceeded a preset limit.

type nonrec invalid_parameter_exception = {
  1. message : string option;
    (*

    The message returned by an InvalidParameterException.

    *)
}

Thrown for missing or bad input parameter(s).

type nonrec internal_error_exception = {
  1. message : string option;
    (*

    The message returned by an InternalErrorException.

    *)
}

Thrown when the service encounters an error during processing the request.

type nonrec concurrent_modification_exception = {
  1. message : string option;
    (*

    The message returned by a ConcurrentModificationException.

    *)
}

Thrown if there are parallel requests to modify a resource.

type nonrec identity_providers = (string * string) list
type nonrec cognito_identity_provider = {
  1. server_side_token_check : bool option;
    (*

    TRUE if server-side token validation is enabled for the identity provider’s token.

    Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

    If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

    *)
  2. client_id : string option;
    (*

    The client ID for the Amazon Cognito user pool.

    *)
  3. provider_name : string option;
    (*

    The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

    *)
}

A provider representing an Amazon Cognito user pool and its client ID.

type nonrec identity_pool_tags_type = (string * string) list
type nonrec identity_pool = {
  1. identity_pool_tags : identity_pool_tags_type option;
    (*

    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.

    *)
  2. saml_provider_ar_ns : string list option;
    (*

    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

    *)
  3. cognito_identity_providers : cognito_identity_provider list option;
    (*

    A list representing an Amazon Cognito user pool and its client ID.

    *)
  4. open_id_connect_provider_ar_ns : string list option;
    (*

    The ARNs of the OpenID Connect providers.

    *)
  5. developer_provider_name : string option;
    (*

    The "domain" by which Cognito will refer to your users.

    *)
  6. supported_login_providers : identity_providers option;
    (*

    Optional key:value pairs mapping provider names to provider app IDs.

    *)
  7. allow_classic_flow : bool option;
    (*

    Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

    *)
  8. allow_unauthenticated_identities : bool;
    (*

    TRUE if the identity pool supports unauthenticated logins.

    *)
  9. identity_pool_name : string;
    (*

    A string that you provide.

    *)
  10. identity_pool_id : string;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
}

An object representing an Amazon Cognito identity pool.

type nonrec untag_resource_input = {
  1. tag_keys : string list;
    (*

    The keys of the tags to remove from the user pool.

    *)
  2. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the identity pool.

    *)
}
type nonrec error_code =
  1. | INTERNAL_SERVER_ERROR
  2. | ACCESS_DENIED
type nonrec unprocessed_identity_id = {
  1. error_code : error_code option;
    (*

    The error code indicating the type of error that occurred.

    *)
  2. identity_id : string option;
    (*

    A unique identifier in the format REGION:GUID.

    *)
}

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

type nonrec logins_map = (string * string) list

Input to the UnlinkIdentity action.

type nonrec external_service_exception = {
  1. message : string option;
    (*

    The message returned by an ExternalServiceException

    *)
}

An exception thrown when a dependent service such as Facebook or Twitter is not responding

Input to the UnlinkDeveloperIdentity action.

type nonrec tag_resource_input = {
  1. tags : identity_pool_tags_type;
    (*

    The tags to assign to the identity pool.

    *)
  2. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the identity pool.

    *)
}
type nonrec principal_tags = (string * string) list
type nonrec set_principal_tag_attribute_map_response = {
  1. principal_tags : principal_tags option;
    (*

    You can use this operation to add principal tags. The PrincipalTagsoperation enables you to reference user attributes in your IAM permissions policy.

    *)
  2. use_defaults : bool option;
    (*

    You can use this operation to select default (username and clientID) attribute mappings.

    *)
  3. identity_provider_name : string option;
    (*

    The provider name you want to use for attribute mappings.

    *)
  4. identity_pool_id : string option;
    (*

    The ID of the Identity Pool you want to set attribute mappings for.

    *)
}
type nonrec set_principal_tag_attribute_map_input = {
  1. principal_tags : principal_tags option;
    (*

    You can use this operation to add principal tags.

    *)
  2. use_defaults : bool option;
    (*

    You can use this operation to use default (username and clientID) attribute mappings.

    *)
  3. identity_provider_name : string;
    (*

    The provider name you want to use for attribute mappings.

    *)
  4. identity_pool_id : string;
    (*

    The ID of the Identity Pool you want to set attribute mappings for.

    *)
}
type nonrec roles_map = (string * string) list
type nonrec role_mapping_type =
  1. | RULES
  2. | TOKEN
type nonrec ambiguous_role_resolution_type =
  1. | DENY
  2. | AUTHENTICATED_ROLE
type nonrec mapping_rule_match_type =
  1. | NOT_EQUAL
  2. | STARTS_WITH
  3. | CONTAINS
  4. | EQUALS
type nonrec mapping_rule = {
  1. role_ar_n : string;
    (*

    The role ARN.

    *)
  2. value : string;
    (*

    A brief string that the claim must match, for example, "paid" or "yes".

    *)
  3. match_type : mapping_rule_match_type;
    (*

    The match condition that specifies how closely the claim value in the IdP token must match Value.

    *)
  4. claim : string;
    (*

    The claim name that must be present in the token, for example, "isAdmin" or "paid".

    *)
}

A rule that maps a claim name, a claim value, and a match type to a role ARN.

type nonrec rules_configuration_type = {
  1. rules : mapping_rule list;
    (*

    An array of rules. You can specify up to 25 rules per identity provider.

    Rules are evaluated in order. The first one to match specifies the role.

    *)
}

A container for rules.

type nonrec role_mapping = {
  1. rules_configuration : rules_configuration_type option;
    (*

    The rules to be used for mapping users to roles.

    If you specify Rules as the role mapping type, RulesConfiguration is required.

    *)
  2. ambiguous_role_resolution : ambiguous_role_resolution_type option;
    (*

    If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

    Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

    *)
  3. type_ : role_mapping_type;
    (*

    The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

    *)
}

A role mapping.

type nonrec role_mapping_map = (string * role_mapping) list
type nonrec set_identity_pool_roles_input = {
  1. role_mappings : role_mapping_map option;
    (*

    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.

    *)
  2. roles : roles_map;
    (*

    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.

    *)
  3. identity_pool_id : string;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
}

Input to the SetIdentityPoolRoles action.

type nonrec merge_developer_identities_response = {
  1. identity_id : string option;
    (*

    A unique identifier in the format REGION:GUID.

    *)
}

Returned in response to a successful MergeDeveloperIdentities action.

type nonrec merge_developer_identities_input = {
  1. identity_pool_id : string;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
  2. developer_provider_name : 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 (-).

    *)
  3. destination_user_identifier : string;
    (*

    User identifier for the destination user. The value should be a DeveloperUserIdentifier.

    *)
  4. source_user_identifier : string;
    (*

    User identifier for the source user. The value should be a DeveloperUserIdentifier.

    *)
}

Input to the MergeDeveloperIdentities action.

type nonrec lookup_developer_identity_response = {
  1. next_token : string option;
    (*

    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.

    *)
  2. developer_user_identifier_list : string list option;
    (*

    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.

    *)
  3. identity_id : string option;
    (*

    A unique identifier in the format REGION:GUID.

    *)
}

Returned in response to a successful LookupDeveloperIdentity action.

type nonrec lookup_developer_identity_input = {
  1. next_token : string option;
    (*

    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.

    *)
  2. max_results : int option;
    (*

    The maximum number of identities to return.

    *)
  3. developer_user_identifier : string option;
    (*

    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.

    *)
  4. identity_id : string option;
    (*

    A unique identifier in the format REGION:GUID.

    *)
  5. identity_pool_id : string;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
}

Input to the LookupDeveloperIdentityInput action.

type nonrec list_tags_for_resource_response = {
  1. tags : identity_pool_tags_type option;
    (*

    The tags that are assigned to the identity pool.

    *)
}
type nonrec list_tags_for_resource_input = {
  1. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.

    *)
}
type nonrec identity_pool_short_description = {
  1. identity_pool_name : string option;
    (*

    A string that you provide.

    *)
  2. identity_pool_id : string option;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
}

A description of the identity pool.

type nonrec list_identity_pools_response = {
  1. next_token : string option;
    (*

    A pagination token.

    *)
  2. identity_pools : identity_pool_short_description list option;
    (*

    The identity pools returned by the ListIdentityPools action.

    *)
}

The result of a successful ListIdentityPools action.

type nonrec list_identity_pools_input = {
  1. next_token : string option;
    (*

    A pagination token.

    *)
  2. max_results : int;
    (*

    The maximum number of identities to return.

    *)
}

Input to the ListIdentityPools action.

type nonrec identity_description = {
  1. last_modified_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    Date on which the identity was last modified.

    *)
  2. creation_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    Date on which the identity was created.

    *)
  3. logins : string list option;
    (*

    The provider names.

    *)
  4. identity_id : string option;
    (*

    A unique identifier in the format REGION:GUID.

    *)
}

A description of the identity.

type nonrec list_identities_response = {
  1. next_token : string option;
    (*

    A pagination token.

    *)
  2. identities : identity_description list option;
    (*

    An object containing a set of identities and associated mappings.

    *)
  3. identity_pool_id : string option;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
}

The response to a ListIdentities request.

type nonrec list_identities_input = {
  1. hide_disabled : bool option;
    (*

    An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

    *)
  2. next_token : string option;
    (*

    A pagination token.

    *)
  3. max_results : int;
    (*

    The maximum number of identities to return.

    *)
  4. identity_pool_id : string;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
}

Input to the ListIdentities action.

type nonrec invalid_identity_pool_configuration_exception = {
  1. message : string option;
    (*

    The message returned for an InvalidIdentityPoolConfigurationException

    *)
}

Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.

type nonrec get_principal_tag_attribute_map_response = {
  1. principal_tags : principal_tags option;
    (*

    You can use this operation to add principal tags. The PrincipalTagsoperation enables you to reference user attributes in your IAM permissions policy.

    *)
  2. use_defaults : bool option;
    (*

    You can use this operation to list

    *)
  3. identity_provider_name : string option;
    (*

    You can use this operation to get the provider name.

    *)
  4. identity_pool_id : string option;
    (*

    You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.

    *)
}
type nonrec get_principal_tag_attribute_map_input = {
  1. identity_provider_name : string;
    (*

    You can use this operation to get the provider name.

    *)
  2. identity_pool_id : string;
    (*

    You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.

    *)
}
type nonrec get_open_id_token_response = {
  1. token : string option;
    (*

    An OpenID token, valid for 10 minutes.

    *)
  2. identity_id : string option;
    (*

    A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.

    *)
}

Returned in response to a successful GetOpenIdToken request.

type nonrec get_open_id_token_input = {
  1. logins : logins_map option;
    (*

    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.

    *)
  2. identity_id : string;
    (*

    A unique identifier in the format REGION:GUID.

    *)
}

Input to the GetOpenIdToken action.

type nonrec get_open_id_token_for_developer_identity_response = {
  1. token : string option;
    (*

    An OpenID token.

    *)
  2. identity_id : string option;
    (*

    A unique identifier in the format REGION:GUID.

    *)
}

Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.

type nonrec get_open_id_token_for_developer_identity_input = {
  1. token_duration : int option;
    (*

    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.

    *)
  2. principal_tags : principal_tags option;
    (*

    Use this operation to configure attribute mappings for custom providers.

    *)
  3. logins : logins_map;
    (*

    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.

    *)
  4. identity_id : string option;
    (*

    A unique identifier in the format REGION:GUID.

    *)
  5. identity_pool_id : string;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
}

Input to the GetOpenIdTokenForDeveloperIdentity action.

type nonrec developer_user_already_registered_exception = {
  1. message : string option;
    (*

    This developer user identifier is already registered with Cognito.

    *)
}

The provided developer user identifier is already registered with Cognito under a different identity ID.

type nonrec get_identity_pool_roles_response = {
  1. role_mappings : role_mapping_map option;
    (*

    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".

    *)
  2. roles : roles_map option;
    (*

    The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.

    *)
  3. identity_pool_id : string option;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
}

Returned in response to a successful GetIdentityPoolRoles operation.

type nonrec get_identity_pool_roles_input = {
  1. identity_pool_id : string;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
}

Input to the GetIdentityPoolRoles action.

type nonrec get_id_response = {
  1. identity_id : string option;
    (*

    A unique identifier in the format REGION:GUID.

    *)
}

Returned in response to a GetId request.

type nonrec get_id_input = {
  1. logins : logins_map option;
    (*

    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/

      , 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
    *)
  2. identity_pool_id : string;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
  3. account_id : string option;
    (*

    A standard AWS account ID (9+ digits).

    *)
}

Input to the GetId action.

type nonrec credentials = {
  1. expiration : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    The date at which these credentials will expire.

    *)
  2. session_token : string option;
    (*

    The Session Token portion of the credentials

    *)
  3. secret_key : string option;
    (*

    The Secret Access Key portion of the credentials

    *)
  4. access_key_id : string option;
    (*

    The Access Key portion of the credentials.

    *)
}

Credentials for the provided identity ID.

type nonrec get_credentials_for_identity_response = {
  1. credentials : credentials option;
    (*

    Credentials for the provided identity ID.

    *)
  2. identity_id : string option;
    (*

    A unique identifier in the format REGION:GUID.

    *)
}

Returned in response to a successful GetCredentialsForIdentity operation.

type nonrec get_credentials_for_identity_input = {
  1. custom_role_arn : string option;
    (*

    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.

    *)
  2. logins : logins_map option;
    (*

    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.

    *)
  3. identity_id : string;
    (*

    A unique identifier in the format REGION:GUID.

    *)
}

Input to the GetCredentialsForIdentity action.

type nonrec describe_identity_pool_input = {
  1. identity_pool_id : string;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
}

Input to the DescribeIdentityPool action.

type nonrec describe_identity_input = {
  1. identity_id : string;
    (*

    A unique identifier in the format REGION:GUID.

    *)
}

Input to the DescribeIdentity action.

type nonrec delete_identity_pool_input = {
  1. identity_pool_id : string;
    (*

    An identity pool ID in the format REGION:GUID.

    *)
}

Input to the DeleteIdentityPool action.

type nonrec delete_identities_response = {
  1. unprocessed_identity_ids : unprocessed_identity_id list option;
    (*

    An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

    *)
}

Returned in response to a successful DeleteIdentities operation.

type nonrec delete_identities_input = {
  1. identity_ids_to_delete : string list;
    (*

    A list of 1-60 identities that you want to delete.

    *)
}

Input to the DeleteIdentities action.

type nonrec create_identity_pool_input = {
  1. identity_pool_tags : identity_pool_tags_type option;
    (*

    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.

    *)
  2. saml_provider_ar_ns : string list option;
    (*

    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

    *)
  3. cognito_identity_providers : cognito_identity_provider list option;
    (*

    An array of Amazon Cognito user pools and their client IDs.

    *)
  4. open_id_connect_provider_ar_ns : string list option;
    (*

    The Amazon Resource Names (ARN) of the OpenID Connect providers.

    *)
  5. developer_provider_name : string option;
    (*

    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.

    *)
  6. supported_login_providers : identity_providers option;
    (*

    Optional key:value pairs mapping provider names to provider app IDs.

    *)
  7. allow_classic_flow : bool option;
    (*

    Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

    *)
  8. allow_unauthenticated_identities : bool;
    (*

    TRUE if the identity pool supports unauthenticated logins.

    *)
  9. identity_pool_name : string;
    (*

    A string that you provide.

    *)
}

Input to the CreateIdentityPool action.

Builders

val make_cognito_identity_provider : ?server_side_token_check:bool -> ?client_id:string -> ?provider_name:string -> unit -> cognito_identity_provider
val make_identity_pool : ?identity_pool_tags:identity_pool_tags_type -> ?saml_provider_ar_ns:string list -> ?cognito_identity_providers:cognito_identity_provider list -> ?open_id_connect_provider_ar_ns:string list -> ?developer_provider_name:string -> ?supported_login_providers:identity_providers -> ?allow_classic_flow:bool -> allow_unauthenticated_identities:bool -> identity_pool_name:string -> identity_pool_id:string -> unit -> identity_pool
val make_untag_resource_response : unit -> unit
val make_untag_resource_input : tag_keys:string list -> resource_arn:string -> unit -> untag_resource_input
val make_unprocessed_identity_id : ?error_code:error_code -> ?identity_id:string -> unit -> unprocessed_identity_id
val make_tag_resource_response : unit -> unit
val make_tag_resource_input : tags:identity_pool_tags_type -> resource_arn:string -> unit -> tag_resource_input
val make_set_principal_tag_attribute_map_response : ?principal_tags:principal_tags -> ?use_defaults:bool -> ?identity_provider_name:string -> ?identity_pool_id:string -> unit -> set_principal_tag_attribute_map_response
val make_set_principal_tag_attribute_map_input : ?principal_tags:principal_tags -> ?use_defaults:bool -> identity_provider_name:string -> identity_pool_id:string -> unit -> set_principal_tag_attribute_map_input
val make_mapping_rule : role_ar_n:string -> value:string -> match_type:mapping_rule_match_type -> claim:string -> unit -> mapping_rule
val make_rules_configuration_type : rules:mapping_rule list -> unit -> rules_configuration_type
val make_role_mapping : ?rules_configuration:rules_configuration_type -> ?ambiguous_role_resolution:ambiguous_role_resolution_type -> type_:role_mapping_type -> unit -> role_mapping
val make_set_identity_pool_roles_input : ?role_mappings:role_mapping_map -> roles:roles_map -> identity_pool_id:string -> unit -> set_identity_pool_roles_input
val make_merge_developer_identities_response : ?identity_id:string -> unit -> merge_developer_identities_response
val make_merge_developer_identities_input : identity_pool_id:string -> developer_provider_name:string -> destination_user_identifier:string -> source_user_identifier:string -> unit -> merge_developer_identities_input
val make_lookup_developer_identity_response : ?next_token:string -> ?developer_user_identifier_list:string list -> ?identity_id:string -> unit -> lookup_developer_identity_response
val make_lookup_developer_identity_input : ?next_token:string -> ?max_results:int -> ?developer_user_identifier:string -> ?identity_id:string -> identity_pool_id:string -> unit -> lookup_developer_identity_input
val make_list_tags_for_resource_response : ?tags:identity_pool_tags_type -> unit -> list_tags_for_resource_response
val make_list_tags_for_resource_input : resource_arn:string -> unit -> list_tags_for_resource_input
val make_identity_pool_short_description : ?identity_pool_name:string -> ?identity_pool_id:string -> unit -> identity_pool_short_description
val make_list_identity_pools_response : ?next_token:string -> ?identity_pools:identity_pool_short_description list -> unit -> list_identity_pools_response
val make_list_identity_pools_input : ?next_token:string -> max_results:int -> unit -> list_identity_pools_input
val make_identity_description : ?last_modified_date:Smaws_Lib.CoreTypes.Timestamp.t -> ?creation_date:Smaws_Lib.CoreTypes.Timestamp.t -> ?logins:string list -> ?identity_id:string -> unit -> identity_description
val make_list_identities_response : ?next_token:string -> ?identities:identity_description list -> ?identity_pool_id:string -> unit -> list_identities_response
val make_list_identities_input : ?hide_disabled:bool -> ?next_token:string -> max_results:int -> identity_pool_id:string -> unit -> list_identities_input
val make_get_principal_tag_attribute_map_response : ?principal_tags:principal_tags -> ?use_defaults:bool -> ?identity_provider_name:string -> ?identity_pool_id:string -> unit -> get_principal_tag_attribute_map_response
val make_get_principal_tag_attribute_map_input : identity_provider_name:string -> identity_pool_id:string -> unit -> get_principal_tag_attribute_map_input
val make_get_open_id_token_response : ?token:string -> ?identity_id:string -> unit -> get_open_id_token_response
val make_get_open_id_token_input : ?logins:logins_map -> identity_id:string -> unit -> get_open_id_token_input
val make_get_open_id_token_for_developer_identity_response : ?token:string -> ?identity_id:string -> unit -> get_open_id_token_for_developer_identity_response
val make_get_open_id_token_for_developer_identity_input : ?token_duration:int -> ?principal_tags:principal_tags -> ?identity_id:string -> logins:logins_map -> identity_pool_id:string -> unit -> get_open_id_token_for_developer_identity_input
val make_get_identity_pool_roles_response : ?role_mappings:role_mapping_map -> ?roles:roles_map -> ?identity_pool_id:string -> unit -> get_identity_pool_roles_response
val make_get_identity_pool_roles_input : identity_pool_id:string -> unit -> get_identity_pool_roles_input
val make_get_id_response : ?identity_id:string -> unit -> get_id_response
val make_get_id_input : ?logins:logins_map -> ?account_id:string -> identity_pool_id:string -> unit -> get_id_input
val make_credentials : ?expiration:Smaws_Lib.CoreTypes.Timestamp.t -> ?session_token:string -> ?secret_key:string -> ?access_key_id:string -> unit -> credentials
val make_get_credentials_for_identity_response : ?credentials:credentials -> ?identity_id:string -> unit -> get_credentials_for_identity_response
val make_get_credentials_for_identity_input : ?custom_role_arn:string -> ?logins:logins_map -> identity_id:string -> unit -> get_credentials_for_identity_input
val make_describe_identity_pool_input : identity_pool_id:string -> unit -> describe_identity_pool_input
val make_describe_identity_input : identity_id:string -> unit -> describe_identity_input
val make_delete_identity_pool_input : identity_pool_id:string -> unit -> delete_identity_pool_input
val make_delete_identities_response : ?unprocessed_identity_ids:unprocessed_identity_id list -> unit -> delete_identities_response
val make_delete_identities_input : identity_ids_to_delete:string list -> unit -> delete_identities_input
val make_create_identity_pool_input : ?identity_pool_tags:identity_pool_tags_type -> ?saml_provider_ar_ns:string list -> ?cognito_identity_providers:cognito_identity_provider list -> ?open_id_connect_provider_ar_ns:string list -> ?developer_provider_name:string -> ?supported_login_providers:identity_providers -> ?allow_classic_flow:bool -> allow_unauthenticated_identities:bool -> identity_pool_name:string -> unit -> create_identity_pool_input

Operations

module CreateIdentityPool : sig ... end

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The keys for SupportedLoginProviders are as follows:

module DeleteIdentities : sig ... end

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

module DeleteIdentityPool : sig ... end

Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.

module DescribeIdentity : sig ... end

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

module DescribeIdentityPool : sig ... end

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

module GetCredentialsForIdentity : sig ... end

Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

module GetId : sig ... end

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

module GetIdentityPoolRoles : sig ... end

Gets the roles for an identity pool.

module GetOpenIdToken : sig ... end

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.

module GetPrincipalTagAttributeMap : sig ... end

Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.

module ListIdentities : sig ... end

Lists the identities in an identity pool.

module ListIdentityPools : sig ... end

Lists all of the Cognito identity pools registered for your account.

module ListTagsForResource : sig ... end

Lists the tags that are assigned to an Amazon Cognito identity pool.

module LookupDeveloperIdentity : sig ... end

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.

module MergeDeveloperIdentities : sig ... end

Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

module SetIdentityPoolRoles : sig ... end

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

module SetPrincipalTagAttributeMap : sig ... end

You can use this operation to use default (username and clientID) attribute or custom attribute mappings.

module TagResource : sig ... end

Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.

module UnlinkDeveloperIdentity : sig ... end

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

module UnlinkIdentity : sig ... end

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

module UntagResource : sig ... end

Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account

module UpdateIdentityPool : sig ... end

Updates an identity pool.