Smaws_Client_CognitoIdentity (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_cognito_identity_provider : 
  ?server_side_token_check:Types.cognito_identity_provider_token_check ->
  ?client_id:Types.cognito_identity_provider_client_id ->
  ?provider_name:Types.cognito_identity_provider_name ->
  unit ->
  Types.cognito_identity_provider

val make_identity_pool : 
  ?identity_pool_tags:Types.identity_pool_tags_type ->
  ?saml_provider_ar_ns:Types.saml_provider_list ->
  ?cognito_identity_providers:Types.cognito_identity_provider_list ->
  ?open_id_connect_provider_ar_ns:Types.oidc_provider_list ->
  ?developer_provider_name:Types.developer_provider_name ->
  ?supported_login_providers:Types.identity_providers ->
  ?allow_classic_flow:Types.classic_flow ->
  allow_unauthenticated_identities:Types.identity_pool_unauthenticated ->
  identity_pool_name:Types.identity_pool_name ->
  identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.identity_pool

val make_untag_resource_response : unit -> unit

val make_untag_resource_input : 
  tag_keys:Types.identity_pool_tags_list_type ->
  resource_arn:Types.arn_string ->
  unit ->
  Types.untag_resource_input

val make_unprocessed_identity_id : 
  ?error_code:Types.error_code ->
  ?identity_id:Types.identity_id ->
  unit ->
  Types.unprocessed_identity_id

val make_unlink_identity_input : 
  logins_to_remove:Types.logins_list ->
  logins:Types.logins_map ->
  identity_id:Types.identity_id ->
  unit ->
  Types.unlink_identity_input

val make_unlink_developer_identity_input : 
  developer_user_identifier:Types.developer_user_identifier ->
  developer_provider_name:Types.developer_provider_name ->
  identity_pool_id:Types.identity_pool_id ->
  identity_id:Types.identity_id ->
  unit ->
  Types.unlink_developer_identity_input

val make_tag_resource_response : unit -> unit

val make_tag_resource_input : 
  tags:Types.identity_pool_tags_type ->
  resource_arn:Types.arn_string ->
  unit ->
  Types.tag_resource_input

val make_set_principal_tag_attribute_map_response : 
  ?principal_tags:Types.principal_tags ->
  ?use_defaults:Types.use_defaults ->
  ?identity_provider_name:Types.identity_provider_name ->
  ?identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.set_principal_tag_attribute_map_response

val make_set_principal_tag_attribute_map_input : 
  ?principal_tags:Types.principal_tags ->
  ?use_defaults:Types.use_defaults ->
  identity_provider_name:Types.identity_provider_name ->
  identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.set_principal_tag_attribute_map_input

val make_mapping_rule : 
  role_ar_n:Types.arn_string ->
  value:Types.claim_value ->
  match_type:Types.mapping_rule_match_type ->
  claim:Types.claim_name ->
  unit ->
  Types.mapping_rule

val make_rules_configuration_type : 
  rules:Types.mapping_rules_list ->
  unit ->
  Types.rules_configuration_type

val make_role_mapping : 
  ?rules_configuration:Types.rules_configuration_type ->
  ?ambiguous_role_resolution:Types.ambiguous_role_resolution_type ->
  type_:Types.role_mapping_type ->
  unit ->
  Types.role_mapping

val make_set_identity_pool_roles_input : 
  ?role_mappings:Types.role_mapping_map ->
  roles:Types.roles_map ->
  identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.set_identity_pool_roles_input

val make_merge_developer_identities_response : 
  ?identity_id:Types.identity_id ->
  unit ->
  Types.merge_developer_identities_response

val make_merge_developer_identities_input : 
  identity_pool_id:Types.identity_pool_id ->
  developer_provider_name:Types.developer_provider_name ->
  destination_user_identifier:Types.developer_user_identifier ->
  source_user_identifier:Types.developer_user_identifier ->
  unit ->
  Types.merge_developer_identities_input

val make_lookup_developer_identity_response : 
  ?next_token:Types.pagination_key ->
  ?developer_user_identifier_list:Types.developer_user_identifier_list ->
  ?identity_id:Types.identity_id ->
  unit ->
  Types.lookup_developer_identity_response

val make_lookup_developer_identity_input : 
  ?next_token:Types.pagination_key ->
  ?max_results:Types.query_limit ->
  ?developer_user_identifier:Types.developer_user_identifier ->
  ?identity_id:Types.identity_id ->
  identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.lookup_developer_identity_input

val make_list_tags_for_resource_response : 
  ?tags:Types.identity_pool_tags_type ->
  unit ->
  Types.list_tags_for_resource_response

val make_list_tags_for_resource_input : 
  resource_arn:Types.arn_string ->
  unit ->
  Types.list_tags_for_resource_input

val make_identity_pool_short_description : 
  ?identity_pool_name:Types.identity_pool_name ->
  ?identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.identity_pool_short_description

val make_list_identity_pools_response : 
  ?next_token:Types.pagination_key ->
  ?identity_pools:Types.identity_pools_list ->
  unit ->
  Types.list_identity_pools_response

val make_list_identity_pools_input : 
  ?next_token:Types.pagination_key ->
  max_results:Types.query_limit ->
  unit ->
  Types.list_identity_pools_input

val make_identity_description : 
  ?last_modified_date:Types.date_type ->
  ?creation_date:Types.date_type ->
  ?logins:Types.logins_list ->
  ?identity_id:Types.identity_id ->
  unit ->
  Types.identity_description

val make_list_identities_response : 
  ?next_token:Types.pagination_key ->
  ?identities:Types.identities_list ->
  ?identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.list_identities_response

val make_list_identities_input : 
  ?hide_disabled:Types.hide_disabled ->
  ?next_token:Types.pagination_key ->
  max_results:Types.query_limit ->
  identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.list_identities_input

val make_get_principal_tag_attribute_map_response : 
  ?principal_tags:Types.principal_tags ->
  ?use_defaults:Types.use_defaults ->
  ?identity_provider_name:Types.identity_provider_name ->
  ?identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.get_principal_tag_attribute_map_response

val make_get_principal_tag_attribute_map_input : 
  identity_provider_name:Types.identity_provider_name ->
  identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.get_principal_tag_attribute_map_input

val make_get_open_id_token_response : 
  ?token:Types.oidc_token ->
  ?identity_id:Types.identity_id ->
  unit ->
  Types.get_open_id_token_response

val make_get_open_id_token_input : 
  ?logins:Types.logins_map ->
  identity_id:Types.identity_id ->
  unit ->
  Types.get_open_id_token_input

val make_get_open_id_token_for_developer_identity_response : 
  ?token:Types.oidc_token ->
  ?identity_id:Types.identity_id ->
  unit ->
  Types.get_open_id_token_for_developer_identity_response

val make_get_open_id_token_for_developer_identity_input : 
  ?token_duration:Types.token_duration ->
  ?principal_tags:Types.principal_tags ->
  ?identity_id:Types.identity_id ->
  logins:Types.logins_map ->
  identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.get_open_id_token_for_developer_identity_input

val make_get_identity_pool_roles_response : 
  ?role_mappings:Types.role_mapping_map ->
  ?roles:Types.roles_map ->
  ?identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.get_identity_pool_roles_response

val make_get_identity_pool_roles_input : 
  identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.get_identity_pool_roles_input

val make_get_id_response : 
  ?identity_id:Types.identity_id ->
  unit ->
  Types.get_id_response

val make_get_id_input : 
  ?logins:Types.logins_map ->
  ?account_id:Types.account_id ->
  identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.get_id_input

val make_credentials : 
  ?expiration:Types.date_type ->
  ?session_token:Types.session_token_string ->
  ?secret_key:Types.secret_key_string ->
  ?access_key_id:Types.access_key_string ->
  unit ->
  Types.credentials

val make_get_credentials_for_identity_response : 
  ?credentials:Types.credentials ->
  ?identity_id:Types.identity_id ->
  unit ->
  Types.get_credentials_for_identity_response

val make_get_credentials_for_identity_input : 
  ?custom_role_arn:Types.arn_string ->
  ?logins:Types.logins_map ->
  identity_id:Types.identity_id ->
  unit ->
  Types.get_credentials_for_identity_input

val make_describe_identity_pool_input : 
  identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.describe_identity_pool_input

val make_describe_identity_input : 
  identity_id:Types.identity_id ->
  unit ->
  Types.describe_identity_input

val make_delete_identity_pool_input : 
  identity_pool_id:Types.identity_pool_id ->
  unit ->
  Types.delete_identity_pool_input

val make_delete_identities_response : 
  ?unprocessed_identity_ids:Types.unprocessed_identity_id_list ->
  unit ->
  Types.delete_identities_response

val make_delete_identities_input : 
  identity_ids_to_delete:Types.identity_id_list ->
  unit ->
  Types.delete_identities_input

val make_create_identity_pool_input : 
  ?identity_pool_tags:Types.identity_pool_tags_type ->
  ?saml_provider_ar_ns:Types.saml_provider_list ->
  ?cognito_identity_providers:Types.cognito_identity_provider_list ->
  ?open_id_connect_provider_ar_ns:Types.oidc_provider_list ->
  ?developer_provider_name:Types.developer_provider_name ->
  ?supported_login_providers:Types.identity_providers ->
  ?allow_classic_flow:Types.classic_flow ->
  allow_unauthenticated_identities:Types.identity_pool_unauthenticated ->
  identity_pool_name:Types.identity_pool_name ->
  unit ->
  Types.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 Amazon Web Services 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 Security Token Service with the appropriate role for the token.

module GetId : sig ... end

Generates (or retrieves) IdentityID. 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.

module GetOpenIdTokenForDeveloperIdentity : sig ... end

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 the configuration of an identity pool.

module Json_serializers : sig ... end

module Json_deserializers : sig ... end