Module erlcloud_cognito_user_pools

Function Index

admin_add_user_to_group/3
admin_add_user_to_group/4
admin_confirm_signup/2
admin_confirm_signup/3
admin_confirm_signup/4
admin_create_user/2
admin_create_user/3
admin_create_user/4
admin_delete_user/2
admin_delete_user/3
admin_forget_device/3
admin_forget_device/4
admin_get_user/2
admin_get_user/3
admin_initiate_auth/4
admin_initiate_auth/5
admin_initiate_auth/8
admin_list_all_devices/2
admin_list_all_devices/3
admin_list_devices/2
admin_list_devices/3
admin_list_devices/5
admin_list_groups_for_user/2
admin_list_groups_for_user/3
admin_list_groups_for_user/4
admin_list_groups_for_user/5
admin_remove_user_from_group/3
admin_remove_user_from_group/4
admin_reset_user_password/2
admin_reset_user_password/3
admin_reset_user_password/4
admin_set_user_password/3
admin_set_user_password/4
admin_set_user_password/5
admin_update_user_attributes/3
admin_update_user_attributes/4
admin_update_user_attributes/5
change_password/3
change_password/4
configure/2
configure/3
create_group/2
create_group/3
create_group/5
create_group/6
create_identity_provider/4
create_identity_provider/5
create_identity_provider/6
create_identity_provider/7
delete_group/2
delete_group/3
delete_identity_provider/2
delete_identity_provider/3
describe_identity_provider/2
describe_identity_provider/3
describe_user_pool/1
describe_user_pool/2
describe_user_pool_client/2
describe_user_pool_client/3
get_user_pool_mfa_config/1
get_user_pool_mfa_config/2
list_all_identity_providers/1
list_all_identity_providers/2
list_all_user_pool_clients/1
list_all_user_pool_clients/2
list_all_user_pools/0
list_all_user_pools/1
list_all_users/1
list_all_users/2
list_all_users/3
list_identity_providers/1
list_identity_providers/3
list_identity_providers/4
list_user_pool_clients/1
list_user_pool_clients/3
list_user_pool_clients/4
list_user_pools/0
list_user_pools/1
list_user_pools/2
list_users/1
list_users/2
list_users/5
list_users/6
new/2
new/3
request/2
request/3
respond_to_auth_challenge/4
respond_to_auth_challenge/5
respond_to_auth_challenge/8
update_identity_provider/2
update_identity_provider/3
update_identity_provider/4
update_identity_provider/5
update_identity_provider/6

Function Details

admin_add_user_to_group/3

admin_add_user_to_group(GroupName::binary(), UserName::binary(), UserPoolId::binary()) -> ok | {error, any()}

admin_add_user_to_group/4

admin_add_user_to_group(GroupName::binary(), UserName::binary(), UserPoolId::binary(), Config::aws_config()) -> ok | {error, any()}

admin_confirm_signup/2

admin_confirm_signup(UserPoolId::binary(), Username::binary()) -> {ok, map()} | {error, any()}

admin_confirm_signup/3

admin_confirm_signup(UserPoolId::binary(), Username::binary(), ClientMetadata::maps:map()) -> {ok, map()} | {error, any()}

admin_confirm_signup/4

admin_confirm_signup(UserPoolId::binary(), Username::binary(), ClientMetadata::maps:map(), Config::aws_config()) -> {ok, map()} | {error, any()}

admin_create_user/2

admin_create_user(UserName::binary(), UserPoolId::binary()) -> {ok, map()} | {error, any()}

admin_create_user/3

admin_create_user(UserName::binary(), UserPoolId::binary(), OptionalArgs::maps:maps()) -> {ok, map()} | {error, any()}

admin_create_user/4

admin_create_user(UserName::binary(), UserPoolId::binary(), OptionalArgs::maps:maps(), Config::aws_config()) -> {ok, map()} | {error, any()}

admin_delete_user/2

admin_delete_user(UserName::binary(), UserPoolId::binary()) -> ok | {error, any()}

admin_delete_user/3

admin_delete_user(UserName::binary(), UserPoolId::binary(), Config::aws_config()) -> ok | {error, any()}

admin_forget_device/3

admin_forget_device(UserPoolId::binary(), Username::binary(), DeviceKey::binary()) -> ok | {error, any()}

