CognitoIdentityProvider#
Client#
- class CognitoIdentityProvider.Client#
A low-level client representing Amazon Cognito Identity Provider
Using the Amazon Cognito user pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito user pools.
For more information, see the Amazon Cognito Documentation.
client = session.create_client('cognito-idp')
These are the available methods:
- add_custom_attributes
- admin_add_user_to_group
- admin_confirm_sign_up
- admin_create_user
- admin_delete_user
- admin_delete_user_attributes
- admin_disable_provider_for_user
- admin_disable_user
- admin_enable_user
- admin_forget_device
- admin_get_device
- admin_get_user
- admin_initiate_auth
- admin_link_provider_for_user
- admin_list_devices
- admin_list_groups_for_user
- admin_list_user_auth_events
- admin_remove_user_from_group
- admin_reset_user_password
- admin_respond_to_auth_challenge
- admin_set_user_mfa_preference
- admin_set_user_password
- admin_set_user_settings
- admin_update_auth_event_feedback
- admin_update_device_status
- admin_update_user_attributes
- admin_user_global_sign_out
- associate_software_token
- can_paginate
- change_password
- close
- confirm_device
- confirm_forgot_password
- confirm_sign_up
- create_group
- create_identity_provider
- create_resource_server
- create_user_import_job
- create_user_pool
- create_user_pool_client
- create_user_pool_domain
- delete_group
- delete_identity_provider
- delete_resource_server
- delete_user
- delete_user_attributes
- delete_user_pool
- delete_user_pool_client
- delete_user_pool_domain
- describe_identity_provider
- describe_resource_server
- describe_risk_configuration
- describe_user_import_job
- describe_user_pool
- describe_user_pool_client
- describe_user_pool_domain
- forget_device
- forgot_password
- get_csv_header
- get_device
- get_group
- get_identity_provider_by_identifier
- get_paginator
- get_signing_certificate
- get_ui_customization
- get_user
- get_user_attribute_verification_code
- get_user_pool_mfa_config
- get_waiter
- global_sign_out
- initiate_auth
- list_devices
- list_groups
- list_identity_providers
- list_resource_servers
- list_tags_for_resource
- list_user_import_jobs
- list_user_pool_clients
- list_user_pools
- list_users
- list_users_in_group
- resend_confirmation_code
- respond_to_auth_challenge
- revoke_token
- set_risk_configuration
- set_ui_customization
- set_user_mfa_preference
- set_user_pool_mfa_config
- set_user_settings
- sign_up
- start_user_import_job
- stop_user_import_job
- tag_resource
- untag_resource
- update_auth_event_feedback
- update_device_status
- update_group
- update_identity_provider
- update_resource_server
- update_user_attributes
- update_user_pool
- update_user_pool_client
- update_user_pool_domain
- verify_software_token
- verify_user_attribute
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
- AliasExistsException
- CodeDeliveryFailureException
- CodeMismatchException
- ConcurrentModificationException
- DuplicateProviderException
- EnableSoftwareTokenMFAException
- ExpiredCodeException
- ForbiddenException
- GroupExistsException
- InternalErrorException
- InvalidEmailRoleAccessPolicyException
- InvalidLambdaResponseException
- InvalidOAuthFlowException
- InvalidParameterException
- InvalidPasswordException
- InvalidSmsRoleAccessPolicyException
- InvalidSmsRoleTrustRelationshipException
- InvalidUserPoolConfigurationException
- LimitExceededException
- MFAMethodNotFoundException
- NotAuthorizedException
- PasswordResetRequiredException
- PreconditionNotMetException
- ResourceNotFoundException
- ScopeDoesNotExistException
- SoftwareTokenMFANotFoundException
- TooManyFailedAttemptsException
- TooManyRequestsException
- UnauthorizedException
- UnexpectedLambdaException
- UnsupportedIdentityProviderException
- UnsupportedOperationException
- UnsupportedTokenTypeException
- UnsupportedUserStateException
- UserImportInProgressException
- UserLambdaValidationException
- UserNotConfirmedException
- UserNotFoundException
- UserPoolAddOnNotEnabledException
- UserPoolTaggingException
- UsernameExistsException
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: