Skip to content

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.DeviceKeyExistsException,
    client.exceptions.DuplicateProviderException,
    client.exceptions.EnableSoftwareTokenMFAException,
    client.exceptions.ExpiredCodeException,
    client.exceptions.FeatureUnavailableInTierException,
    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.ManagedLoginBrandingExistsException,
    client.exceptions.NotAuthorizedException,
    client.exceptions.PasswordHistoryPolicyViolationException,
    client.exceptions.PasswordResetRequiredException,
    client.exceptions.PreconditionNotMetException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ScopeDoesNotExistException,
    client.exceptions.SoftwareTokenMFANotFoundException,
    client.exceptions.TierChangeNotAllowedException,
    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,
    client.exceptions.WebAuthnChallengeNotFoundException,
    client.exceptions.WebAuthnClientMismatchException,
    client.exceptions.WebAuthnConfigurationMissingException,
    client.exceptions.WebAuthnCredentialNotSupportedException,
    client.exceptions.WebAuthnNotEnabledException,
    client.exceptions.WebAuthnOriginNotAllowedException,
    client.exceptions.WebAuthnRelyingPartyMismatchException,
) 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#

can_paginate#

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

generate_presigned_url#

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

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]:
    ...
  1. See Sequence[SchemaAttributeTypeTypeDef]
# add_custom_attributes method usage example with argument unpacking

kwargs: AddCustomAttributesRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "CustomAttributes": ...,
}

parent.add_custom_attributes(**kwargs)
  1. See AddCustomAttributesRequestTypeDef

admin_add_user_to_group#

Adds a user to a 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)
    ...
  1. See EmptyResponseMetadataTypeDef
# admin_add_user_to_group method usage example with argument unpacking

kwargs: AdminAddUserToGroupRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "GroupName": ...,
}

parent.admin_add_user_to_group(**kwargs)
  1. See AdminAddUserToGroupRequestTypeDef

admin_confirm_sign_up#

Confirms user sign-up as an administrator.

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: AdminConfirmSignUpRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

parent.admin_confirm_sign_up(**kwargs)
  1. See AdminConfirmSignUpRequestTypeDef

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)
    ...
  1. See Sequence[AttributeTypeTypeDef]
  2. See Sequence[AttributeTypeTypeDef]
  3. See MessageActionTypeType
  4. See Sequence[DeliveryMediumTypeType]
  5. See AdminCreateUserResponseTypeDef
# admin_create_user method usage example with argument unpacking

kwargs: AdminCreateUserRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

parent.admin_create_user(**kwargs)
  1. See AdminCreateUserRequestTypeDef

admin_delete_user#

Deletes a user profile in your user pool.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# admin_delete_user method usage example with argument unpacking

kwargs: AdminDeleteUserRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

parent.admin_delete_user(**kwargs)
  1. See AdminDeleteUserRequestTypeDef

admin_delete_user_attributes#

Deletes attribute values from a user.

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: AdminDeleteUserAttributesRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "UserAttributeNames": ...,
}

parent.admin_delete_user_attributes(**kwargs)
  1. See AdminDeleteUserAttributesRequestTypeDef

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]:
    ...
  1. See ProviderUserIdentifierTypeTypeDef
# admin_disable_provider_for_user method usage example with argument unpacking

kwargs: AdminDisableProviderForUserRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "User": ...,
}

parent.admin_disable_provider_for_user(**kwargs)
  1. See AdminDisableProviderForUserRequestTypeDef

admin_disable_user#

Deactivates a user profile 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: AdminDisableUserRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

parent.admin_disable_user(**kwargs)
  1. See AdminDisableUserRequestTypeDef

admin_enable_user#

Activates sign-in for a user profile that previously had sign-in access disabled.

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: AdminEnableUserRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

parent.admin_enable_user(**kwargs)
  1. See AdminEnableUserRequestTypeDef

admin_forget_device#

Forgets, or deletes, a remembered device from a user's profile.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# admin_forget_device method usage example with argument unpacking

kwargs: AdminForgetDeviceRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "DeviceKey": ...,
}

parent.admin_forget_device(**kwargs)
  1. See AdminForgetDeviceRequestTypeDef

admin_get_device#

Given the device key, returns details for a user's device.

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)
    ...
  1. See AdminGetDeviceResponseTypeDef
# admin_get_device method usage example with argument unpacking

kwargs: AdminGetDeviceRequestTypeDef = {  # (1)
    "DeviceKey": ...,
    "UserPoolId": ...,
    "Username": ...,
}

parent.admin_get_device(**kwargs)
  1. See AdminGetDeviceRequestTypeDef

admin_get_user#

Given a username, returns details about a user profile in a user pool.

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)
    ...
  1. See AdminGetUserResponseTypeDef
# admin_get_user method usage example with argument unpacking

kwargs: AdminGetUserRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

parent.admin_get_user(**kwargs)
  1. See AdminGetUserRequestTypeDef

admin_initiate_auth#

Starts sign-in for applications with a server-side component, for example a traditional web application.

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)
    Session: str = ...,
) -> AdminInitiateAuthResponseTypeDef:  # (4)
    ...
  1. See AuthFlowTypeType
  2. See AnalyticsMetadataTypeTypeDef
  3. See ContextDataTypeTypeDef
  4. See AdminInitiateAuthResponseTypeDef
# admin_initiate_auth method usage example with argument unpacking

kwargs: AdminInitiateAuthRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
    "AuthFlow": ...,
}

parent.admin_initiate_auth(**kwargs)
  1. See AdminInitiateAuthRequestTypeDef

Links an existing user account in a user pool, or DestinationUser, to an identity from an external IdP, or 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]:
    ...
  1. See ProviderUserIdentifierTypeTypeDef
  2. See ProviderUserIdentifierTypeTypeDef
# admin_link_provider_for_user method usage example with argument unpacking

kwargs: AdminLinkProviderForUserRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "DestinationUser": ...,
    "SourceUser": ...,
}

parent.admin_link_provider_for_user(**kwargs)
  1. See AdminLinkProviderForUserRequestTypeDef

admin_list_devices#

Lists a user's registered devices.

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)
    ...
  1. See AdminListDevicesResponseTypeDef
# admin_list_devices method usage example with argument unpacking

kwargs: AdminListDevicesRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

parent.admin_list_devices(**kwargs)
  1. See AdminListDevicesRequestTypeDef

admin_list_groups_for_user#

Lists the groups that a 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)
    ...
  1. See AdminListGroupsForUserResponseTypeDef
# admin_list_groups_for_user method usage example with argument unpacking

kwargs: AdminListGroupsForUserRequestTypeDef = {  # (1)
    "Username": ...,
    "UserPoolId": ...,
}

parent.admin_list_groups_for_user(**kwargs)
  1. See AdminListGroupsForUserRequestTypeDef

admin_list_user_auth_events#

Requests a history of user activity and any risks detected as part of Amazon Cognito threat protection.

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)
    ...
  1. See AdminListUserAuthEventsResponseTypeDef
# admin_list_user_auth_events method usage example with argument unpacking

kwargs: AdminListUserAuthEventsRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

parent.admin_list_user_auth_events(**kwargs)
  1. See AdminListUserAuthEventsRequestTypeDef

admin_remove_user_from_group#

Given a username and a group name, removes them from the 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)
    ...
  1. See EmptyResponseMetadataTypeDef
# admin_remove_user_from_group method usage example with argument unpacking

kwargs: AdminRemoveUserFromGroupRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "GroupName": ...,
}

parent.admin_remove_user_from_group(**kwargs)
  1. See AdminRemoveUserFromGroupRequestTypeDef

admin_reset_user_password#

Resets the specified user's password in a user pool.

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: AdminResetUserPasswordRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

parent.admin_reset_user_password(**kwargs)
  1. See AdminResetUserPasswordRequestTypeDef

admin_respond_to_auth_challenge#

Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge.

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)
    ...
  1. See ChallengeNameTypeType
  2. See AnalyticsMetadataTypeTypeDef
  3. See ContextDataTypeTypeDef
  4. See AdminRespondToAuthChallengeResponseTypeDef
# admin_respond_to_auth_challenge method usage example with argument unpacking

kwargs: AdminRespondToAuthChallengeRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
    "ChallengeName": ...,
}

parent.admin_respond_to_auth_challenge(**kwargs)
  1. See AdminRespondToAuthChallengeRequestTypeDef

admin_set_user_mfa_preference#

