CognitoIdentityProviderClient#
Index > CognitoIdentityProvider > CognitoIdentityProviderClient
Auto-generated documentation for CognitoIdentityProvider type annotations stubs module mypy-boto3-cognito-idp.
CognitoIdentityProviderClient#
Type annotations and code completion for boto3.client("cognito-idp")
.
boto3 documentation
# CognitoIdentityProviderClient usage example
from boto3.session import Session
from mypy_boto3_cognito_idp.client import CognitoIdentityProviderClient
def get_cognito-idp_client() -> CognitoIdentityProviderClient:
return Session().client("cognito-idp")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("cognito-idp").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("cognito-idp")
try:
do_something(client)
except (
client.exceptions.AliasExistsException,
client.exceptions.ClientError,
client.exceptions.CodeDeliveryFailureException,
client.exceptions.CodeMismatchException,
client.exceptions.ConcurrentModificationException,
client.exceptions.DuplicateProviderException,
client.exceptions.EnableSoftwareTokenMFAException,
client.exceptions.ExpiredCodeException,
client.exceptions.ForbiddenException,
client.exceptions.GroupExistsException,
client.exceptions.InternalErrorException,
client.exceptions.InvalidEmailRoleAccessPolicyException,
client.exceptions.InvalidLambdaResponseException,
client.exceptions.InvalidOAuthFlowException,
client.exceptions.InvalidParameterException,
client.exceptions.InvalidPasswordException,
client.exceptions.InvalidSmsRoleAccessPolicyException,
client.exceptions.InvalidSmsRoleTrustRelationshipException,
client.exceptions.InvalidUserPoolConfigurationException,
client.exceptions.LimitExceededException,
client.exceptions.MFAMethodNotFoundException,
client.exceptions.NotAuthorizedException,
client.exceptions.PasswordResetRequiredException,
client.exceptions.PreconditionNotMetException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ScopeDoesNotExistException,
client.exceptions.SoftwareTokenMFANotFoundException,
client.exceptions.TooManyFailedAttemptsException,
client.exceptions.TooManyRequestsException,
client.exceptions.UnauthorizedException,
client.exceptions.UnexpectedLambdaException,
client.exceptions.UnsupportedIdentityProviderException,
client.exceptions.UnsupportedOperationException,
client.exceptions.UnsupportedTokenTypeException,
client.exceptions.UnsupportedUserStateException,
client.exceptions.UserImportInProgressException,
client.exceptions.UserLambdaValidationException,
client.exceptions.UserNotConfirmedException,
client.exceptions.UserNotFoundException,
client.exceptions.UserPoolAddOnNotEnabledException,
client.exceptions.UserPoolTaggingException,
client.exceptions.UsernameExistsException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_cognito_idp.client import Exceptions
def handle_error(exc: Exceptions.AliasExistsException) -> None:
...
Methods#
add_custom_attributes#
Adds additional user attributes to the user pool schema.
Type annotations and code completion for boto3.client("cognito-idp").add_custom_attributes
method.
boto3 documentation
# add_custom_attributes method definition
def add_custom_attributes(
self,
*,
UserPoolId: str,
CustomAttributes: Sequence[SchemaAttributeTypeTypeDef], # (1)
) -> Dict[str, Any]:
...
# add_custom_attributes method usage example with argument unpacking
kwargs: AddCustomAttributesRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"CustomAttributes": ...,
}
parent.add_custom_attributes(**kwargs)
admin_add_user_to_group#
Adds the specified user to the specified group.
Type annotations and code completion for boto3.client("cognito-idp").admin_add_user_to_group
method.
boto3 documentation
# admin_add_user_to_group method definition
def admin_add_user_to_group(
self,
*,
UserPoolId: str,
Username: str,
GroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# admin_add_user_to_group method usage example with argument unpacking
kwargs: AdminAddUserToGroupRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"GroupName": ...,
}
parent.admin_add_user_to_group(**kwargs)
admin_confirm_sign_up#
Confirms user registration as an admin without using a confirmation code.
Type annotations and code completion for boto3.client("cognito-idp").admin_confirm_sign_up
method.
boto3 documentation
# admin_confirm_sign_up method definition
def admin_confirm_sign_up(
self,
*,
UserPoolId: str,
Username: str,
ClientMetadata: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
# admin_confirm_sign_up method usage example with argument unpacking
kwargs: AdminConfirmSignUpRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_confirm_sign_up(**kwargs)
admin_create_user#
Creates a new user in the specified user pool.
Type annotations and code completion for boto3.client("cognito-idp").admin_create_user
method.
boto3 documentation
# admin_create_user method definition
def admin_create_user(
self,
*,
UserPoolId: str,
Username: str,
UserAttributes: Sequence[AttributeTypeTypeDef] = ..., # (1)
ValidationData: Sequence[AttributeTypeTypeDef] = ..., # (1)
TemporaryPassword: str = ...,
ForceAliasCreation: bool = ...,
MessageAction: MessageActionTypeType = ..., # (3)
DesiredDeliveryMediums: Sequence[DeliveryMediumTypeType] = ..., # (4)
ClientMetadata: Mapping[str, str] = ...,
) -> AdminCreateUserResponseTypeDef: # (5)
...
- See AttributeTypeTypeDef
- See AttributeTypeTypeDef
- See MessageActionTypeType
- See DeliveryMediumTypeType
- See AdminCreateUserResponseTypeDef
# admin_create_user method usage example with argument unpacking
kwargs: AdminCreateUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_create_user(**kwargs)
admin_delete_user#
Deletes a user as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_delete_user
method.
boto3 documentation
# admin_delete_user method definition
def admin_delete_user(
self,
*,
UserPoolId: str,
Username: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# admin_delete_user method usage example with argument unpacking
kwargs: AdminDeleteUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_delete_user(**kwargs)
admin_delete_user_attributes#
Deletes the user attributes in a user pool as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_delete_user_attributes
method.
boto3 documentation
# admin_delete_user_attributes method definition
def admin_delete_user_attributes(
self,
*,
UserPoolId: str,
Username: str,
UserAttributeNames: Sequence[str],
) -> Dict[str, Any]:
...
# admin_delete_user_attributes method usage example with argument unpacking
kwargs: AdminDeleteUserAttributesRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"UserAttributeNames": ...,
}
parent.admin_delete_user_attributes(**kwargs)
admin_disable_provider_for_user#
Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP).
Type annotations and code completion for boto3.client("cognito-idp").admin_disable_provider_for_user
method.
boto3 documentation
# admin_disable_provider_for_user method definition
def admin_disable_provider_for_user(
self,
*,
UserPoolId: str,
User: ProviderUserIdentifierTypeTypeDef, # (1)
) -> Dict[str, Any]:
...
# admin_disable_provider_for_user method usage example with argument unpacking
kwargs: AdminDisableProviderForUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"User": ...,
}
parent.admin_disable_provider_for_user(**kwargs)
admin_disable_user#
Deactivates a user and revokes all access tokens for the user.
Type annotations and code completion for boto3.client("cognito-idp").admin_disable_user
method.
boto3 documentation
# admin_disable_user method definition
def admin_disable_user(
self,
*,
UserPoolId: str,
Username: str,
) -> Dict[str, Any]:
...
# admin_disable_user method usage example with argument unpacking
kwargs: AdminDisableUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_disable_user(**kwargs)
admin_enable_user#
Enables the specified user as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_enable_user
method.
boto3 documentation
# admin_enable_user method definition
def admin_enable_user(
self,
*,
UserPoolId: str,
Username: str,
) -> Dict[str, Any]:
...
# admin_enable_user method usage example with argument unpacking
kwargs: AdminEnableUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_enable_user(**kwargs)
admin_forget_device#
Forgets the device, as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_forget_device
method.
boto3 documentation
# admin_forget_device method definition
def admin_forget_device(
self,
*,
UserPoolId: str,
Username: str,
DeviceKey: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# admin_forget_device method usage example with argument unpacking
kwargs: AdminForgetDeviceRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"DeviceKey": ...,
}
parent.admin_forget_device(**kwargs)
admin_get_device#
Gets the device, as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_get_device
method.
boto3 documentation
# admin_get_device method definition
def admin_get_device(
self,
*,
DeviceKey: str,
UserPoolId: str,
Username: str,
) -> AdminGetDeviceResponseTypeDef: # (1)
...
# admin_get_device method usage example with argument unpacking
kwargs: AdminGetDeviceRequestRequestTypeDef = { # (1)
"DeviceKey": ...,
"UserPoolId": ...,
"Username": ...,
}
parent.admin_get_device(**kwargs)
admin_get_user#
Gets the specified user by user name in a user pool as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_get_user
method.
boto3 documentation
# admin_get_user method definition
def admin_get_user(
self,
*,
UserPoolId: str,
Username: str,
) -> AdminGetUserResponseTypeDef: # (1)
...
# admin_get_user method usage example with argument unpacking
kwargs: AdminGetUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_get_user(**kwargs)
admin_initiate_auth#
Initiates the authentication flow, as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_initiate_auth
method.
boto3 documentation
# admin_initiate_auth method definition
def admin_initiate_auth(
self,
*,
UserPoolId: str,
ClientId: str,
AuthFlow: AuthFlowTypeType, # (1)
AuthParameters: Mapping[str, str] = ...,
ClientMetadata: Mapping[str, str] = ...,
AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ..., # (2)
ContextData: ContextDataTypeTypeDef = ..., # (3)
) -> AdminInitiateAuthResponseTypeDef: # (4)
...
- See AuthFlowTypeType
- See AnalyticsMetadataTypeTypeDef
- See ContextDataTypeTypeDef
- See AdminInitiateAuthResponseTypeDef
# admin_initiate_auth method usage example with argument unpacking
kwargs: AdminInitiateAuthRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ClientId": ...,
"AuthFlow": ...,
}
parent.admin_initiate_auth(**kwargs)
admin_link_provider_for_user#
Links an existing user account in a user pool ( DestinationUser
) to an
identity from an external IdP ( SourceUser
) based on a specified attribute
name and value from the external IdP.
Type annotations and code completion for boto3.client("cognito-idp").admin_link_provider_for_user
method.
boto3 documentation
# admin_link_provider_for_user method definition
def admin_link_provider_for_user(
self,
*,
UserPoolId: str,
DestinationUser: ProviderUserIdentifierTypeTypeDef, # (1)
SourceUser: ProviderUserIdentifierTypeTypeDef, # (1)
) -> Dict[str, Any]:
...
# admin_link_provider_for_user method usage example with argument unpacking
kwargs: AdminLinkProviderForUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"DestinationUser": ...,
"SourceUser": ...,
}
parent.admin_link_provider_for_user(**kwargs)
admin_list_devices#
Lists devices, as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_list_devices
method.
boto3 documentation
# admin_list_devices method definition
def admin_list_devices(
self,
*,
UserPoolId: str,
Username: str,
Limit: int = ...,
PaginationToken: str = ...,
) -> AdminListDevicesResponseTypeDef: # (1)
...
# admin_list_devices method usage example with argument unpacking
kwargs: AdminListDevicesRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_list_devices(**kwargs)
admin_list_groups_for_user#
Lists the groups that the user belongs to.
Type annotations and code completion for boto3.client("cognito-idp").admin_list_groups_for_user
method.
boto3 documentation
# admin_list_groups_for_user method definition
def admin_list_groups_for_user(
self,
*,
Username: str,
UserPoolId: str,
Limit: int = ...,
NextToken: str = ...,
) -> AdminListGroupsForUserResponseTypeDef: # (1)
...
# admin_list_groups_for_user method usage example with argument unpacking
kwargs: AdminListGroupsForUserRequestRequestTypeDef = { # (1)
"Username": ...,
"UserPoolId": ...,
}
parent.admin_list_groups_for_user(**kwargs)
admin_list_user_auth_events#
A history of user activity and any risks detected as part of Amazon Cognito advanced security.
Type annotations and code completion for boto3.client("cognito-idp").admin_list_user_auth_events
method.
boto3 documentation
# admin_list_user_auth_events method definition
def admin_list_user_auth_events(
self,
*,
UserPoolId: str,
Username: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> AdminListUserAuthEventsResponseTypeDef: # (1)
...
# admin_list_user_auth_events method usage example with argument unpacking
kwargs: AdminListUserAuthEventsRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_list_user_auth_events(**kwargs)
admin_remove_user_from_group#
Removes the specified user from the specified group.
Type annotations and code completion for boto3.client("cognito-idp").admin_remove_user_from_group
method.
boto3 documentation
# admin_remove_user_from_group method definition
def admin_remove_user_from_group(
self,
*,
UserPoolId: str,
Username: str,
GroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# admin_remove_user_from_group method usage example with argument unpacking
kwargs: AdminRemoveUserFromGroupRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"GroupName": ...,
}
parent.admin_remove_user_from_group(**kwargs)
admin_reset_user_password#
Resets the specified user's password in a user pool as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_reset_user_password
method.
boto3 documentation
# admin_reset_user_password method definition
def admin_reset_user_password(
self,
*,
UserPoolId: str,
Username: str,
ClientMetadata: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
# admin_reset_user_password method usage example with argument unpacking
kwargs: AdminResetUserPasswordRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_reset_user_password(**kwargs)
admin_respond_to_auth_challenge#
Responds to an authentication challenge, as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_respond_to_auth_challenge
method.
boto3 documentation
# admin_respond_to_auth_challenge method definition
def admin_respond_to_auth_challenge(
self,
*,
UserPoolId: str,
ClientId: str,
ChallengeName: ChallengeNameTypeType, # (1)
ChallengeResponses: Mapping[str, str] = ...,
Session: str = ...,
AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ..., # (2)
ContextData: ContextDataTypeTypeDef = ..., # (3)
ClientMetadata: Mapping[str, str] = ...,
) -> AdminRespondToAuthChallengeResponseTypeDef: # (4)
...
- See ChallengeNameTypeType
- See AnalyticsMetadataTypeTypeDef
- See ContextDataTypeTypeDef
- See AdminRespondToAuthChallengeResponseTypeDef
# admin_respond_to_auth_challenge method usage example with argument unpacking
kwargs: AdminRespondToAuthChallengeRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ClientId": ...,
"ChallengeName": ...,
}
parent.admin_respond_to_auth_challenge(**kwargs)
admin_set_user_mfa_preference#
The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred.
Type annotations and code completion for boto3.client("cognito-idp").admin_set_user_mfa_preference
method.
boto3 documentation
# admin_set_user_mfa_preference method definition
def admin_set_user_mfa_preference(
self,
*,
Username: str,
UserPoolId: str,
SMSMfaSettings: SMSMfaSettingsTypeTypeDef = ..., # (1)
SoftwareTokenMfaSettings: SoftwareTokenMfaSettingsTypeTypeDef = ..., # (2)
) -> Dict[str, Any]:
...
# admin_set_user_mfa_preference method usage example with argument unpacking
kwargs: AdminSetUserMFAPreferenceRequestRequestTypeDef = { # (1)
"Username": ...,
"UserPoolId": ...,
}
parent.admin_set_user_mfa_preference(**kwargs)
admin_set_user_password#
Sets the specified user's password in a user pool as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_set_user_password
method.
boto3 documentation
# admin_set_user_password method definition
def admin_set_user_password(
self,
*,
UserPoolId: str,
Username: str,
Password: str,
Permanent: bool = ...,
) -> Dict[str, Any]:
...
# admin_set_user_password method usage example with argument unpacking
kwargs: AdminSetUserPasswordRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"Password": ...,
}
parent.admin_set_user_password(**kwargs)
admin_set_user_settings#
This action is no longer supported. You can use it to configure only SMS MFA.
Type annotations and code completion for boto3.client("cognito-idp").admin_set_user_settings
method.
boto3 documentation
# admin_set_user_settings method definition
def admin_set_user_settings(
self,
*,
UserPoolId: str,
Username: str,
MFAOptions: Sequence[MFAOptionTypeTypeDef], # (1)
) -> Dict[str, Any]:
...
# admin_set_user_settings method usage example with argument unpacking
kwargs: AdminSetUserSettingsRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"MFAOptions": ...,
}
parent.admin_set_user_settings(**kwargs)
admin_update_auth_event_feedback#
Provides feedback for an authentication event indicating if it was from a valid user.
Type annotations and code completion for boto3.client("cognito-idp").admin_update_auth_event_feedback
method.
boto3 documentation
# admin_update_auth_event_feedback method definition
def admin_update_auth_event_feedback(
self,
*,
UserPoolId: str,
Username: str,
EventId: str,
FeedbackValue: FeedbackValueTypeType, # (1)
) -> Dict[str, Any]:
...
# admin_update_auth_event_feedback method usage example with argument unpacking
kwargs: AdminUpdateAuthEventFeedbackRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"EventId": ...,
"FeedbackValue": ...,
}
parent.admin_update_auth_event_feedback(**kwargs)
admin_update_device_status#
Updates the device status as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_update_device_status
method.
boto3 documentation
# admin_update_device_status method definition
def admin_update_device_status(
self,
*,
UserPoolId: str,
Username: str,
DeviceKey: str,
DeviceRememberedStatus: DeviceRememberedStatusTypeType = ..., # (1)
) -> Dict[str, Any]:
...
# admin_update_device_status method usage example with argument unpacking
kwargs: AdminUpdateDeviceStatusRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"DeviceKey": ...,
}
parent.admin_update_device_status(**kwargs)
admin_update_user_attributes#
Updates the specified user's attributes, including developer attributes, as an administrator.
Type annotations and code completion for boto3.client("cognito-idp").admin_update_user_attributes
method.
boto3 documentation
# admin_update_user_attributes method definition
def admin_update_user_attributes(
self,
*,
UserPoolId: str,
Username: str,
UserAttributes: Sequence[AttributeTypeTypeDef], # (1)
ClientMetadata: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
# admin_update_user_attributes method usage example with argument unpacking
kwargs: AdminUpdateUserAttributesRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"UserAttributes": ...,
}
parent.admin_update_user_attributes(**kwargs)
admin_user_global_sign_out#
Signs out a user from all devices.
Type annotations and code completion for boto3.client("cognito-idp").admin_user_global_sign_out
method.
boto3 documentation
# admin_user_global_sign_out method definition
def admin_user_global_sign_out(
self,
*,
UserPoolId: str,
Username: str,
) -> Dict[str, Any]:
...
# admin_user_global_sign_out method usage example with argument unpacking
kwargs: AdminUserGlobalSignOutRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_user_global_sign_out(**kwargs)
associate_software_token#
Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response.
Type annotations and code completion for boto3.client("cognito-idp").associate_software_token
method.
boto3 documentation
# associate_software_token method definition
def associate_software_token(
self,
*,
AccessToken: str = ...,
Session: str = ...,
) -> AssociateSoftwareTokenResponseTypeDef: # (1)
...
# associate_software_token method usage example with argument unpacking
kwargs: AssociateSoftwareTokenRequestRequestTypeDef = { # (1)
"AccessToken": ...,
}
parent.associate_software_token(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("cognito-idp").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
change_password#
Changes the password for a specified user in a user pool.
Type annotations and code completion for boto3.client("cognito-idp").change_password
method.
boto3 documentation
# change_password method definition
def change_password(
self,
*,
PreviousPassword: str,
ProposedPassword: str,
AccessToken: str,
) -> Dict[str, Any]:
...
# change_password method usage example with argument unpacking
kwargs: ChangePasswordRequestRequestTypeDef = { # (1)
"PreviousPassword": ...,
"ProposedPassword": ...,
"AccessToken": ...,
}
parent.change_password(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("cognito-idp").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
confirm_device#
Confirms tracking of the device.
Type annotations and code completion for boto3.client("cognito-idp").confirm_device
method.
boto3 documentation
# confirm_device method definition
def confirm_device(
self,
*,
AccessToken: str,
DeviceKey: str,
DeviceSecretVerifierConfig: DeviceSecretVerifierConfigTypeTypeDef = ..., # (1)
DeviceName: str = ...,
) -> ConfirmDeviceResponseTypeDef: # (2)
...
# confirm_device method usage example with argument unpacking
kwargs: ConfirmDeviceRequestRequestTypeDef = { # (1)
"AccessToken": ...,
"DeviceKey": ...,
}
parent.confirm_device(**kwargs)
confirm_forgot_password#
Allows a user to enter a confirmation code to reset a forgotten password.
Type annotations and code completion for boto3.client("cognito-idp").confirm_forgot_password
method.
boto3 documentation
# confirm_forgot_password method definition
def confirm_forgot_password(
self,
*,
ClientId: str,
Username: str,
ConfirmationCode: str,
Password: str,
SecretHash: str = ...,
AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ..., # (1)
UserContextData: UserContextDataTypeTypeDef = ..., # (2)
ClientMetadata: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
# confirm_forgot_password method usage example with argument unpacking
kwargs: ConfirmForgotPasswordRequestRequestTypeDef = { # (1)
"ClientId": ...,
"Username": ...,
"ConfirmationCode": ...,
"Password": ...,
}
parent.confirm_forgot_password(**kwargs)
confirm_sign_up#
Confirms registration of a new user.
Type annotations and code completion for boto3.client("cognito-idp").confirm_sign_up
method.
boto3 documentation
# confirm_sign_up method definition
def confirm_sign_up(
self,
*,
ClientId: str,
Username: str,
ConfirmationCode: str,
SecretHash: str = ...,
ForceAliasCreation: bool = ...,
AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ..., # (1)
UserContextData: UserContextDataTypeTypeDef = ..., # (2)
ClientMetadata: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
# confirm_sign_up method usage example with argument unpacking
kwargs: ConfirmSignUpRequestRequestTypeDef = { # (1)
"ClientId": ...,
"Username": ...,
"ConfirmationCode": ...,
}
parent.confirm_sign_up(**kwargs)
create_group#
Creates a new group in the specified user pool.
Type annotations and code completion for boto3.client("cognito-idp").create_group
method.
boto3 documentation
# create_group method definition
def create_group(
self,
*,
GroupName: str,
UserPoolId: str,
Description: str = ...,
RoleArn: str = ...,
Precedence: int = ...,
) -> CreateGroupResponseTypeDef: # (1)
...
# create_group method usage example with argument unpacking
kwargs: CreateGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"UserPoolId": ...,
}
parent.create_group(**kwargs)
create_identity_provider#
Creates an IdP for a user pool.
Type annotations and code completion for boto3.client("cognito-idp").create_identity_provider
method.
boto3 documentation
# create_identity_provider method definition
def create_identity_provider(
self,
*,
UserPoolId: str,
ProviderName: str,
ProviderType: IdentityProviderTypeTypeType, # (1)
ProviderDetails: Mapping[str, str],
AttributeMapping: Mapping[str, str] = ...,
IdpIdentifiers: Sequence[str] = ...,
) -> CreateIdentityProviderResponseTypeDef: # (2)
...
# create_identity_provider method usage example with argument unpacking
kwargs: CreateIdentityProviderRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ProviderName": ...,
"ProviderType": ...,
"ProviderDetails": ...,
}
parent.create_identity_provider(**kwargs)
create_resource_server#
Creates a new OAuth2.0 resource server and defines custom scopes within it.
Type annotations and code completion for boto3.client("cognito-idp").create_resource_server
method.
boto3 documentation
# create_resource_server method definition
def create_resource_server(
self,
*,
UserPoolId: str,
Identifier: str,
Name: str,
Scopes: Sequence[ResourceServerScopeTypeTypeDef] = ..., # (1)
) -> CreateResourceServerResponseTypeDef: # (2)
...
# create_resource_server method usage example with argument unpacking
kwargs: CreateResourceServerRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Identifier": ...,
"Name": ...,
}
parent.create_resource_server(**kwargs)
create_user_import_job#
Creates the user import job.
Type annotations and code completion for boto3.client("cognito-idp").create_user_import_job
method.
boto3 documentation
# create_user_import_job method definition
def create_user_import_job(
self,
*,
JobName: str,
UserPoolId: str,
CloudWatchLogsRoleArn: str,
) -> CreateUserImportJobResponseTypeDef: # (1)
...
# create_user_import_job method usage example with argument unpacking
kwargs: CreateUserImportJobRequestRequestTypeDef = { # (1)
"JobName": ...,
"UserPoolId": ...,
"CloudWatchLogsRoleArn": ...,
}
parent.create_user_import_job(**kwargs)
create_user_pool#
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
Type annotations and code completion for boto3.client("cognito-idp").create_user_pool
method.
boto3 documentation
# create_user_pool method definition
def create_user_pool(
self,
*,
PoolName: str,
Policies: UserPoolPolicyTypeTypeDef = ..., # (1)
DeletionProtection: DeletionProtectionTypeType = ..., # (2)
LambdaConfig: LambdaConfigTypeTypeDef = ..., # (3)
AutoVerifiedAttributes: Sequence[VerifiedAttributeTypeType] = ..., # (4)
AliasAttributes: Sequence[AliasAttributeTypeType] = ..., # (5)
UsernameAttributes: Sequence[UsernameAttributeTypeType] = ..., # (6)
SmsVerificationMessage: str = ...,
EmailVerificationMessage: str = ...,
EmailVerificationSubject: str = ...,
VerificationMessageTemplate: VerificationMessageTemplateTypeTypeDef = ..., # (7)
SmsAuthenticationMessage: str = ...,
MfaConfiguration: UserPoolMfaTypeType = ..., # (8)
UserAttributeUpdateSettings: UserAttributeUpdateSettingsTypeTypeDef = ..., # (9)
DeviceConfiguration: DeviceConfigurationTypeTypeDef = ..., # (10)
EmailConfiguration: EmailConfigurationTypeTypeDef = ..., # (11)
SmsConfiguration: SmsConfigurationTypeTypeDef = ..., # (12)
UserPoolTags: Mapping[str, str] = ...,
AdminCreateUserConfig: AdminCreateUserConfigTypeTypeDef = ..., # (13)
Schema: Sequence[SchemaAttributeTypeTypeDef] = ..., # (14)
UserPoolAddOns: UserPoolAddOnsTypeTypeDef = ..., # (15)
UsernameConfiguration: UsernameConfigurationTypeTypeDef = ..., # (16)
AccountRecoverySetting: AccountRecoverySettingTypeTypeDef = ..., # (17)
) -> CreateUserPoolResponseTypeDef: # (18)
...
- See UserPoolPolicyTypeTypeDef
- See DeletionProtectionTypeType
- See LambdaConfigTypeTypeDef
- See VerifiedAttributeTypeType
- See AliasAttributeTypeType
- See UsernameAttributeTypeType
- See VerificationMessageTemplateTypeTypeDef
- See UserPoolMfaTypeType
- See UserAttributeUpdateSettingsTypeTypeDef
- See DeviceConfigurationTypeTypeDef
- See EmailConfigurationTypeTypeDef
- See SmsConfigurationTypeTypeDef
- See AdminCreateUserConfigTypeTypeDef
- See SchemaAttributeTypeTypeDef
- See UserPoolAddOnsTypeTypeDef
- See UsernameConfigurationTypeTypeDef
- See AccountRecoverySettingTypeTypeDef
- See CreateUserPoolResponseTypeDef
# create_user_pool method usage example with argument unpacking
kwargs: CreateUserPoolRequestRequestTypeDef = { # (1)
"PoolName": ...,
}
parent.create_user_pool(**kwargs)
create_user_pool_client#
Creates the user pool client.
Type annotations and code completion for boto3.client("cognito-idp").create_user_pool_client
method.
boto3 documentation
# create_user_pool_client method definition
def create_user_pool_client(
self,
*,
UserPoolId: str,
ClientName: str,
GenerateSecret: bool = ...,
RefreshTokenValidity: int = ...,
AccessTokenValidity: int = ...,
IdTokenValidity: int = ...,
TokenValidityUnits: TokenValidityUnitsTypeTypeDef = ..., # (1)
ReadAttributes: Sequence[str] = ...,
WriteAttributes: Sequence[str] = ...,
ExplicitAuthFlows: Sequence[ExplicitAuthFlowsTypeType] = ..., # (2)
SupportedIdentityProviders: Sequence[str] = ...,
CallbackURLs: Sequence[str] = ...,
LogoutURLs: Sequence[str] = ...,
DefaultRedirectURI: str = ...,
AllowedOAuthFlows: Sequence[OAuthFlowTypeType] = ..., # (3)
AllowedOAuthScopes: Sequence[str] = ...,
AllowedOAuthFlowsUserPoolClient: bool = ...,
AnalyticsConfiguration: AnalyticsConfigurationTypeTypeDef = ..., # (4)
PreventUserExistenceErrors: PreventUserExistenceErrorTypesType = ..., # (5)
EnableTokenRevocation: bool = ...,
EnablePropagateAdditionalUserContextData: bool = ...,
AuthSessionValidity: int = ...,
) -> CreateUserPoolClientResponseTypeDef: # (6)
...
- See TokenValidityUnitsTypeTypeDef
- See ExplicitAuthFlowsTypeType
- See OAuthFlowTypeType
- See AnalyticsConfigurationTypeTypeDef
- See PreventUserExistenceErrorTypesType
- See CreateUserPoolClientResponseTypeDef
# create_user_pool_client method usage example with argument unpacking
kwargs: CreateUserPoolClientRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ClientName": ...,
}
parent.create_user_pool_client(**kwargs)
create_user_pool_domain#
Creates a new domain for a user pool.
Type annotations and code completion for boto3.client("cognito-idp").create_user_pool_domain
method.
boto3 documentation
# create_user_pool_domain method definition
def create_user_pool_domain(
self,
*,
Domain: str,
UserPoolId: str,
CustomDomainConfig: CustomDomainConfigTypeTypeDef = ..., # (1)
) -> CreateUserPoolDomainResponseTypeDef: # (2)
...
# create_user_pool_domain method usage example with argument unpacking
kwargs: CreateUserPoolDomainRequestRequestTypeDef = { # (1)
"Domain": ...,
"UserPoolId": ...,
}
parent.create_user_pool_domain(**kwargs)
delete_group#
Deletes a group.
Type annotations and code completion for boto3.client("cognito-idp").delete_group
method.
boto3 documentation
# delete_group method definition
def delete_group(
self,
*,
GroupName: str,
UserPoolId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_group method usage example with argument unpacking
kwargs: DeleteGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"UserPoolId": ...,
}
parent.delete_group(**kwargs)
delete_identity_provider#
Deletes an IdP for a user pool.
Type annotations and code completion for boto3.client("cognito-idp").delete_identity_provider
method.
boto3 documentation
# delete_identity_provider method definition
def delete_identity_provider(
self,
*,
UserPoolId: str,
ProviderName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_identity_provider method usage example with argument unpacking
kwargs: DeleteIdentityProviderRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ProviderName": ...,
}
parent.delete_identity_provider(**kwargs)
delete_resource_server#
Deletes a resource server.
Type annotations and code completion for boto3.client("cognito-idp").delete_resource_server
method.
boto3 documentation
# delete_resource_server method definition
def delete_resource_server(
self,
*,
UserPoolId: str,
Identifier: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_resource_server method usage example with argument unpacking
kwargs: DeleteResourceServerRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Identifier": ...,
}
parent.delete_resource_server(**kwargs)
delete_user#
Allows a user to delete himself or herself.
Type annotations and code completion for boto3.client("cognito-idp").delete_user
method.
boto3 documentation
# delete_user method definition
def delete_user(
self,
*,
AccessToken: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_user method usage example with argument unpacking
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"AccessToken": ...,
}
parent.delete_user(**kwargs)
delete_user_attributes#
Deletes the attributes for a user.
Type annotations and code completion for boto3.client("cognito-idp").delete_user_attributes
method.
boto3 documentation
# delete_user_attributes method definition
def delete_user_attributes(
self,
*,
UserAttributeNames: Sequence[str],
AccessToken: str,
) -> Dict[str, Any]:
...
# delete_user_attributes method usage example with argument unpacking
kwargs: DeleteUserAttributesRequestRequestTypeDef = { # (1)
"UserAttributeNames": ...,
"AccessToken": ...,
}
parent.delete_user_attributes(**kwargs)
delete_user_pool#
Deletes the specified Amazon Cognito user pool.
Type annotations and code completion for boto3.client("cognito-idp").delete_user_pool
method.
boto3 documentation
# delete_user_pool method definition
def delete_user_pool(
self,
*,
UserPoolId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_user_pool method usage example with argument unpacking
kwargs: DeleteUserPoolRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.delete_user_pool(**kwargs)
delete_user_pool_client#
Allows the developer to delete the user pool client.
Type annotations and code completion for boto3.client("cognito-idp").delete_user_pool_client
method.
boto3 documentation
# delete_user_pool_client method definition
def delete_user_pool_client(
self,
*,
UserPoolId: str,
ClientId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_user_pool_client method usage example with argument unpacking
kwargs: DeleteUserPoolClientRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ClientId": ...,
}
parent.delete_user_pool_client(**kwargs)
delete_user_pool_domain#
Deletes a domain for a user pool.
Type annotations and code completion for boto3.client("cognito-idp").delete_user_pool_domain
method.
boto3 documentation
# delete_user_pool_domain method definition
def delete_user_pool_domain(
self,
*,
Domain: str,
UserPoolId: str,
) -> Dict[str, Any]:
...
# delete_user_pool_domain method usage example with argument unpacking
kwargs: DeleteUserPoolDomainRequestRequestTypeDef = { # (1)
"Domain": ...,
"UserPoolId": ...,
}
parent.delete_user_pool_domain(**kwargs)
describe_identity_provider#
Gets information about a specific IdP.
Type annotations and code completion for boto3.client("cognito-idp").describe_identity_provider
method.
boto3 documentation
# describe_identity_provider method definition
def describe_identity_provider(
self,
*,
UserPoolId: str,
ProviderName: str,
) -> DescribeIdentityProviderResponseTypeDef: # (1)
...
# describe_identity_provider method usage example with argument unpacking
kwargs: DescribeIdentityProviderRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ProviderName": ...,
}
parent.describe_identity_provider(**kwargs)
describe_resource_server#
Describes a resource server.
Type annotations and code completion for boto3.client("cognito-idp").describe_resource_server
method.
boto3 documentation
# describe_resource_server method definition
def describe_resource_server(
self,
*,
UserPoolId: str,
Identifier: str,
) -> DescribeResourceServerResponseTypeDef: # (1)
...
# describe_resource_server method usage example with argument unpacking
kwargs: DescribeResourceServerRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Identifier": ...,
}
parent.describe_resource_server(**kwargs)
describe_risk_configuration#
Describes the risk configuration.
Type annotations and code completion for boto3.client("cognito-idp").describe_risk_configuration
method.
boto3 documentation
# describe_risk_configuration method definition
def describe_risk_configuration(
self,
*,
UserPoolId: str,
ClientId: str = ...,
) -> DescribeRiskConfigurationResponseTypeDef: # (1)
...
# describe_risk_configuration method usage example with argument unpacking
kwargs: DescribeRiskConfigurationRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.describe_risk_configuration(**kwargs)
describe_user_import_job#
Describes the user import job.
Type annotations and code completion for boto3.client("cognito-idp").describe_user_import_job
method.
boto3 documentation
# describe_user_import_job method definition
def describe_user_import_job(
self,
*,
UserPoolId: str,
JobId: str,
) -> DescribeUserImportJobResponseTypeDef: # (1)
...
# describe_user_import_job method usage example with argument unpacking
kwargs: DescribeUserImportJobRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"JobId": ...,
}
parent.describe_user_import_job(**kwargs)
describe_user_pool#
Returns the configuration information and metadata of the specified user pool.
Type annotations and code completion for boto3.client("cognito-idp").describe_user_pool
method.
boto3 documentation
# describe_user_pool method definition
def describe_user_pool(
self,
*,
UserPoolId: str,
) -> DescribeUserPoolResponseTypeDef: # (1)
...
# describe_user_pool method usage example with argument unpacking
kwargs: DescribeUserPoolRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.describe_user_pool(**kwargs)
describe_user_pool_client#
Client method for returning the configuration information and metadata of the specified user pool app client.
Type annotations and code completion for boto3.client("cognito-idp").describe_user_pool_client
method.
boto3 documentation
# describe_user_pool_client method definition
def describe_user_pool_client(
self,
*,
UserPoolId: str,
ClientId: str,
) -> DescribeUserPoolClientResponseTypeDef: # (1)
...
# describe_user_pool_client method usage example with argument unpacking
kwargs: DescribeUserPoolClientRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ClientId": ...,
}
parent.describe_user_pool_client(**kwargs)
describe_user_pool_domain#
Gets information about a domain.
Type annotations and code completion for boto3.client("cognito-idp").describe_user_pool_domain
method.
boto3 documentation
# describe_user_pool_domain method definition
def describe_user_pool_domain(
self,
*,
Domain: str,
) -> DescribeUserPoolDomainResponseTypeDef: # (1)
...
# describe_user_pool_domain method usage example with argument unpacking
kwargs: DescribeUserPoolDomainRequestRequestTypeDef = { # (1)
"Domain": ...,
}
parent.describe_user_pool_domain(**kwargs)
forget_device#
Forgets the specified device.
Type annotations and code completion for boto3.client("cognito-idp").forget_device
method.
boto3 documentation
# forget_device method definition
def forget_device(
self,
*,
DeviceKey: str,
AccessToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# forget_device method usage example with argument unpacking
kwargs: ForgetDeviceRequestRequestTypeDef = { # (1)
"DeviceKey": ...,
}
parent.forget_device(**kwargs)
forgot_password#
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password.
Type annotations and code completion for boto3.client("cognito-idp").forgot_password
method.
boto3 documentation
# forgot_password method definition
def forgot_password(
self,
*,
ClientId: str,
Username: str,
SecretHash: str = ...,
UserContextData: UserContextDataTypeTypeDef = ..., # (1)
AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ..., # (2)
ClientMetadata: Mapping[str, str] = ...,
) -> ForgotPasswordResponseTypeDef: # (3)
...
# forgot_password method usage example with argument unpacking
kwargs: ForgotPasswordRequestRequestTypeDef = { # (1)
"ClientId": ...,
"Username": ...,
}
parent.forgot_password(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("cognito-idp").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_csv_header#
Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
Type annotations and code completion for boto3.client("cognito-idp").get_csv_header
method.
boto3 documentation
# get_csv_header method definition
def get_csv_header(
self,
*,
UserPoolId: str,
) -> GetCSVHeaderResponseTypeDef: # (1)
...
# get_csv_header method usage example with argument unpacking
kwargs: GetCSVHeaderRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.get_csv_header(**kwargs)
get_device#
Gets the device.
Type annotations and code completion for boto3.client("cognito-idp").get_device
method.
boto3 documentation
# get_device method definition
def get_device(
self,
*,
DeviceKey: str,
AccessToken: str = ...,
) -> GetDeviceResponseTypeDef: # (1)
...
# get_device method usage example with argument unpacking
kwargs: GetDeviceRequestRequestTypeDef = { # (1)
"DeviceKey": ...,
}
parent.get_device(**kwargs)
get_group#
Gets a group.
Type annotations and code completion for boto3.client("cognito-idp").get_group
method.