admin_forget_device/4

admin_forget_device(UserPoolId::binary(), Username::binary(), DeviceKey::binary(), Config::aws_config()) -> ok | {error, any()}

admin_get_user/2

admin_get_user(UserName::binary(), UserPoolId::binary()) -> {ok, map()} | {error, any()}

admin_get_user/3

admin_get_user(UserName::binary(), UserPoolId::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

admin_initiate_auth/4

admin_initiate_auth(PoolId::binary(), ClientId::binary(), AuthFlow::binary(), AuthParams::maps:map()) -> {ok, map()} | {error, any()}

admin_initiate_auth/5

admin_initiate_auth(PoolId::binary(), ClientId::binary(), AuthFlow::binary(), AuthParams::maps:map(), Cfg::aws_config()) -> {ok, map()} | {error, any()}

admin_initiate_auth/8

admin_initiate_auth(PoolId::binary(), ClientId::binary(), AuthFlow::binary(), AuthParams::maps:map(), AnalyticsMeta::maps:map(), ClientMeta::maps:map(), ContextData::maps:map(), Cfg::aws_config()) -> {ok, map()} | {error, any()}

admin_list_all_devices/2

admin_list_all_devices(UserPoolId::binary(), Username::binary()) -> {ok, map()} | {error, any()}

admin_list_all_devices/3

admin_list_all_devices(UserPoolId::binary(), Username::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

admin_list_devices/2

admin_list_devices(UserPoolId::binary(), Username::binary()) -> {ok, map()} | {error, any()}

admin_list_devices/3

admin_list_devices(UserPoolId::binary(), Username::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

admin_list_devices/5

admin_list_devices(UserPoolId::binary(), Username::binary(), Limit::integer(), PaginationToken::binary() | undefined, Config::aws_config()) -> {ok, map()} | {error, any()}

admin_list_groups_for_user/2

admin_list_groups_for_user(UserName::binary(), UserPoolId::binary()) -> {ok, map()} | {error, any()}

admin_list_groups_for_user/3

admin_list_groups_for_user(UserName::binary(), UserPoolId::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

admin_list_groups_for_user/4

admin_list_groups_for_user(UserName::binary(), UserPoolId::binary(), Limit::number(), NextToken::binary() | undefined) -> {ok, map()} | {error, any()}

admin_list_groups_for_user/5

admin_list_groups_for_user(UserName::binary(), UserPoolId::binary(), Limit::number(), NextToken::binary() | undefined, Config::aws_config()) -> {ok, map()} | {error, any()}

admin_remove_user_from_group/3

admin_remove_user_from_group(GroupName::binary(), UserName::binary(), UserPoolId::binary()) -> ok | {error, any()}

admin_remove_user_from_group/4

admin_remove_user_from_group(GroupName::binary(), UserName::binary(), UserPoolId::binary(), Config::aws_config()) -> ok | {error, any()}

admin_reset_user_password/2

admin_reset_user_password(UserName::binary(), UserPoolId::binary()) -> ok | {error, any()}

admin_reset_user_password/3

admin_reset_user_password(UserName::binary(), UserPoolId::binary(), MetaData::map() | undefined) -> ok | {error, any()}

admin_reset_user_password/4

admin_reset_user_password(UserName::binary(), UserPoolId::binary(), MetaData::map() | undefined, Config::aws_config()) -> ok | {error, any()}

admin_set_user_password/3

admin_set_user_password(UserId::binary(), UserPoolId::binary(), Password::binary()) -> {ok, map()} | {error, any()}

admin_set_user_password/4

admin_set_user_password(UserId::binary(), UserPoolId::binary(), Password::binary(), Permanent::boolean()) -> ok | {error, any()}

admin_set_user_password/5

admin_set_user_password(UserId::binary(), UserPoolId::binary(), Password::binary(), Permanent::boolean(), Config::aws_config()) -> ok | {error, any()}

admin_update_user_attributes/3

admin_update_user_attributes(UserName::binary(), UserPoolId::binary(), Attributes::[map()]) -> ok | {error, any()}

admin_update_user_attributes/4

admin_update_user_attributes(UserName::binary(), UserPoolId::binary(), Attributes::[map()], MetaData::map() | undefined) -> ok | {error, any()}

admin_update_user_attributes/5

admin_update_user_attributes(UserName::binary(), UserPoolId::binary(), Attributes::[map()], MetaData::map() | undefined, Config::aws_config()) -> ok | {error, any()}

change_password/3

change_password(OldPass::binary(), NewPass::binary(), AccessToken::binary()) -> ok | {error, any()}

change_password/4

change_password(OldPass::binary(), NewPass::binary(), AccessToken::binary(), Config::aws_config()) -> ok | {error, any()}

configure/2

configure(AccessKeyID::string(), SecretAccessKey::string()) -> ok

configure/3

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> ok

create_group/2

create_group(GroupName::binary(), UserPoolId::binary()) -> {ok, map()} | {error, any()}

create_group/3

create_group(GroupName::binary(), UserPoolId::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

create_group/5

create_group(GroupName::binary(), UserPoolId::binary(), Description::binary() | undefined, Precedence::number() | undefined, RoleArn::binary() | undefined) -> {ok, map()} | {error, any()}

create_group/6

create_group(GroupName::binary(), UserPoolId::binary(), Description::binary() | undefined, Precedence::number() | undefined, RoleArn::binary() | undefined, Config::aws_config()) -> {ok, map()} | {error, any()}

create_identity_provider/4

create_identity_provider(UserPoolId::binary(), ProviderName::binary(), ProviderType::binary(), ProviderDetails::map()) -> {ok, map()} | {error, any()}

create_identity_provider/5

create_identity_provider(UserPoolId::binary(), ProviderName::binary(), ProviderType::binary(), ProviderDetails::map(), AttributeMapping::map()) -> {ok, map()} | {error, any()}

create_identity_provider/6

create_identity_provider(UserPoolId::binary(), ProviderName::binary(), ProviderType::binary(), ProviderDetails::map(), AttributeMapping::map(), IdpIdentifiers::list()) -> {ok, map()} | {error, any()}

create_identity_provider/7

create_identity_provider(UserPoolId::binary(), ProviderName::binary(), ProviderType::binary(), ProviderDetails::map(), AttributeMapping::map(), IdpIdentifiers::list(), Config::aws_config()) -> {ok, map()} | {error, any()}

delete_group/2

delete_group(GroupName::binary(), UserPoolId::binary()) -> ok | {error, any()}

delete_group/3

delete_group(GroupName::binary(), UserPoolId::binary(), Config::aws_config()) -> ok | {error, any()}

delete_identity_provider/2

delete_identity_provider(UserPoolId::binary(), ProviderName::binary()) -> ok | {error, any()}

delete_identity_provider/3

delete_identity_provider(UserPoolId::binary(), ProviderName::binary(), Config::aws_config()) -> ok | {error, any()}

describe_identity_provider/2

describe_identity_provider(UserPoolId::binary(), ProviderName::binary()) -> {ok, map()} | {error, any()}

describe_identity_provider/3

describe_identity_provider(UserPoolId::binary(), ProviderName::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

describe_user_pool/1

describe_user_pool(UserPoolId::binary()) -> {ok, map()} | {error, any()}

describe_user_pool/2

describe_user_pool(UserPoolId::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

describe_user_pool_client/2

describe_user_pool_client(UserPoolId::binary(), ClientId::binary()) -> {ok, map()} | {error, any()}

describe_user_pool_client/3

describe_user_pool_client(UserPoolId, ClientId, Config) -> any()

get_user_pool_mfa_config/1

get_user_pool_mfa_config(UserPoolId::binary()) -> {ok, map()} | {error, any()}

get_user_pool_mfa_config/2

get_user_pool_mfa_config(UserPoolId::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

list_all_identity_providers/1

list_all_identity_providers(UserPoolId::binary()) -> {ok, map()} | {error, any()}

list_all_identity_providers/2

list_all_identity_providers(UserPoolId::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

list_all_user_pool_clients/1

list_all_user_pool_clients(UserPoolId::binary()) -> {ok, map()} | {error, any()}

list_all_user_pool_clients/2

list_all_user_pool_clients(UserPoolId::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

list_all_user_pools/0

list_all_user_pools() -> {ok, map()} | {error, any()}

list_all_user_pools/1

list_all_user_pools(Config::aws_config()) -> {ok, map()} | {error, any()}

list_all_users/1

list_all_users(UserPoolId::binary()) -> {ok, map()} | {error, any()}

list_all_users/2

list_all_users(UserPoolId::binary(), Config::binary() | undefined | aws_config()) -> {ok, map()} | {error, any()}

list_all_users/3

list_all_users(UserPoolId::binary(), Filter::binary() | undefined, Config::aws_config()) -> {ok, map()} | {error, any()}

list_identity_providers/1

list_identity_providers(UserPoolId::binary()) -> {ok, map()} | {error, any()}

list_identity_providers/3

list_identity_providers(UserPoolId::binary(), MaxResults::integer(), NextToken::binary() | undefined) -> {ok, map()} | {error, any()}

list_identity_providers/4

list_identity_providers(UserPoolId::binary(), MaxResults::integer(), NextToken::binary() | undefined, Config::aws_config()) -> {ok, map()} | {error, any()}

list_user_pool_clients/1

list_user_pool_clients(UserPoolId::binary()) -> {ok, map()} | {error, any()}

list_user_pool_clients/3

list_user_pool_clients(UserPoolId::binary(), MaxResults::non_neg_integer(), NextToken::binary() | undefined) -> {ok, map()} | {error, any()}

list_user_pool_clients/4

list_user_pool_clients(UserPoolId::binary(), MaxResults::non_neg_integer(), NextToken::binary() | undefined, Config::aws_config()) -> {ok, map()} | {error, any()}

list_user_pools/0

list_user_pools() -> {ok, map()} | {error, any()}

list_user_pools/1

list_user_pools(MaxResult::integer()) -> {ok, map()} | {error, any()}

list_user_pools/2

list_user_pools(MaxResult::integer(), NextToken::binary() | undefined) -> {ok, map()} | {error, any()}

list_users/1

list_users(UserPoolId::binary()) -> {ok, map()} | {error, any()}

list_users/2

list_users(UserPoolId::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

list_users/5

list_users(UserPoolId::binary(), AttributesToGet::[binary()] | undefined, Filter::binary() | undefined, Limit::number() | undefined, PaginationToken::binary() | undefined) -> {ok, map()} | {error, any()}

list_users/6

list_users(UserPoolId, AttributesToGet, Filter, Limit, PaginationToken, Config) -> any()

new/2

new(AccessKeyID::string(), SecretAccessKey::string()) -> aws_config()

new/3

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> aws_config()

request/2

request(Config, Request) -> any()

request/3

request(Config0, OperationName, Request) -> any()

respond_to_auth_challenge/4

respond_to_auth_challenge(ClientId::binary(), ChallengeName::binary(), ChallengeResponses::maps:map(), Session::binary()) -> {ok, map()} | {error, any()}

respond_to_auth_challenge/5

respond_to_auth_challenge(ClientId::binary(), ChallengeName::binary(), ChallengeResponses::maps:map(), Session::binary(), Cfg::aws_config()) -> {ok, map()} | {error, any()}

respond_to_auth_challenge/8

respond_to_auth_challenge(ClientId::binary(), ChallengeName::binary(), ChallengeResponses::maps:map(), Session::binary(), AnalyticsMeta::maps:map(), ClientMeta::maps:map(), ContextData::maps:map(), Cfg::aws_config()) -> {ok, map()} | {error, any()}

update_identity_provider/2

update_identity_provider(UserPoolId::binary(), ProviderName::binary()) -> {ok, map()} | {error, any()}

update_identity_provider/3

update_identity_provider(UserPoolId::binary(), ProviderName::binary(), ProviderDetails::map()) -> {ok, map()} | {error, any()}

update_identity_provider/4

update_identity_provider(UserPoolId::binary(), ProviderName::binary(), ProviderDetails::map(), AttributeMapping::map()) -> {ok, map()} | {error, any()}

update_identity_provider/5

update_identity_provider(UserPoolId::binary(), ProviderName::binary(), ProviderDetails::map(), AttributeMapping::map(), IdpIdentifiers::list()) -> {ok, map()} | {error, any()}

update_identity_provider/6

update_identity_provider(UserPoolId::binary(), ProviderName::binary(), ProviderDetails::map(), AttributeMapping::map(), IdpIdentifiers::list(), Config::aws_config()) -> {ok, map()} | {error, any()}


Generated by EDoc