Sets 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)
    EmailMfaSettings: EmailMfaSettingsTypeTypeDef = ...,  # (3)
) -> Dict[str, Any]:
    ...
  1. See SMSMfaSettingsTypeTypeDef
  2. See SoftwareTokenMfaSettingsTypeTypeDef
  3. See EmailMfaSettingsTypeTypeDef
# admin_set_user_mfa_preference method usage example with argument unpacking

kwargs: AdminSetUserMFAPreferenceRequestTypeDef = {  # (1)
    "Username": ...,
    "UserPoolId": ...,
}

parent.admin_set_user_mfa_preference(**kwargs)
  1. See AdminSetUserMFAPreferenceRequestTypeDef

admin_set_user_password#

Sets the specified user's password in a user pool.

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: AdminSetUserPasswordRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "Password": ...,
}

parent.admin_set_user_password(**kwargs)
  1. See AdminSetUserPasswordRequestTypeDef

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]:
    ...
  1. See Sequence[MFAOptionTypeTypeDef]
# admin_set_user_settings method usage example with argument unpacking

kwargs: AdminSetUserSettingsRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "MFAOptions": ...,
}

parent.admin_set_user_settings(**kwargs)
  1. See AdminSetUserSettingsRequestTypeDef

admin_update_auth_event_feedback#

Provides the feedback for an authentication event generated by threat protection features.

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]:
    ...
  1. See FeedbackValueTypeType
# admin_update_auth_event_feedback method usage example with argument unpacking

kwargs: AdminUpdateAuthEventFeedbackRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "EventId": ...,
    "FeedbackValue": ...,
}

parent.admin_update_auth_event_feedback(**kwargs)
  1. See AdminUpdateAuthEventFeedbackRequestTypeDef

admin_update_device_status#

Updates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication.

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]:
    ...
  1. See DeviceRememberedStatusTypeType
# admin_update_device_status method usage example with argument unpacking

kwargs: AdminUpdateDeviceStatusRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "DeviceKey": ...,
}

parent.admin_update_device_status(**kwargs)
  1. See AdminUpdateDeviceStatusRequestTypeDef

admin_update_user_attributes#

Updates the specified user's attributes.

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]:
    ...
  1. See Sequence[AttributeTypeTypeDef]
# admin_update_user_attributes method usage example with argument unpacking

kwargs: AdminUpdateUserAttributesRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "UserAttributes": ...,
}

parent.admin_update_user_attributes(**kwargs)
  1. See AdminUpdateUserAttributesRequestTypeDef

admin_user_global_sign_out#

Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.

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: AdminUserGlobalSignOutRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

parent.admin_user_global_sign_out(**kwargs)
  1. See AdminUserGlobalSignOutRequestTypeDef

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)
    ...
  1. See AssociateSoftwareTokenResponseTypeDef
# associate_software_token method usage example with argument unpacking

kwargs: AssociateSoftwareTokenRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

parent.associate_software_token(**kwargs)
  1. See AssociateSoftwareTokenRequestTypeDef

change_password#

Changes the password for the currently signed-in user.

Type annotations and code completion for boto3.client("cognito-idp").change_password method. boto3 documentation

# change_password method definition

def change_password(
    self,
    *,
    ProposedPassword: str,
    AccessToken: str,
    PreviousPassword: str = ...,
) -> Dict[str, Any]:
    ...
# change_password method usage example with argument unpacking

kwargs: ChangePasswordRequestTypeDef = {  # (1)
    "ProposedPassword": ...,
    "AccessToken": ...,
}

parent.change_password(**kwargs)
  1. See ChangePasswordRequestTypeDef

complete_web_authn_registration#

Completes registration of a passkey authenticator for the currently signed-in user.

Type annotations and code completion for boto3.client("cognito-idp").complete_web_authn_registration method. boto3 documentation

# complete_web_authn_registration method definition

def complete_web_authn_registration(
    self,
    *,
    AccessToken: str,
    Credential: Mapping[str, Any],
) -> Dict[str, Any]:
    ...
# complete_web_authn_registration method usage example with argument unpacking

kwargs: CompleteWebAuthnRegistrationRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "Credential": ...,
}

parent.complete_web_authn_registration(**kwargs)
  1. See CompleteWebAuthnRegistrationRequestTypeDef

confirm_device#

Confirms a device that a user wants to remember.

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)
    ...
  1. See DeviceSecretVerifierConfigTypeTypeDef
  2. See ConfirmDeviceResponseTypeDef
# confirm_device method usage example with argument unpacking

kwargs: ConfirmDeviceRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "DeviceKey": ...,
}

parent.confirm_device(**kwargs)
  1. See ConfirmDeviceRequestTypeDef

confirm_forgot_password#

This public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user.

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]:
    ...
  1. See AnalyticsMetadataTypeTypeDef
  2. See UserContextDataTypeTypeDef
# confirm_forgot_password method usage example with argument unpacking

kwargs: ConfirmForgotPasswordRequestTypeDef = {  # (1)
    "ClientId": ...,
    "Username": ...,
    "ConfirmationCode": ...,
    "Password": ...,
}

parent.confirm_forgot_password(**kwargs)
  1. See ConfirmForgotPasswordRequestTypeDef

confirm_sign_up#

Confirms the account 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] = ...,
    Session: str = ...,
) -> ConfirmSignUpResponseTypeDef:  # (3)
    ...
  1. See AnalyticsMetadataTypeTypeDef
  2. See UserContextDataTypeTypeDef
  3. See ConfirmSignUpResponseTypeDef
# confirm_sign_up method usage example with argument unpacking

kwargs: ConfirmSignUpRequestTypeDef = {  # (1)
    "ClientId": ...,
    "Username": ...,
    "ConfirmationCode": ...,
}

parent.confirm_sign_up(**kwargs)
  1. See ConfirmSignUpRequestTypeDef

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)
    ...
  1. See CreateGroupResponseTypeDef
# create_group method usage example with argument unpacking

kwargs: CreateGroupRequestTypeDef = {  # (1)
    "GroupName": ...,
    "UserPoolId": ...,
}

parent.create_group(**kwargs)
  1. See CreateGroupRequestTypeDef

create_identity_provider#

Adds a configuration and trust relationship between a third-party identity provider (IdP) and 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)
    ...
  1. See IdentityProviderTypeTypeType
  2. See CreateIdentityProviderResponseTypeDef
# create_identity_provider method usage example with argument unpacking

kwargs: CreateIdentityProviderRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ProviderName": ...,
    "ProviderType": ...,
    "ProviderDetails": ...,
}

parent.create_identity_provider(**kwargs)
  1. See CreateIdentityProviderRequestTypeDef

create_managed_login_branding#

Creates a new set of branding settings for a user pool style and associates it with an app client.

Type annotations and code completion for boto3.client("cognito-idp").create_managed_login_branding method. boto3 documentation

# create_managed_login_branding method definition

def create_managed_login_branding(
    self,
    *,
    UserPoolId: str,
    ClientId: str,
    UseCognitoProvidedValues: bool = ...,
    Settings: Mapping[str, Any] = ...,
    Assets: Sequence[AssetTypeUnionTypeDef] = ...,  # (1)
) -> CreateManagedLoginBrandingResponseTypeDef:  # (2)
    ...
  1. See Sequence[AssetTypeUnionTypeDef]
  2. See CreateManagedLoginBrandingResponseTypeDef
# create_managed_login_branding method usage example with argument unpacking

kwargs: CreateManagedLoginBrandingRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
}

parent.create_managed_login_branding(**kwargs)
  1. See CreateManagedLoginBrandingRequestTypeDef

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)
    ...
  1. See Sequence[ResourceServerScopeTypeTypeDef]
  2. See CreateResourceServerResponseTypeDef
# create_resource_server method usage example with argument unpacking

kwargs: CreateResourceServerRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Identifier": ...,
    "Name": ...,
}

parent.create_resource_server(**kwargs)
  1. See CreateResourceServerRequestTypeDef

create_user_import_job#

Creates a 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)
    ...
  1. See CreateUserImportJobResponseTypeDef
# create_user_import_job method usage example with argument unpacking

kwargs: CreateUserImportJobRequestTypeDef = {  # (1)
    "JobName": ...,
    "UserPoolId": ...,
    "CloudWatchLogsRoleArn": ...,
}

parent.create_user_import_job(**kwargs)
  1. See CreateUserImportJobRequestTypeDef

create_user_pool#

Creates a new Amazon Cognito user 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: UserPoolPolicyTypeUnionTypeDef = ...,  # (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: UserAttributeUpdateSettingsTypeUnionTypeDef = ...,  # (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: AccountRecoverySettingTypeUnionTypeDef = ...,  # (17)
    UserPoolTier: UserPoolTierTypeType = ...,  # (18)
) -> CreateUserPoolResponseTypeDef:  # (19)
    ...
  1. See UserPoolPolicyTypeUnionTypeDef
  2. See DeletionProtectionTypeType
  3. See LambdaConfigTypeTypeDef
  4. See Sequence[VerifiedAttributeTypeType]
  5. See Sequence[AliasAttributeTypeType]
  6. See Sequence[UsernameAttributeTypeType]
  7. See VerificationMessageTemplateTypeTypeDef
  8. See UserPoolMfaTypeType
  9. See UserAttributeUpdateSettingsTypeUnionTypeDef
  10. See DeviceConfigurationTypeTypeDef
  11. See EmailConfigurationTypeTypeDef
  12. See SmsConfigurationTypeTypeDef
  13. See AdminCreateUserConfigTypeTypeDef
  14. See Sequence[SchemaAttributeTypeTypeDef]
  15. See UserPoolAddOnsTypeTypeDef
  16. See UsernameConfigurationTypeTypeDef
  17. See AccountRecoverySettingTypeUnionTypeDef
  18. See UserPoolTierTypeType
  19. See CreateUserPoolResponseTypeDef
# create_user_pool method usage example with argument unpacking

kwargs: CreateUserPoolRequestTypeDef = {  # (1)
    "PoolName": ...,
}

parent.create_user_pool(**kwargs)
  1. See CreateUserPoolRequestTypeDef

create_user_pool_client#

Creates an app client in a user pool.

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)
    ...
  1. See TokenValidityUnitsTypeTypeDef
  2. See Sequence[ExplicitAuthFlowsTypeType]
  3. See Sequence[OAuthFlowTypeType]
  4. See AnalyticsConfigurationTypeTypeDef
  5. See PreventUserExistenceErrorTypesType
  6. See CreateUserPoolClientResponseTypeDef
# create_user_pool_client method usage example with argument unpacking

kwargs: CreateUserPoolClientRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientName": ...,
}

parent.create_user_pool_client(**kwargs)
  1. See CreateUserPoolClientRequestTypeDef

create_user_pool_domain#

A user pool domain hosts managed login, an authorization server and web server for authentication in your application.

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,
    ManagedLoginVersion: int = ...,
    CustomDomainConfig: CustomDomainConfigTypeTypeDef = ...,  # (1)
) -> CreateUserPoolDomainResponseTypeDef:  # (2)
    ...
  1. See CustomDomainConfigTypeTypeDef
  2. See CreateUserPoolDomainResponseTypeDef
# create_user_pool_domain method usage example with argument unpacking

kwargs: CreateUserPoolDomainRequestTypeDef = {  # (1)
    "Domain": ...,
    "UserPoolId": ...,
}

parent.create_user_pool_domain(**kwargs)
  1. See CreateUserPoolDomainRequestTypeDef

delete_group#

Deletes a group from the specified user pool.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_group method usage example with argument unpacking

kwargs: DeleteGroupRequestTypeDef = {  # (1)
    "GroupName": ...,
    "UserPoolId": ...,
}

parent.delete_group(**kwargs)
  1. See DeleteGroupRequestTypeDef

delete_identity_provider#

Deletes a user pool identity provider (IdP).

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_identity_provider method usage example with argument unpacking

kwargs: DeleteIdentityProviderRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ProviderName": ...,
}

parent.delete_identity_provider(**kwargs)
  1. See DeleteIdentityProviderRequestTypeDef

delete_managed_login_branding#

Deletes a managed login branding style.

Type annotations and code completion for boto3.client("cognito-idp").delete_managed_login_branding method. boto3 documentation

# delete_managed_login_branding method definition

def delete_managed_login_branding(
    self,
    *,
    ManagedLoginBrandingId: str,
    UserPoolId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_managed_login_branding method usage example with argument unpacking

kwargs: DeleteManagedLoginBrandingRequestTypeDef = {  # (1)
    "ManagedLoginBrandingId": ...,
    "UserPoolId": ...,
}

parent.delete_managed_login_branding(**kwargs)
  1. See DeleteManagedLoginBrandingRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_resource_server method usage example with argument unpacking

kwargs: DeleteResourceServerRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Identifier": ...,
}

parent.delete_resource_server(**kwargs)
  1. See DeleteResourceServerRequestTypeDef

delete_user#

Deletes the profile of the currently signed-in user.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_user method usage example with argument unpacking

kwargs: DeleteUserRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

parent.delete_user(**kwargs)
  1. See DeleteUserRequestTypeDef

delete_user_attributes#

Deletes attributes from the currently signed-in 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: DeleteUserAttributesRequestTypeDef = {  # (1)
    "UserAttributeNames": ...,
    "AccessToken": ...,
}

parent.delete_user_attributes(**kwargs)
  1. See DeleteUserAttributesRequestTypeDef

delete_user_pool#

Deletes a 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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_user_pool method usage example with argument unpacking

kwargs: DeleteUserPoolRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.delete_user_pool(**kwargs)
  1. See DeleteUserPoolRequestTypeDef

delete_user_pool_client#

Deletes a user pool app 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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_user_pool_client method usage example with argument unpacking

kwargs: DeleteUserPoolClientRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
}

parent.delete_user_pool_client(**kwargs)
  1. See DeleteUserPoolClientRequestTypeDef

delete_user_pool_domain#

Given a user pool ID and domain identifier, deletes a user pool domain.

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: DeleteUserPoolDomainRequestTypeDef = {  # (1)
    "Domain": ...,
    "UserPoolId": ...,
}

parent.delete_user_pool_domain(**kwargs)
  1. See DeleteUserPoolDomainRequestTypeDef

delete_web_authn_credential#

Deletes a registered passkey, or WebAuthn, authenticator for the currently signed-in user.

Type annotations and code completion for boto3.client("cognito-idp").delete_web_authn_credential method. boto3 documentation

# delete_web_authn_credential method definition

def delete_web_authn_credential(
    self,
    *,
    AccessToken: str,
    CredentialId: str,
) -> Dict[str, Any]:
    ...
# delete_web_authn_credential method usage example with argument unpacking

kwargs: DeleteWebAuthnCredentialRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "CredentialId": ...,
}

parent.delete_web_authn_credential(**kwargs)
  1. See DeleteWebAuthnCredentialRequestTypeDef

describe_identity_provider#

Given a user pool ID and identity provider (IdP) name, returns details about the 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)
    ...
  1. See DescribeIdentityProviderResponseTypeDef
# describe_identity_provider method usage example with argument unpacking

kwargs: DescribeIdentityProviderRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ProviderName": ...,
}

parent.describe_identity_provider(**kwargs)
  1. See DescribeIdentityProviderRequestTypeDef

describe_managed_login_branding#

Given the ID of a managed login branding style, returns detailed information about the style.

Type annotations and code completion for boto3.client("cognito-idp").describe_managed_login_branding method. boto3 documentation

# describe_managed_login_branding method definition

def describe_managed_login_branding(
    self,
    *,
    UserPoolId: str,
    ManagedLoginBrandingId: str,
    ReturnMergedResources: bool = ...,
) -> DescribeManagedLoginBrandingResponseTypeDef:  # (1)
    ...
  1. See DescribeManagedLoginBrandingResponseTypeDef
# describe_managed_login_branding method usage example with argument unpacking

kwargs: DescribeManagedLoginBrandingRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ManagedLoginBrandingId": ...,
}

parent.describe_managed_login_branding(**kwargs)
  1. See DescribeManagedLoginBrandingRequestTypeDef

describe_managed_login_branding_by_client#

Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.

Type annotations and code completion for boto3.client("cognito-idp").describe_managed_login_branding_by_client method. boto3 documentation

# describe_managed_login_branding_by_client method definition

def describe_managed_login_branding_by_client(
    self,
    *,
    UserPoolId: str,
    ClientId: str,
    ReturnMergedResources: bool = ...,
) -> DescribeManagedLoginBrandingByClientResponseTypeDef:  # (1)
    ...
  1. See DescribeManagedLoginBrandingByClientResponseTypeDef
# describe_managed_login_branding_by_client method usage example with argument unpacking

kwargs: DescribeManagedLoginBrandingByClientRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
}

parent.describe_managed_login_branding_by_client(**kwargs)
  1. See DescribeManagedLoginBrandingByClientRequestTypeDef

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)
    ...
  1. See DescribeResourceServerResponseTypeDef
# describe_resource_server method usage example with argument unpacking

kwargs: DescribeResourceServerRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Identifier": ...,
}

parent.describe_resource_server(**kwargs)
  1. See DescribeResourceServerRequestTypeDef

describe_risk_configuration#

Given an app client or user pool ID where threat protection is configured, 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)
    ...
  1. See DescribeRiskConfigurationResponseTypeDef
# describe_risk_configuration method usage example with argument unpacking

kwargs: DescribeRiskConfigurationRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.describe_risk_configuration(**kwargs)
  1. See DescribeRiskConfigurationRequestTypeDef

describe_user_import_job#

Describes a 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)
    ...
  1. See DescribeUserImportJobResponseTypeDef
# describe_user_import_job method usage example with argument unpacking

kwargs: DescribeUserImportJobRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "JobId": ...,
}

parent.describe_user_import_job(**kwargs)
  1. See DescribeUserImportJobRequestTypeDef

describe_user_pool#

Given a user pool ID, returns configuration information.

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)
    ...
  1. See DescribeUserPoolResponseTypeDef
# describe_user_pool method usage example with argument unpacking

kwargs: DescribeUserPoolRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.describe_user_pool(**kwargs)
  1. See DescribeUserPoolRequestTypeDef

describe_user_pool_client#

Given an app client ID, returns configuration information.

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)
    ...
  1. See DescribeUserPoolClientResponseTypeDef
# describe_user_pool_client method usage example with argument unpacking

kwargs: DescribeUserPoolClientRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
}

parent.describe_user_pool_client(**kwargs)
  1. See DescribeUserPoolClientRequestTypeDef

describe_user_pool_domain#

Given a user pool domain name, returns information about the domain configuration.

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)
    ...
  1. See DescribeUserPoolDomainResponseTypeDef
# describe_user_pool_domain method usage example with argument unpacking

kwargs: DescribeUserPoolDomainRequestTypeDef = {  # (1)
    "Domain": ...,
}

parent.describe_user_pool_domain(**kwargs)
  1. See DescribeUserPoolDomainRequestTypeDef

forget_device#

Given a device key, deletes a remembered device as the currently signed-in user.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# forget_device method usage example with argument unpacking

kwargs: ForgetDeviceRequestTypeDef = {  # (1)
    "DeviceKey": ...,
}

parent.forget_device(**kwargs)
  1. See ForgetDeviceRequestTypeDef

forgot_password#

Sends a password-reset confirmation code for the currently signed-in user.

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)
    ...
  1. See UserContextDataTypeTypeDef
  2. See AnalyticsMetadataTypeTypeDef
  3. See ForgotPasswordResponseTypeDef
# forgot_password method usage example with argument unpacking

kwargs: ForgotPasswordRequestTypeDef = {  # (1)
    "ClientId": ...,
    "Username": ...,
}

parent.forgot_password(**kwargs)
  1. See ForgotPasswordRequestTypeDef

get_csv_header#

Given a user pool ID, generates a comma-separated value (CSV) list populated with available user attributes in the user pool.

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)
    ...
  1. See GetCSVHeaderResponseTypeDef
# get_csv_header method usage example with argument unpacking

kwargs: GetCSVHeaderRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.get_csv_header(**kwargs)
  1. See GetCSVHeaderRequestTypeDef

get_device#

Given a device key, returns information about a remembered device for the current user.

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)
    ...
  1. See GetDeviceResponseTypeDef
# get_device method usage example with argument unpacking

kwargs: GetDeviceRequestTypeDef = {  # (1)
    "DeviceKey": ...,
}

parent.get_device(**kwargs)
  1. See GetDeviceRequestTypeDef

get_group#

Given a user pool ID and a group name, returns information about the user group.

Type annotations and code completion for boto3.client("cognito-idp").get_group method. boto3 documentation

# get_group method definition

def get_group(
    self,
    *,
    GroupName: str,
    UserPoolId: str,
) -> GetGroupResponseTypeDef:  # (1)
    ...
  1. See GetGroupResponseTypeDef
# get_group method usage example with argument unpacking

kwargs: GetGroupRequestTypeDef = {  # (1)
    "GroupName": ...,
    "UserPoolId": ...,
}

parent.get_group(**kwargs)
  1. See GetGroupRequestTypeDef

get_identity_provider_by_identifier#

Given the identifier of an identity provider (IdP), for example examplecorp, returns information about the user pool configuration for that IdP.

Type annotations and code completion for boto3.client("cognito-idp").get_identity_provider_by_identifier method. boto3 documentation

# get_identity_provider_by_identifier method definition

def get_identity_provider_by_identifier(
    self,
    *,
    UserPoolId: str,
    IdpIdentifier: str,
) -> GetIdentityProviderByIdentifierResponseTypeDef:  # (1)
    ...
  1. See GetIdentityProviderByIdentifierResponseTypeDef
# get_identity_provider_by_identifier method usage example with argument unpacking

kwargs: GetIdentityProviderByIdentifierRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "IdpIdentifier": ...,
}

parent.get_identity_provider_by_identifier(**kwargs)
  1. See GetIdentityProviderByIdentifierRequestTypeDef

get_log_delivery_configuration#

Given a user pool ID, returns the logging configuration.

Type annotations and code completion for boto3.client("cognito-idp").get_log_delivery_configuration method. boto3 documentation

# get_log_delivery_configuration method definition

def get_log_delivery_configuration(
    self,
    *,
    UserPoolId: str,
) -> GetLogDeliveryConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetLogDeliveryConfigurationResponseTypeDef
# get_log_delivery_configuration method usage example with argument unpacking

kwargs: GetLogDeliveryConfigurationRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.get_log_delivery_configuration(**kwargs)
  1. See GetLogDeliveryConfigurationRequestTypeDef

get_signing_certificate#

Given a user pool ID, returns the signing certificate for SAML 2.0 federation.

Type annotations and code completion for boto3.client("cognito-idp").get_signing_certificate method. boto3 documentation

# get_signing_certificate method definition

def get_signing_certificate(
    self,
    *,
    UserPoolId: str,
) -> GetSigningCertificateResponseTypeDef:  # (1)
    ...
  1. See GetSigningCertificateResponseTypeDef
# get_signing_certificate method usage example with argument unpacking

kwargs: GetSigningCertificateRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.get_signing_certificate(**kwargs)
  1. See GetSigningCertificateRequestTypeDef

get_ui_customization#

Given a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any.

Type annotations and code completion for boto3.client("cognito-idp").get_ui_customization method. boto3 documentation

# get_ui_customization method definition

def get_ui_customization(
    self,
    *,
    UserPoolId: str,
    ClientId: str = ...,
) -> GetUICustomizationResponseTypeDef:  # (1)
    ...
  1. See GetUICustomizationResponseTypeDef
# get_ui_customization method usage example with argument unpacking

kwargs: GetUICustomizationRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.get_ui_customization(**kwargs)
  1. See GetUICustomizationRequestTypeDef

get_user#

Gets user attributes and and MFA settings for the currently signed-in user.

Type annotations and code completion for boto3.client("cognito-idp").get_user method. boto3 documentation

# get_user method definition

def get_user(
    self,
    *,
    AccessToken: str,
) -> GetUserResponseTypeDef:  # (1)
    ...
  1. See GetUserResponseTypeDef
# get_user method usage example with argument unpacking

kwargs: GetUserRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

parent.get_user(**kwargs)
  1. See GetUserRequestTypeDef

get_user_attribute_verification_code#

Given an attribute name, sends a user attribute verification code for the specified attribute name to the currently signed-in user.

Type annotations and code completion for boto3.client("cognito-idp").get_user_attribute_verification_code method. boto3 documentation

# get_user_attribute_verification_code method definition

def get_user_attribute_verification_code(
    self,
    *,
    AccessToken: str,
    AttributeName: str,
    ClientMetadata: Mapping[str, str] = ...,
) -> GetUserAttributeVerificationCodeResponseTypeDef:  # (1)
    ...
  1. See GetUserAttributeVerificationCodeResponseTypeDef
# get_user_attribute_verification_code method usage example with argument unpacking

kwargs: GetUserAttributeVerificationCodeRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "AttributeName": ...,
}

parent.get_user_attribute_verification_code(**kwargs)
  1. See GetUserAttributeVerificationCodeRequestTypeDef

get_user_auth_factors#

Lists the authentication options for the currently signed-in user.

Type annotations and code completion for boto3.client("cognito-idp").get_user_auth_factors method. boto3 documentation

# get_user_auth_factors method definition

def get_user_auth_factors(
    self,
    *,
    AccessToken: str,
) -> GetUserAuthFactorsResponseTypeDef:  # (1)
    ...
  1. See GetUserAuthFactorsResponseTypeDef
# get_user_auth_factors method usage example with argument unpacking

kwargs: GetUserAuthFactorsRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

parent.get_user_auth_factors(**kwargs)
  1. See GetUserAuthFactorsRequestTypeDef

get_user_pool_mfa_config#

Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators and for multi-factor authentication (MFA).

Type annotations and code completion for boto3.client("cognito-idp").get_user_pool_mfa_config method. boto3 documentation

# get_user_pool_mfa_config method definition

def get_user_pool_mfa_config(
    self,
    *,
    UserPoolId: str,
) -> GetUserPoolMfaConfigResponseTypeDef:  # (1)
    ...
  1. See GetUserPoolMfaConfigResponseTypeDef
# get_user_pool_mfa_config method usage example with argument unpacking

kwargs: GetUserPoolMfaConfigRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.get_user_pool_mfa_config(**kwargs)
  1. See GetUserPoolMfaConfigRequestTypeDef

global_sign_out#

Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.

Type annotations and code completion for boto3.client("cognito-idp").global_sign_out method. boto3 documentation

# global_sign_out method definition

def global_sign_out(
    self,
    *,
    AccessToken: str,
) -> Dict[str, Any]:
    ...
# global_sign_out method usage example with argument unpacking

kwargs: GlobalSignOutRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

parent.global_sign_out(**kwargs)
  1. See GlobalSignOutRequestTypeDef

initiate_auth#

Declares an authentication flow and initiates sign-in for a user in the Amazon Cognito user directory.

Type annotations and code completion for boto3.client("cognito-idp").initiate_auth method. boto3 documentation

# initiate_auth method definition

def initiate_auth(
    self,
    *,
    AuthFlow: AuthFlowTypeType,  # (1)
    ClientId: str,
    AuthParameters: Mapping[str, str] = ...,
    ClientMetadata: Mapping[str, str] = ...,
    AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ...,  # (2)
    UserContextData: UserContextDataTypeTypeDef = ...,  # (3)
    Session: str = ...,
) -> InitiateAuthResponseTypeDef:  # (4)
    ...
  1. See AuthFlowTypeType
  2. See AnalyticsMetadataTypeTypeDef
  3. See UserContextDataTypeTypeDef
  4. See InitiateAuthResponseTypeDef
# initiate_auth method usage example with argument unpacking

kwargs: InitiateAuthRequestTypeDef = {  # (1)
    "AuthFlow": ...,
    "ClientId": ...,
}

parent.initiate_auth(**kwargs)
  1. See InitiateAuthRequestTypeDef

list_devices#

Lists the devices that Amazon Cognito has registered to the currently signed-in user.

Type annotations and code completion for boto3.client("cognito-idp").list_devices method. boto3 documentation

# list_devices method definition

def list_devices(
    self,
    *,
    AccessToken: str,
    Limit: int = ...,
    PaginationToken: str = ...,
) -> ListDevicesResponseTypeDef:  # (1)
    ...
  1. See ListDevicesResponseTypeDef
# list_devices method usage example with argument unpacking

kwargs: ListDevicesRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

parent.list_devices(**kwargs)
  1. See ListDevicesRequestTypeDef

list_groups#

Given a user pool ID, returns user pool groups and their details.

Type annotations and code completion for boto3.client("cognito-idp").list_groups method. boto3 documentation

# list_groups method definition

def list_groups(
    self,
    *,
    UserPoolId: str,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListGroupsResponseTypeDef:  # (1)
    ...
  1. See ListGroupsResponseTypeDef
# list_groups method usage example with argument unpacking

kwargs: ListGroupsRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.list_groups(**kwargs)
  1. See ListGroupsRequestTypeDef

list_identity_providers#

Given a user pool ID, returns information about configured identity providers (IdPs).

Type annotations and code completion for boto3.client("cognito-idp").list_identity_providers method. boto3 documentation

# list_identity_providers method definition

def list_identity_providers(
    self,
    *,
    UserPoolId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListIdentityProvidersResponseTypeDef:  # (1)
    ...
  1. See ListIdentityProvidersResponseTypeDef
# list_identity_providers method usage example with argument unpacking

kwargs: ListIdentityProvidersRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.list_identity_providers(**kwargs)
  1. See ListIdentityProvidersRequestTypeDef

list_resource_servers#

Given a user pool ID, returns all resource servers and their details.

Type annotations and code completion for boto3.client("cognito-idp").list_resource_servers method. boto3 documentation

# list_resource_servers method definition

def list_resource_servers(
    self,
    *,
    UserPoolId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListResourceServersResponseTypeDef:  # (1)
    ...
  1. See ListResourceServersResponseTypeDef
# list_resource_servers method usage example with argument unpacking

kwargs: ListResourceServersRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.list_resource_servers(**kwargs)
  1. See ListResourceServersRequestTypeDef

list_tags_for_resource#

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

Type annotations and code completion for boto3.client("cognito-idp").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

list_user_import_jobs#

Given a user pool ID, returns user import jobs and their details.

Type annotations and code completion for boto3.client("cognito-idp").list_user_import_jobs method. boto3 documentation

# list_user_import_jobs method definition

def list_user_import_jobs(
    self,
    *,
    UserPoolId: str,
    MaxResults: int,
    PaginationToken: str = ...,
) -> ListUserImportJobsResponseTypeDef:  # (1)
    ...
  1. See ListUserImportJobsResponseTypeDef
# list_user_import_jobs method usage example with argument unpacking

kwargs: ListUserImportJobsRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "MaxResults": ...,
}

parent.list_user_import_jobs(**kwargs)
  1. See ListUserImportJobsRequestTypeDef

list_user_pool_clients#

Given a user pool ID, lists app clients.

Type annotations and code completion for boto3.client("cognito-idp").list_user_pool_clients method. boto3 documentation

# list_user_pool_clients method definition

def list_user_pool_clients(
    self,
    *,
    UserPoolId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListUserPoolClientsResponseTypeDef:  # (1)
    ...
  1. See ListUserPoolClientsResponseTypeDef
# list_user_pool_clients method usage example with argument unpacking

kwargs: ListUserPoolClientsRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.list_user_pool_clients(**kwargs)
  1. See ListUserPoolClientsRequestTypeDef

list_user_pools#

Lists user pools and their details in the current Amazon Web Services account.

Type annotations and code completion for boto3.client("cognito-idp").list_user_pools method. boto3 documentation

# list_user_pools method definition

def list_user_pools(
    self,
    *,
    MaxResults: int,
    NextToken: str = ...,
) -> ListUserPoolsResponseTypeDef:  # (1)
    ...
  1. See ListUserPoolsResponseTypeDef
# list_user_pools method usage example with argument unpacking

kwargs: ListUserPoolsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_user_pools(**kwargs)
  1. See ListUserPoolsRequestTypeDef

list_users#

Given a user pool ID, returns a list of users and their basic details in a user pool.

Type annotations and code completion for boto3.client("cognito-idp").list_users method. boto3 documentation

# list_users method definition

def list_users(
    self,
    *,
    UserPoolId: str,
    AttributesToGet: Sequence[str] = ...,
    Limit: int = ...,
    PaginationToken: str = ...,
    Filter: str = ...,
) -> ListUsersResponseTypeDef:  # (1)
    ...
  1. See ListUsersResponseTypeDef
# list_users method usage example with argument unpacking

kwargs: ListUsersRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.list_users(**kwargs)
  1. See ListUsersRequestTypeDef

list_users_in_group#

Given a user pool ID and a group name, returns a list of users in the group.

Type annotations and code completion for boto3.client("cognito-idp").list_users_in_group method. boto3 documentation

# list_users_in_group method definition

def list_users_in_group(
    self,
    *,
    UserPoolId: str,
    GroupName: str,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListUsersInGroupResponseTypeDef:  # (1)
    ...
  1. See ListUsersInGroupResponseTypeDef
# list_users_in_group method usage example with argument unpacking

kwargs: ListUsersInGroupRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "GroupName": ...,
}

parent.list_users_in_group(**kwargs)
  1. See ListUsersInGroupRequestTypeDef

list_web_authn_credentials#

Generates a list of the currently signed-in user's registered passkey, or WebAuthn, credentials.

Type annotations and code completion for boto3.client("cognito-idp").list_web_authn_credentials method. boto3 documentation

# list_web_authn_credentials method definition

def list_web_authn_credentials(
    self,
    *,
    AccessToken: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWebAuthnCredentialsResponseTypeDef:  # (1)
    ...
  1. See ListWebAuthnCredentialsResponseTypeDef
# list_web_authn_credentials method usage example with argument unpacking

kwargs: ListWebAuthnCredentialsRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

parent.list_web_authn_credentials(**kwargs)
  1. See ListWebAuthnCredentialsRequestTypeDef

resend_confirmation_code#

Resends the code that confirms a new account for a user who has signed up in your user pool.

Type annotations and code completion for boto3.client("cognito-idp").resend_confirmation_code method. boto3 documentation

# resend_confirmation_code method definition

def resend_confirmation_code(
    self,
    *,
    ClientId: str,
    Username: str,
    SecretHash: str = ...,
    UserContextData: UserContextDataTypeTypeDef = ...,  # (1)
    AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ...,  # (2)
    ClientMetadata: Mapping[str, str] = ...,
) -> ResendConfirmationCodeResponseTypeDef:  # (3)
    ...
  1. See UserContextDataTypeTypeDef
  2. See AnalyticsMetadataTypeTypeDef
  3. See ResendConfirmationCodeResponseTypeDef
# resend_confirmation_code method usage example with argument unpacking

kwargs: ResendConfirmationCodeRequestTypeDef = {  # (1)
    "ClientId": ...,
    "Username": ...,
}

parent.resend_confirmation_code(**kwargs)
  1. See ResendConfirmationCodeRequestTypeDef

respond_to_auth_challenge#

Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge.

Type annotations and code completion for boto3.client("cognito-idp").respond_to_auth_challenge method. boto3 documentation

# respond_to_auth_challenge method definition

def respond_to_auth_challenge(
    self,
    *,
    ClientId: str,
    ChallengeName: ChallengeNameTypeType,  # (1)
    Session: str = ...,
    ChallengeResponses: Mapping[str, str] = ...,
    AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ...,  # (2)
    UserContextData: UserContextDataTypeTypeDef = ...,  # (3)
    ClientMetadata: Mapping[str, str] = ...,
) -> RespondToAuthChallengeResponseTypeDef:  # (4)
    ...
  1. See ChallengeNameTypeType
  2. See AnalyticsMetadataTypeTypeDef
  3. See UserContextDataTypeTypeDef
  4. See RespondToAuthChallengeResponseTypeDef
# respond_to_auth_challenge method usage example with argument unpacking

kwargs: RespondToAuthChallengeRequestTypeDef = {  # (1)
    "ClientId": ...,
    "ChallengeName": ...,
}

parent.respond_to_auth_challenge(**kwargs)
  1. See RespondToAuthChallengeRequestTypeDef

revoke_token#

Revokes all of the access tokens generated by, and at the same time as, the specified refresh token.

Type annotations and code completion for boto3.client("cognito-idp").revoke_token method. boto3 documentation

# revoke_token method definition

def revoke_token(
    self,
    *,
    Token: str,
    ClientId: str,
    ClientSecret: str = ...,
) -> Dict[str, Any]:
    ...
# revoke_token method usage example with argument unpacking

kwargs: RevokeTokenRequestTypeDef = {  # (1)
    "Token": ...,
    "ClientId": ...,
}

parent.revoke_token(**kwargs)
  1. See RevokeTokenRequestTypeDef

set_log_delivery_configuration#

Sets up or modifies the logging configuration of a user pool.

Type annotations and code completion for boto3.client("cognito-idp").set_log_delivery_configuration method. boto3 documentation

# set_log_delivery_configuration method definition

def set_log_delivery_configuration(
    self,
    *,
    UserPoolId: str,
    LogConfigurations: Sequence[LogConfigurationTypeTypeDef],  # (1)
) -> SetLogDeliveryConfigurationResponseTypeDef:  # (2)
    ...
  1. See Sequence[LogConfigurationTypeTypeDef]
  2. See SetLogDeliveryConfigurationResponseTypeDef
# set_log_delivery_configuration method usage example with argument unpacking

kwargs: SetLogDeliveryConfigurationRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "LogConfigurations": ...,
}

parent.set_log_delivery_configuration(**kwargs)
  1. See SetLogDeliveryConfigurationRequestTypeDef

set_risk_configuration#

Configures threat protection for a user pool or app client.

Type annotations and code completion for boto3.client("cognito-idp").set_risk_configuration method. boto3 documentation

# set_risk_configuration method definition

def set_risk_configuration(
    self,
    *,
    UserPoolId: str,
    ClientId: str = ...,
    CompromisedCredentialsRiskConfiguration: CompromisedCredentialsRiskConfigurationTypeUnionTypeDef = ...,  # (1)
    AccountTakeoverRiskConfiguration: AccountTakeoverRiskConfigurationTypeTypeDef = ...,  # (2)
    RiskExceptionConfiguration: RiskExceptionConfigurationTypeUnionTypeDef = ...,  # (3)
) -> SetRiskConfigurationResponseTypeDef:  # (4)
    ...
  1. See CompromisedCredentialsRiskConfigurationTypeUnionTypeDef
  2. See AccountTakeoverRiskConfigurationTypeTypeDef
  3. See RiskExceptionConfigurationTypeUnionTypeDef
  4. See SetRiskConfigurationResponseTypeDef
# set_risk_configuration method usage example with argument unpacking

kwargs: SetRiskConfigurationRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.set_risk_configuration(**kwargs)
  1. See SetRiskConfigurationRequestTypeDef

set_ui_customization#

Configures UI branding settings for domains with the hosted UI (classic) branding version.

Type annotations and code completion for boto3.client("cognito-idp").set_ui_customization method. boto3 documentation

# set_ui_customization method definition

def set_ui_customization(
    self,
    *,
    UserPoolId: str,
    ClientId: str = ...,
    CSS: str = ...,
    ImageFile: BlobTypeDef = ...,
) -> SetUICustomizationResponseTypeDef:  # (1)
    ...
  1. See SetUICustomizationResponseTypeDef
# set_ui_customization method usage example with argument unpacking

kwargs: SetUICustomizationRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.set_ui_customization(**kwargs)
  1. See SetUICustomizationRequestTypeDef

set_user_mfa_preference#

Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred.

Type annotations and code completion for boto3.client("cognito-idp").set_user_mfa_preference method. boto3 documentation

# set_user_mfa_preference method definition

def set_user_mfa_preference(
    self,
    *,
    AccessToken: str,
    SMSMfaSettings: SMSMfaSettingsTypeTypeDef = ...,  # (1)
    SoftwareTokenMfaSettings: SoftwareTokenMfaSettingsTypeTypeDef = ...,  # (2)
    EmailMfaSettings: EmailMfaSettingsTypeTypeDef = ...,  # (3)
) -> Dict[str, Any]:
    ...
  1. See SMSMfaSettingsTypeTypeDef
  2. See SoftwareTokenMfaSettingsTypeTypeDef
  3. See EmailMfaSettingsTypeTypeDef
# set_user_mfa_preference method usage example with argument unpacking

kwargs: SetUserMFAPreferenceRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

parent.set_user_mfa_preference(**kwargs)
  1. See SetUserMFAPreferenceRequestTypeDef

set_user_pool_mfa_config#

Sets user pool multi-factor authentication (MFA) and passkey configuration.

Type annotations and code completion for boto3.client("cognito-idp").set_user_pool_mfa_config method. boto3 documentation

# set_user_pool_mfa_config method definition

def set_user_pool_mfa_config(
    self,
    *,
    UserPoolId: str,
    SmsMfaConfiguration: SmsMfaConfigTypeTypeDef = ...,  # (1)
    SoftwareTokenMfaConfiguration: SoftwareTokenMfaConfigTypeTypeDef = ...,  # (2)
    EmailMfaConfiguration: EmailMfaConfigTypeTypeDef = ...,  # (3)
    MfaConfiguration: UserPoolMfaTypeType = ...,  # (4)
    WebAuthnConfiguration: WebAuthnConfigurationTypeTypeDef = ...,  # (5)
) -> SetUserPoolMfaConfigResponseTypeDef:  # (6)
    ...
  1. See SmsMfaConfigTypeTypeDef
  2. See SoftwareTokenMfaConfigTypeTypeDef
  3. See EmailMfaConfigTypeTypeDef
  4. See UserPoolMfaTypeType
  5. See WebAuthnConfigurationTypeTypeDef
  6. See SetUserPoolMfaConfigResponseTypeDef
# set_user_pool_mfa_config method usage example with argument unpacking

kwargs: SetUserPoolMfaConfigRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.set_user_pool_mfa_config(**kwargs)
  1. See SetUserPoolMfaConfigRequestTypeDef

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").set_user_settings method. boto3 documentation

# set_user_settings method definition

def set_user_settings(
    self,
    *,
    AccessToken: str,
    MFAOptions: Sequence[MFAOptionTypeTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See Sequence[MFAOptionTypeTypeDef]
# set_user_settings method usage example with argument unpacking

kwargs: SetUserSettingsRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "MFAOptions": ...,
}

parent.set_user_settings(**kwargs)
  1. See SetUserSettingsRequestTypeDef

sign_up#

Registers a user with an app client and requests a user name, password, and user attributes in the user pool.

Type annotations and code completion for boto3.client("cognito-idp").sign_up method. boto3 documentation

# sign_up method definition

def sign_up(
    self,
    *,
    ClientId: str,
    Username: str,
    SecretHash: str = ...,
    Password: str = ...,
    UserAttributes: Sequence[AttributeTypeTypeDef] = ...,  # (1)
    ValidationData: Sequence[AttributeTypeTypeDef] = ...,  # (1)
    AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ...,  # (3)
    UserContextData: UserContextDataTypeTypeDef = ...,  # (4)
    ClientMetadata: Mapping[str, str] = ...,
) -> SignUpResponseTypeDef:  # (5)
    ...
  1. See Sequence[AttributeTypeTypeDef]
  2. See Sequence[AttributeTypeTypeDef]
  3. See AnalyticsMetadataTypeTypeDef
  4. See UserContextDataTypeTypeDef
  5. See SignUpResponseTypeDef
# sign_up method usage example with argument unpacking

kwargs: SignUpRequestTypeDef = {  # (1)
    "ClientId": ...,
    "Username": ...,
}

parent.sign_up(**kwargs)
  1. See SignUpRequestTypeDef

start_user_import_job#

Instructs your user pool to start importing users from a CSV file that contains their usernames and attributes.

Type annotations and code completion for boto3.client("cognito-idp").start_user_import_job method. boto3 documentation

# start_user_import_job method definition

def start_user_import_job(
    self,
    *,
    UserPoolId: str,
    JobId: str,
) -> StartUserImportJobResponseTypeDef:  # (1)
    ...
  1. See StartUserImportJobResponseTypeDef
# start_user_import_job method usage example with argument unpacking

kwargs: StartUserImportJobRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "JobId": ...,
}

parent.start_user_import_job(**kwargs)
  1. See StartUserImportJobRequestTypeDef

start_web_authn_registration#

Requests credential creation options from your user pool for the currently signed-in user.

Type annotations and code completion for boto3.client("cognito-idp").start_web_authn_registration method. boto3 documentation

# start_web_authn_registration method definition

def start_web_authn_registration(
    self,
    *,
    AccessToken: str,
) -> StartWebAuthnRegistrationResponseTypeDef:  # (1)
    ...
  1. See StartWebAuthnRegistrationResponseTypeDef
# start_web_authn_registration method usage example with argument unpacking

kwargs: StartWebAuthnRegistrationRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

parent.start_web_authn_registration(**kwargs)
  1. See StartWebAuthnRegistrationRequestTypeDef

stop_user_import_job#

Instructs your user pool to stop a running job that's importing users from a CSV file that contains their usernames and attributes.

Type annotations and code completion for boto3.client("cognito-idp").stop_user_import_job method. boto3 documentation

# stop_user_import_job method definition

def stop_user_import_job(
    self,
    *,
    UserPoolId: str,
    JobId: str,
) -> StopUserImportJobResponseTypeDef:  # (1)
    ...
  1. See StopUserImportJobResponseTypeDef
# stop_user_import_job method usage example with argument unpacking

kwargs: StopUserImportJobRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "JobId": ...,
}

parent.stop_user_import_job(**kwargs)
  1. See StopUserImportJobRequestTypeDef

tag_resource#

Assigns a set of tags to an Amazon Cognito user pool.

Type annotations and code completion for boto3.client("cognito-idp").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Given tag IDs that you previously assigned to a user pool, removes them.

Type annotations and code completion for boto3.client("cognito-idp").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_auth_event_feedback#

Provides the feedback for an authentication event generated by threat protection features.

Type annotations and code completion for boto3.client("cognito-idp").update_auth_event_feedback method. boto3 documentation

# update_auth_event_feedback method definition

def update_auth_event_feedback(
    self,
    *,
    UserPoolId: str,
    Username: str,
    EventId: str,
    FeedbackToken: str,
    FeedbackValue: FeedbackValueTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See FeedbackValueTypeType
# update_auth_event_feedback method usage example with argument unpacking

kwargs: UpdateAuthEventFeedbackRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "EventId": ...,
    "FeedbackToken": ...,
    "FeedbackValue": ...,
}

parent.update_auth_event_feedback(**kwargs)
  1. See UpdateAuthEventFeedbackRequestTypeDef

update_device_status#

Updates the status of a the currently signed-in user's device so that it is marked as remembered or not remembered for the purpose of device authentication.

Type annotations and code completion for boto3.client("cognito-idp").update_device_status method. boto3 documentation

# update_device_status method definition

def update_device_status(
    self,
    *,
    AccessToken: str,
    DeviceKey: str,
    DeviceRememberedStatus: DeviceRememberedStatusTypeType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See DeviceRememberedStatusTypeType
# update_device_status method usage example with argument unpacking

kwargs: UpdateDeviceStatusRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "DeviceKey": ...,
}

parent.update_device_status(**kwargs)
  1. See UpdateDeviceStatusRequestTypeDef

update_group#

Given the name of a user pool group, updates any of the properties for precedence, IAM role, or description.

Type annotations and code completion for boto3.client("cognito-idp").update_group method. boto3 documentation

# update_group method definition

def update_group(
    self,
    *,
    GroupName: str,
    UserPoolId: str,
    Description: str = ...,
    RoleArn: str = ...,
    Precedence: int = ...,
) -> UpdateGroupResponseTypeDef:  # (1)
    ...
  1. See UpdateGroupResponseTypeDef
# update_group method usage example with argument unpacking

kwargs: UpdateGroupRequestTypeDef = {  # (1)
    "GroupName": ...,
    "UserPoolId": ...,
}

parent.update_group(**kwargs)
  1. See UpdateGroupRequestTypeDef

update_identity_provider#

Modifies the configuration and trust relationship between a third-party identity provider (IdP) and a user pool.

Type annotations and code completion for boto3.client("cognito-idp").update_identity_provider method. boto3 documentation

# update_identity_provider method definition

def update_identity_provider(
    self,
    *,
    UserPoolId: str,
    ProviderName: str,
    ProviderDetails: Mapping[str, str] = ...,
    AttributeMapping: Mapping[str, str] = ...,
    IdpIdentifiers: Sequence[str] = ...,
) -> UpdateIdentityProviderResponseTypeDef:  # (1)
    ...
  1. See UpdateIdentityProviderResponseTypeDef
# update_identity_provider method usage example with argument unpacking

kwargs: UpdateIdentityProviderRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ProviderName": ...,
}

parent.update_identity_provider(**kwargs)
  1. See UpdateIdentityProviderRequestTypeDef

update_managed_login_branding#

Configures the branding settings for a user pool style.

Type annotations and code completion for boto3.client("cognito-idp").update_managed_login_branding method. boto3 documentation

# update_managed_login_branding method definition

def update_managed_login_branding(
    self,
    *,
    UserPoolId: str = ...,
    ManagedLoginBrandingId: str = ...,
    UseCognitoProvidedValues: bool = ...,
    Settings: Mapping[str, Any] = ...,
    Assets: Sequence[AssetTypeUnionTypeDef] = ...,  # (1)
) -> UpdateManagedLoginBrandingResponseTypeDef:  # (2)
    ...
  1. See Sequence[AssetTypeUnionTypeDef]
  2. See UpdateManagedLoginBrandingResponseTypeDef
# update_managed_login_branding method usage example with argument unpacking

kwargs: UpdateManagedLoginBrandingRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.update_managed_login_branding(**kwargs)
  1. See UpdateManagedLoginBrandingRequestTypeDef

update_resource_server#

Updates the name and scopes of a resource server.

Type annotations and code completion for boto3.client("cognito-idp").update_resource_server method. boto3 documentation

# update_resource_server method definition

def update_resource_server(
    self,
    *,
    UserPoolId: str,
    Identifier: str,
    Name: str,
    Scopes: Sequence[ResourceServerScopeTypeTypeDef] = ...,  # (1)
) -> UpdateResourceServerResponseTypeDef:  # (2)
    ...
  1. See Sequence[ResourceServerScopeTypeTypeDef]
  2. See UpdateResourceServerResponseTypeDef
# update_resource_server method usage example with argument unpacking

kwargs: UpdateResourceServerRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Identifier": ...,
    "Name": ...,
}

parent.update_resource_server(**kwargs)
  1. See UpdateResourceServerRequestTypeDef

update_user_attributes#

Updates the currently signed-in user's attributes.

Type annotations and code completion for boto3.client("cognito-idp").update_user_attributes method. boto3 documentation

# update_user_attributes method definition

def update_user_attributes(
    self,
    *,
    UserAttributes: Sequence[AttributeTypeTypeDef],  # (1)
    AccessToken: str,
    ClientMetadata: Mapping[str, str] = ...,
) -> UpdateUserAttributesResponseTypeDef:  # (2)
    ...
  1. See Sequence[AttributeTypeTypeDef]
  2. See UpdateUserAttributesResponseTypeDef
# update_user_attributes method usage example with argument unpacking

kwargs: UpdateUserAttributesRequestTypeDef = {  # (1)
    "UserAttributes": ...,
    "AccessToken": ...,
}

parent.update_user_attributes(**kwargs)
  1. See UpdateUserAttributesRequestTypeDef

update_user_pool#

Updates the configuration of a user pool.

Type annotations and code completion for boto3.client("cognito-idp").update_user_pool method. boto3 documentation

# update_user_pool method definition

def update_user_pool(
    self,
    *,
    UserPoolId: str,
    Policies: UserPoolPolicyTypeUnionTypeDef = ...,  # (1)
    DeletionProtection: DeletionProtectionTypeType = ...,  # (2)
    LambdaConfig: LambdaConfigTypeTypeDef = ...,  # (3)
    AutoVerifiedAttributes: Sequence[VerifiedAttributeTypeType] = ...,  # (4)
    SmsVerificationMessage: str = ...,
    EmailVerificationMessage: str = ...,
    EmailVerificationSubject: str = ...,
    VerificationMessageTemplate: VerificationMessageTemplateTypeTypeDef = ...,  # (5)
    SmsAuthenticationMessage: str = ...,
    UserAttributeUpdateSettings: UserAttributeUpdateSettingsTypeUnionTypeDef = ...,  # (6)
    MfaConfiguration: UserPoolMfaTypeType = ...,  # (7)
    DeviceConfiguration: DeviceConfigurationTypeTypeDef = ...,  # (8)
    EmailConfiguration: EmailConfigurationTypeTypeDef = ...,  # (9)
    SmsConfiguration: SmsConfigurationTypeTypeDef = ...,  # (10)
    UserPoolTags: Mapping[str, str] = ...,
    AdminCreateUserConfig: AdminCreateUserConfigTypeTypeDef = ...,  # (11)
    UserPoolAddOns: UserPoolAddOnsTypeTypeDef = ...,  # (12)
    AccountRecoverySetting: AccountRecoverySettingTypeUnionTypeDef = ...,  # (13)
    PoolName: str = ...,
    UserPoolTier: UserPoolTierTypeType = ...,  # (14)
) -> Dict[str, Any]:
    ...
  1. See UserPoolPolicyTypeUnionTypeDef
  2. See DeletionProtectionTypeType
  3. See LambdaConfigTypeTypeDef
  4. See Sequence[VerifiedAttributeTypeType]
  5. See VerificationMessageTemplateTypeTypeDef
  6. See UserAttributeUpdateSettingsTypeUnionTypeDef
  7. See UserPoolMfaTypeType
  8. See DeviceConfigurationTypeTypeDef
  9. See EmailConfigurationTypeTypeDef
  10. See SmsConfigurationTypeTypeDef
  11. See AdminCreateUserConfigTypeTypeDef
  12. See UserPoolAddOnsTypeTypeDef
  13. See AccountRecoverySettingTypeUnionTypeDef
  14. See UserPoolTierTypeType
# update_user_pool method usage example with argument unpacking

kwargs: UpdateUserPoolRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.update_user_pool(**kwargs)
  1. See UpdateUserPoolRequestTypeDef

update_user_pool_client#

Given a user pool app client ID, updates the configuration.

Type annotations and code completion for boto3.client("cognito-idp").update_user_pool_client method. boto3 documentation

# update_user_pool_client method definition

def update_user_pool_client(
    self,
    *,
    UserPoolId: str,
    ClientId: str,
    ClientName: str = ...,
    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 = ...,
) -> UpdateUserPoolClientResponseTypeDef:  # (6)
    ...
  1. See TokenValidityUnitsTypeTypeDef
  2. See Sequence[ExplicitAuthFlowsTypeType]
  3. See Sequence[OAuthFlowTypeType]
  4. See AnalyticsConfigurationTypeTypeDef
  5. See PreventUserExistenceErrorTypesType
  6. See UpdateUserPoolClientResponseTypeDef
# update_user_pool_client method usage example with argument unpacking

kwargs: UpdateUserPoolClientRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
}

parent.update_user_pool_client(**kwargs)
  1. See UpdateUserPoolClientRequestTypeDef

update_user_pool_domain#

A user pool domain hosts managed login, an authorization server and web server for authentication in your application.

Type annotations and code completion for boto3.client("cognito-idp").update_user_pool_domain method. boto3 documentation

# update_user_pool_domain method definition

def update_user_pool_domain(
    self,
    *,
    Domain: str,
    UserPoolId: str,
    ManagedLoginVersion: int = ...,
    CustomDomainConfig: CustomDomainConfigTypeTypeDef = ...,  # (1)
) -> UpdateUserPoolDomainResponseTypeDef:  # (2)
    ...
  1. See CustomDomainConfigTypeTypeDef
  2. See UpdateUserPoolDomainResponseTypeDef
# update_user_pool_domain method usage example with argument unpacking

kwargs: UpdateUserPoolDomainRequestTypeDef = {  # (1)
    "Domain": ...,
    "UserPoolId": ...,
}

parent.update_user_pool_domain(**kwargs)
  1. See UpdateUserPoolDomainRequestTypeDef

verify_software_token#

Registers the current user's time-based one-time password (TOTP) authenticator with a code generated in their authenticator app from a private key that's supplied by your user pool.

Type annotations and code completion for boto3.client("cognito-idp").verify_software_token method. boto3 documentation

# verify_software_token method definition

def verify_software_token(
    self,
    *,
    UserCode: str,
    AccessToken: str = ...,
    Session: str = ...,
    FriendlyDeviceName: str = ...,
) -> VerifySoftwareTokenResponseTypeDef:  # (1)
    ...
  1. See VerifySoftwareTokenResponseTypeDef
# verify_software_token method usage example with argument unpacking

kwargs: VerifySoftwareTokenRequestTypeDef = {  # (1)
    "UserCode": ...,
}

parent.verify_software_token(**kwargs)
  1. See VerifySoftwareTokenRequestTypeDef

verify_user_attribute#

Submits a verification code for a signed-in user who has added or changed a value of an auto-verified attribute.

Type annotations and code completion for boto3.client("cognito-idp").verify_user_attribute method. boto3 documentation

# verify_user_attribute method definition

def verify_user_attribute(
    self,
    *,
    AccessToken: str,
    AttributeName: str,
    Code: str,
) -> Dict[str, Any]:
    ...
# verify_user_attribute method usage example with argument unpacking

kwargs: VerifyUserAttributeRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "AttributeName": ...,
    "Code": ...,
}

parent.verify_user_attribute(**kwargs)
  1. See VerifyUserAttributeRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("cognito-idp").get_paginator method with overloads.