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

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.

Usage example
client = boto3.client("cognito-idp")

try:
    do_something(client)
except (
    client.AliasExistsException,
    client.ClientError,
    client.CodeDeliveryFailureException,
    client.CodeMismatchException,
    client.ConcurrentModificationException,
    client.DuplicateProviderException,
    client.EnableSoftwareTokenMFAException,
    client.ExpiredCodeException,
    client.ForbiddenException,
    client.GroupExistsException,
    client.InternalErrorException,
    client.InvalidEmailRoleAccessPolicyException,
    client.InvalidLambdaResponseException,
    client.InvalidOAuthFlowException,
    client.InvalidParameterException,
    client.InvalidPasswordException,
    client.InvalidSmsRoleAccessPolicyException,
    client.InvalidSmsRoleTrustRelationshipException,
    client.InvalidUserPoolConfigurationException,
    client.LimitExceededException,
    client.MFAMethodNotFoundException,
    client.NotAuthorizedException,
    client.PasswordResetRequiredException,
    client.PreconditionNotMetException,
    client.ResourceNotFoundException,
    client.ScopeDoesNotExistException,
    client.SoftwareTokenMFANotFoundException,
    client.TooManyFailedAttemptsException,
    client.TooManyRequestsException,
    client.UnauthorizedException,
    client.UnexpectedLambdaException,
    client.UnsupportedIdentityProviderException,
    client.UnsupportedOperationException,
    client.UnsupportedTokenTypeException,
    client.UnsupportedUserStateException,
    client.UserImportInProgressException,
    client.UserLambdaValidationException,
    client.UserNotConfirmedException,
    client.UserNotFoundException,
    client.UserPoolAddOnNotEnabledException,
    client.UserPoolTaggingException,
    client.UsernameExistsException,
) as e:
    print(e)
Type checking example
from mypy_boto3_cognito_idp.client import Exceptions

def handle_error(exc: Exceptions.AliasExistsException) -> None:
    ...

Methods

add_custom_attributes

Adds additional user attributes to the user pool schema.

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

Method definition
def add_custom_attributes(
    self,
    *,
    UserPoolId: str,
    CustomAttributes: Sequence[SchemaAttributeTypeTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See SchemaAttributeTypeTypeDef
Usage example with kwargs
kwargs: AddCustomAttributesRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "CustomAttributes": ...,
}

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

admin_add_user_to_group

Adds the specified user to the specified group.

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

Method definition
def admin_add_user_to_group(
    self,
    *,
    UserPoolId: str,
    Username: str,
    GroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AdminAddUserToGroupRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "GroupName": ...,
}

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

admin_confirm_sign_up

Confirms user registration as an admin without using a confirmation code.

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

Method definition
def admin_confirm_sign_up(
    self,
    *,
    UserPoolId: str,
    Username: str,
    ClientMetadata: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AdminConfirmSignUpRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

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

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

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 AttributeTypeTypeDef
  2. See AttributeTypeTypeDef
  3. See MessageActionTypeType
  4. See DeliveryMediumTypeType
  5. See AdminCreateUserResponseTypeDef
Usage example with kwargs
kwargs: AdminCreateUserRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

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

admin_delete_user

Deletes a user as an administrator.

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

Method definition
def admin_delete_user(
    self,
    *,
    UserPoolId: str,
    Username: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AdminDeleteUserRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

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

admin_delete_user_attributes

Deletes the user attributes in a user pool as an administrator.

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

Method definition
def admin_delete_user_attributes(
    self,
    *,
    UserPoolId: str,
    Username: str,
    UserAttributeNames: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AdminDeleteUserAttributesRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "UserAttributeNames": ...,
}

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

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

Method definition
def admin_disable_provider_for_user(
    self,
    *,
    UserPoolId: str,
    User: ProviderUserIdentifierTypeTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ProviderUserIdentifierTypeTypeDef
Usage example with kwargs
kwargs: AdminDisableProviderForUserRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "User": ...,
}

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

admin_disable_user

Deactivates a user and revokes all access tokens for the user.

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

Method definition
def admin_disable_user(
    self,
    *,
    UserPoolId: str,
    Username: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AdminDisableUserRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

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

admin_enable_user

Enables the specified user as an administrator.

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

Method definition
def admin_enable_user(
    self,
    *,
    UserPoolId: str,
    Username: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AdminEnableUserRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

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

admin_forget_device

Forgets the device, as an administrator.

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

Method definition
def admin_forget_device(
    self,
    *,
    UserPoolId: str,
    Username: str,
    DeviceKey: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AdminForgetDeviceRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "DeviceKey": ...,
}

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

admin_get_device

Gets the device, as an administrator.

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

Method definition
def admin_get_device(
    self,
    *,
    DeviceKey: str,
    UserPoolId: str,
    Username: str,
) -> AdminGetDeviceResponseTypeDef:  # (1)
    ...
  1. See AdminGetDeviceResponseTypeDef
Usage example with kwargs
kwargs: AdminGetDeviceRequestRequestTypeDef = {  # (1)
    "DeviceKey": ...,
    "UserPoolId": ...,
    "Username": ...,
}

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

admin_get_user

Gets the specified user by user name in a user pool as an administrator.

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

Method definition
def admin_get_user(
    self,
    *,
    UserPoolId: str,
    Username: str,
) -> AdminGetUserResponseTypeDef:  # (1)
    ...
  1. See AdminGetUserResponseTypeDef
Usage example with kwargs
kwargs: AdminGetUserRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

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

admin_initiate_auth

Initiates the authentication flow, as an administrator.

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

Method definition
def admin_initiate_auth(
    self,
    *,
    UserPoolId: str,
    ClientId: str,
    AuthFlow: AuthFlowTypeType,  # (1)
    AuthParameters: Mapping[str, str] = ...,
    ClientMetadata: Mapping[str, str] = ...,
    AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ...,  # (2)
    ContextData: ContextDataTypeTypeDef = ...,  # (3)
) -> AdminInitiateAuthResponseTypeDef:  # (4)
    ...
  1. See AuthFlowTypeType
  2. See AnalyticsMetadataTypeTypeDef
  3. See ContextDataTypeTypeDef
  4. See AdminInitiateAuthResponseTypeDef
Usage example with kwargs
kwargs: AdminInitiateAuthRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
    "AuthFlow": ...,
}

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

Links an existing user account in a user pool ( DestinationUser ) to an identity from an external IdP ( SourceUser ) based on a specified attribute name and value from the external IdP.

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

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
Usage example with kwargs
kwargs: AdminLinkProviderForUserRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "DestinationUser": ...,
    "SourceUser": ...,
}

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

admin_list_devices

Lists devices, as an administrator.

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

Method definition
def admin_list_devices(
    self,
    *,
    UserPoolId: str,
    Username: str,
    Limit: int = ...,
    PaginationToken: str = ...,
) -> AdminListDevicesResponseTypeDef:  # (1)
    ...
  1. See AdminListDevicesResponseTypeDef
Usage example with kwargs
kwargs: AdminListDevicesRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

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

admin_list_groups_for_user

Lists the groups that the user belongs to.

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

Method definition
def admin_list_groups_for_user(
    self,
    *,
    Username: str,
    UserPoolId: str,
    Limit: int = ...,
    NextToken: str = ...,
) -> AdminListGroupsForUserResponseTypeDef:  # (1)
    ...
  1. See AdminListGroupsForUserResponseTypeDef
Usage example with kwargs
kwargs: AdminListGroupsForUserRequestRequestTypeDef = {  # (1)
    "Username": ...,
    "UserPoolId": ...,
}

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

admin_list_user_auth_events

A history of user activity and any risks detected as part of Amazon Cognito advanced security.

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

Method definition
def admin_list_user_auth_events(
    self,
    *,
    UserPoolId: str,
    Username: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> AdminListUserAuthEventsResponseTypeDef:  # (1)
    ...
  1. See AdminListUserAuthEventsResponseTypeDef
Usage example with kwargs
kwargs: AdminListUserAuthEventsRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

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

admin_remove_user_from_group

Removes the specified user from the specified group.

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

Method definition
def admin_remove_user_from_group(
    self,
    *,
    UserPoolId: str,
    Username: str,
    GroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AdminRemoveUserFromGroupRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "GroupName": ...,
}

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

admin_reset_user_password

Resets the specified user's password in a user pool as an administrator.

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

Method definition
def admin_reset_user_password(
    self,
    *,
    UserPoolId: str,
    Username: str,
    ClientMetadata: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AdminResetUserPasswordRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

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

admin_respond_to_auth_challenge

Responds to an authentication challenge, as an administrator.

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

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
Usage example with kwargs
kwargs: AdminRespondToAuthChallengeRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
    "ChallengeName": ...,
}

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

admin_set_user_mfa_preference

The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred.

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

Method definition
def admin_set_user_mfa_preference(
    self,
    *,
    Username: str,
    UserPoolId: str,
    SMSMfaSettings: SMSMfaSettingsTypeTypeDef = ...,  # (1)
    SoftwareTokenMfaSettings: SoftwareTokenMfaSettingsTypeTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See SMSMfaSettingsTypeTypeDef
  2. See SoftwareTokenMfaSettingsTypeTypeDef
Usage example with kwargs
kwargs: AdminSetUserMFAPreferenceRequestRequestTypeDef = {  # (1)
    "Username": ...,
    "UserPoolId": ...,
}

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

admin_set_user_password

Sets the specified user's password in a user pool as an administrator.

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

Method definition
def admin_set_user_password(
    self,
    *,
    UserPoolId: str,
    Username: str,
    Password: str,
    Permanent: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AdminSetUserPasswordRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "Password": ...,
}

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

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

Method definition
def admin_set_user_settings(
    self,
    *,
    UserPoolId: str,
    Username: str,
    MFAOptions: Sequence[MFAOptionTypeTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See MFAOptionTypeTypeDef
Usage example with kwargs
kwargs: AdminSetUserSettingsRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "MFAOptions": ...,
}

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

admin_update_auth_event_feedback

Provides feedback for an authentication event indicating if it was from a valid user.

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

Method definition
def admin_update_auth_event_feedback(
    self,
    *,
    UserPoolId: str,
    Username: str,
    EventId: str,
    FeedbackValue: FeedbackValueTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See FeedbackValueTypeType
Usage example with kwargs
kwargs: AdminUpdateAuthEventFeedbackRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "EventId": ...,
    "FeedbackValue": ...,
}

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

admin_update_device_status

Updates the device status as an administrator.

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

Method definition
def admin_update_device_status(
    self,
    *,
    UserPoolId: str,
    Username: str,
    DeviceKey: str,
    DeviceRememberedStatus: DeviceRememberedStatusTypeType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See DeviceRememberedStatusTypeType
Usage example with kwargs
kwargs: AdminUpdateDeviceStatusRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "DeviceKey": ...,
}

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

admin_update_user_attributes

Updates the specified user's attributes, including developer attributes, as an administrator.

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

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 AttributeTypeTypeDef
Usage example with kwargs
kwargs: AdminUpdateUserAttributesRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "UserAttributes": ...,
}

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

admin_user_global_sign_out

Signs out a user from all devices.

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

Method definition
def admin_user_global_sign_out(
    self,
    *,
    UserPoolId: str,
    Username: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AdminUserGlobalSignOutRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

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

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

Method definition
def associate_software_token(
    self,
    *,
    AccessToken: str = ...,
    Session: str = ...,
) -> AssociateSoftwareTokenResponseTypeDef:  # (1)
    ...
  1. See AssociateSoftwareTokenResponseTypeDef
Usage example with kwargs
kwargs: AssociateSoftwareTokenRequestRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

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

can_paginate

Check if an operation can be paginated.

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

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

change_password

Changes the password for a specified user in a user pool.

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

Method definition
def change_password(
    self,
    *,
    PreviousPassword: str,
    ProposedPassword: str,
    AccessToken: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: ChangePasswordRequestRequestTypeDef = {  # (1)
    "PreviousPassword": ...,
    "ProposedPassword": ...,
    "AccessToken": ...,
}

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

close

Closes underlying endpoint connections.

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

Method definition
def close(
    self,
) -> None:
    ...

confirm_device

Confirms tracking of the device.

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

Method definition
def confirm_device(
    self,
    *,
    AccessToken: str,
    DeviceKey: str,
    DeviceSecretVerifierConfig: DeviceSecretVerifierConfigTypeTypeDef = ...,  # (1)
    DeviceName: str = ...,
) -> ConfirmDeviceResponseTypeDef:  # (2)
    ...
  1. See DeviceSecretVerifierConfigTypeTypeDef
  2. See ConfirmDeviceResponseTypeDef
Usage example with kwargs
kwargs: ConfirmDeviceRequestRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "DeviceKey": ...,
}

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

confirm_forgot_password

Allows a user to enter a confirmation code to reset a forgotten password.

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

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
Usage example with kwargs
kwargs: ConfirmForgotPasswordRequestRequestTypeDef = {  # (1)
    "ClientId": ...,
    "Username": ...,
    "ConfirmationCode": ...,
    "Password": ...,
}

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

confirm_sign_up

Confirms registration of a new user.

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

Method definition
def confirm_sign_up(
    self,
    *,
    ClientId: str,
    Username: str,
    ConfirmationCode: str,
    SecretHash: str = ...,
    ForceAliasCreation: bool = ...,
    AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ...,  # (1)
    UserContextData: UserContextDataTypeTypeDef = ...,  # (2)
    ClientMetadata: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...
  1. See AnalyticsMetadataTypeTypeDef
  2. See UserContextDataTypeTypeDef
Usage example with kwargs
kwargs: ConfirmSignUpRequestRequestTypeDef = {  # (1)
    "ClientId": ...,
    "Username": ...,
    "ConfirmationCode": ...,
}

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

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

Method definition
def create_group(
    self,
    *,
    GroupName: str,
    UserPoolId: str,
    Description: str = ...,
    RoleArn: str = ...,
    Precedence: int = ...,
) -> CreateGroupResponseTypeDef:  # (1)
    ...
  1. See CreateGroupResponseTypeDef
Usage example with kwargs
kwargs: CreateGroupRequestRequestTypeDef = {  # (1)
    "GroupName": ...,
    "UserPoolId": ...,
}

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

create_identity_provider

Creates an IdP for a user pool.

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

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
Usage example with kwargs
kwargs: CreateIdentityProviderRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ProviderName": ...,
    "ProviderType": ...,
    "ProviderDetails": ...,
}

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

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

Method definition
def create_resource_server(
    self,
    *,
    UserPoolId: str,
    Identifier: str,
    Name: str,
    Scopes: Sequence[ResourceServerScopeTypeTypeDef] = ...,  # (1)
) -> CreateResourceServerResponseTypeDef:  # (2)
    ...
  1. See ResourceServerScopeTypeTypeDef
  2. See CreateResourceServerResponseTypeDef
Usage example with kwargs
kwargs: CreateResourceServerRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Identifier": ...,
    "Name": ...,
}

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

create_user_import_job

Creates the user import job.

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

Method definition
def create_user_import_job(
    self,
    *,
    JobName: str,
    UserPoolId: str,
    CloudWatchLogsRoleArn: str,
) -> CreateUserImportJobResponseTypeDef:  # (1)
    ...
  1. See CreateUserImportJobResponseTypeDef
Usage example with kwargs
kwargs: CreateUserImportJobRequestRequestTypeDef = {  # (1)
    "JobName": ...,
    "UserPoolId": ...,
    "CloudWatchLogsRoleArn": ...,
}

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

create_user_pool

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

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

Method definition
def create_user_pool(
    self,
    *,
    PoolName: str,
    Policies: UserPoolPolicyTypeTypeDef = ...,  # (1)
    DeletionProtection: DeletionProtectionTypeType = ...,  # (2)
    LambdaConfig: LambdaConfigTypeTypeDef = ...,  # (3)
    AutoVerifiedAttributes: Sequence[VerifiedAttributeTypeType] = ...,  # (4)
    AliasAttributes: Sequence[AliasAttributeTypeType] = ...,  # (5)
    UsernameAttributes: Sequence[UsernameAttributeTypeType] = ...,  # (6)
    SmsVerificationMessage: str = ...,
    EmailVerificationMessage: str = ...,
    EmailVerificationSubject: str = ...,
    VerificationMessageTemplate: VerificationMessageTemplateTypeTypeDef = ...,  # (7)
    SmsAuthenticationMessage: str = ...,
    MfaConfiguration: UserPoolMfaTypeType = ...,  # (8)
    UserAttributeUpdateSettings: UserAttributeUpdateSettingsTypeTypeDef = ...,  # (9)
    DeviceConfiguration: DeviceConfigurationTypeTypeDef = ...,  # (10)
    EmailConfiguration: EmailConfigurationTypeTypeDef = ...,  # (11)
    SmsConfiguration: SmsConfigurationTypeTypeDef = ...,  # (12)
    UserPoolTags: Mapping[str, str] = ...,
    AdminCreateUserConfig: AdminCreateUserConfigTypeTypeDef = ...,  # (13)
    Schema: Sequence[SchemaAttributeTypeTypeDef] = ...,  # (14)
    UserPoolAddOns: UserPoolAddOnsTypeTypeDef = ...,  # (15)
    UsernameConfiguration: UsernameConfigurationTypeTypeDef = ...,  # (16)
    AccountRecoverySetting: AccountRecoverySettingTypeTypeDef = ...,  # (17)
) -> CreateUserPoolResponseTypeDef:  # (18)
    ...
  1. See UserPoolPolicyTypeTypeDef
  2. See DeletionProtectionTypeType
  3. See LambdaConfigTypeTypeDef
  4. See VerifiedAttributeTypeType
  5. See AliasAttributeTypeType
  6. See UsernameAttributeTypeType
  7. See VerificationMessageTemplateTypeTypeDef
  8. See UserPoolMfaTypeType
  9. See UserAttributeUpdateSettingsTypeTypeDef
  10. See DeviceConfigurationTypeTypeDef
  11. See EmailConfigurationTypeTypeDef
  12. See SmsConfigurationTypeTypeDef
  13. See AdminCreateUserConfigTypeTypeDef
  14. See SchemaAttributeTypeTypeDef
  15. See UserPoolAddOnsTypeTypeDef
  16. See UsernameConfigurationTypeTypeDef
  17. See AccountRecoverySettingTypeTypeDef
  18. See CreateUserPoolResponseTypeDef
Usage example with kwargs
kwargs: CreateUserPoolRequestRequestTypeDef = {  # (1)
    "PoolName": ...,
}

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

create_user_pool_client

Creates the user pool client.

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

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 ExplicitAuthFlowsTypeType
  3. See OAuthFlowTypeType
  4. See AnalyticsConfigurationTypeTypeDef
  5. See PreventUserExistenceErrorTypesType
  6. See CreateUserPoolClientResponseTypeDef
Usage example with kwargs
kwargs: CreateUserPoolClientRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientName": ...,
}

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

create_user_pool_domain

Creates a new domain for a user pool.

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

Method definition
def create_user_pool_domain(
    self,
    *,
    Domain: str,
    UserPoolId: str,
    CustomDomainConfig: CustomDomainConfigTypeTypeDef = ...,  # (1)
) -> CreateUserPoolDomainResponseTypeDef:  # (2)
    ...
  1. See CustomDomainConfigTypeTypeDef
  2. See CreateUserPoolDomainResponseTypeDef
Usage example with kwargs
kwargs: CreateUserPoolDomainRequestRequestTypeDef = {  # (1)
    "Domain": ...,
    "UserPoolId": ...,
}

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

delete_group

Deletes a group.

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

Method definition
def delete_group(
    self,
    *,
    GroupName: str,
    UserPoolId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteGroupRequestRequestTypeDef = {  # (1)
    "GroupName": ...,
    "UserPoolId": ...,
}

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

delete_identity_provider

Deletes an IdP for a user pool.

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

Method definition
def delete_identity_provider(
    self,
    *,
    UserPoolId: str,
    ProviderName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteIdentityProviderRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ProviderName": ...,
}

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

delete_resource_server

Deletes a resource server.

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

Method definition
def delete_resource_server(
    self,
    *,
    UserPoolId: str,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteResourceServerRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Identifier": ...,
}

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

delete_user

Allows a user to delete himself or herself.

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

Method definition
def delete_user(
    self,
    *,
    AccessToken: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

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

delete_user_attributes

Deletes the attributes for a user.

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

Method definition
def delete_user_attributes(
    self,
    *,
    UserAttributeNames: Sequence[str],
    AccessToken: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteUserAttributesRequestRequestTypeDef = {  # (1)
    "UserAttributeNames": ...,
    "AccessToken": ...,
}

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

delete_user_pool

Deletes the specified Amazon Cognito user pool.

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

Method definition
def delete_user_pool(
    self,
    *,
    UserPoolId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUserPoolRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

delete_user_pool_client

Allows the developer to delete the user pool client.

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

Method definition
def delete_user_pool_client(
    self,
    *,
    UserPoolId: str,
    ClientId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUserPoolClientRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
}

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

delete_user_pool_domain

Deletes a domain for a user pool.

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

Method definition
def delete_user_pool_domain(
    self,
    *,
    Domain: str,
    UserPoolId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteUserPoolDomainRequestRequestTypeDef = {  # (1)
    "Domain": ...,
    "UserPoolId": ...,
}

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

describe_identity_provider

Gets information about a specific IdP.

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

Method definition
def describe_identity_provider(
    self,
    *,
    UserPoolId: str,
    ProviderName: str,
) -> DescribeIdentityProviderResponseTypeDef:  # (1)
    ...
  1. See DescribeIdentityProviderResponseTypeDef
Usage example with kwargs
kwargs: DescribeIdentityProviderRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ProviderName": ...,
}

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

describe_resource_server

Describes a resource server.

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

Method definition
def describe_resource_server(
    self,
    *,
    UserPoolId: str,
    Identifier: str,
) -> DescribeResourceServerResponseTypeDef:  # (1)
    ...
  1. See DescribeResourceServerResponseTypeDef
Usage example with kwargs
kwargs: DescribeResourceServerRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Identifier": ...,
}

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

describe_risk_configuration

Describes the risk configuration.

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

Method definition
def describe_risk_configuration(
    self,
    *,
    UserPoolId: str,
    ClientId: str = ...,
) -> DescribeRiskConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeRiskConfigurationResponseTypeDef
Usage example with kwargs
kwargs: DescribeRiskConfigurationRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

describe_user_import_job

Describes the user import job.

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

Method definition
def describe_user_import_job(
    self,
    *,
    UserPoolId: str,
    JobId: str,
) -> DescribeUserImportJobResponseTypeDef:  # (1)
    ...
  1. See DescribeUserImportJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeUserImportJobRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "JobId": ...,
}

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

describe_user_pool

Returns the configuration information and metadata of the specified user pool.

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

Method definition
def describe_user_pool(
    self,
    *,
    UserPoolId: str,
) -> DescribeUserPoolResponseTypeDef:  # (1)
    ...
  1. See DescribeUserPoolResponseTypeDef
Usage example with kwargs
kwargs: DescribeUserPoolRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

describe_user_pool_client

Client method for returning the configuration information and metadata of the specified user pool app client.

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

Method definition
def describe_user_pool_client(
    self,
    *,
    UserPoolId: str,
    ClientId: str,
) -> DescribeUserPoolClientResponseTypeDef:  # (1)
    ...
  1. See DescribeUserPoolClientResponseTypeDef
Usage example with kwargs
kwargs: DescribeUserPoolClientRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
}

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

describe_user_pool_domain

Gets information about a domain.

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

Method definition
def describe_user_pool_domain(
    self,
    *,
    Domain: str,
) -> DescribeUserPoolDomainResponseTypeDef:  # (1)
    ...
  1. See DescribeUserPoolDomainResponseTypeDef
Usage example with kwargs
kwargs: DescribeUserPoolDomainRequestRequestTypeDef = {  # (1)
    "Domain": ...,
}

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

forget_device

Forgets the specified device.

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

Method definition
def forget_device(
    self,
    *,
    DeviceKey: str,
    AccessToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: ForgetDeviceRequestRequestTypeDef = {  # (1)
    "DeviceKey": ...,
}

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

forgot_password

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password.

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

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
Usage example with kwargs
kwargs: ForgotPasswordRequestRequestTypeDef = {  # (1)
    "ClientId": ...,
    "Username": ...,
}

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

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_csv_header

Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.

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

Method definition
def get_csv_header(
    self,
    *,
    UserPoolId: str,
) -> GetCSVHeaderResponseTypeDef:  # (1)
    ...
  1. See GetCSVHeaderResponseTypeDef
Usage example with kwargs
kwargs: GetCSVHeaderRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

get_device

Gets the device.

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

Method definition
def get_device(
    self,
    *,
    DeviceKey: str,
    AccessToken: str = ...,
) -> GetDeviceResponseTypeDef:  # (1)
    ...
  1. See GetDeviceResponseTypeDef
Usage example with kwargs
kwargs: GetDeviceRequestRequestTypeDef = {  # (1)
    "DeviceKey": ...,
}

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

get_group

Gets a group.

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

Method definition
def get_group(
    self,
    *,
    GroupName: str,
    UserPoolId: str,
) -> GetGroupResponseTypeDef:  # (1)
    ...
  1. See GetGroupResponseTypeDef
Usage example with kwargs
kwargs: GetGroupRequestRequestTypeDef = {  # (1)
    "GroupName": ...,
    "UserPoolId": ...,
}

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

get_identity_provider_by_identifier

Gets the specified IdP.

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

Method definition
def get_identity_provider_by_identifier(
    self,
    *,
    UserPoolId: str,
    IdpIdentifier: str,
) -> GetIdentityProviderByIdentifierResponseTypeDef:  # (1)
    ...
  1. See GetIdentityProviderByIdentifierResponseTypeDef
Usage example with kwargs
kwargs: GetIdentityProviderByIdentifierRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "IdpIdentifier": ...,
}

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

get_signing_certificate

This method takes a user pool ID, and returns the signing certificate.

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

Method definition
def get_signing_certificate(
    self,
    *,
    UserPoolId: str,
) -> GetSigningCertificateResponseTypeDef:  # (1)
    ...
  1. See GetSigningCertificateResponseTypeDef
Usage example with kwargs
kwargs: GetSigningCertificateRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

get_ui_customization

Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client.

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

Method definition
def get_ui_customization(
    self,
    *,
    UserPoolId: str,
    ClientId: str = ...,
) -> GetUICustomizationResponseTypeDef:  # (1)
    ...
  1. See GetUICustomizationResponseTypeDef
Usage example with kwargs
kwargs: GetUICustomizationRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

get_user

Gets the user attributes and metadata for a user.

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

Method definition
def get_user(
    self,
    *,
    AccessToken: str,
) -> GetUserResponseTypeDef:  # (1)
    ...
  1. See GetUserResponseTypeDef
Usage example with kwargs
kwargs: GetUserRequestRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

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

get_user_attribute_verification_code

Generates a user attribute verification code for the specified attribute name.

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

Method definition
def get_user_attribute_verification_code(
    self,
    *,
    AccessToken: str,
    AttributeName: str,
    ClientMetadata: Mapping[str, str] = ...,
) -> GetUserAttributeVerificationCodeResponseTypeDef:  # (1)
    ...
  1. See GetUserAttributeVerificationCodeResponseTypeDef
Usage example with kwargs
kwargs: GetUserAttributeVerificationCodeRequestRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "AttributeName": ...,
}

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

get_user_pool_mfa_config

Gets the user pool multi-factor authentication (MFA) configuration.

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

Method definition
def get_user_pool_mfa_config(
    self,
    *,
    UserPoolId: str,
) -> GetUserPoolMfaConfigResponseTypeDef:  # (1)
    ...
  1. See GetUserPoolMfaConfigResponseTypeDef
Usage example with kwargs
kwargs: GetUserPoolMfaConfigRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

global_sign_out

Signs out users from all devices.

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

Method definition
def global_sign_out(
    self,
    *,
    AccessToken: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: GlobalSignOutRequestRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

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

initiate_auth

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

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)
) -> InitiateAuthResponseTypeDef:  # (4)
    ...
  1. See AuthFlowTypeType
  2. See AnalyticsMetadataTypeTypeDef
  3. See UserContextDataTypeTypeDef
  4. See InitiateAuthResponseTypeDef
Usage example with kwargs
kwargs: InitiateAuthRequestRequestTypeDef = {  # (1)
    "AuthFlow": ...,
    "ClientId": ...,
}

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

list_devices

Lists the sign-in devices that Amazon Cognito has registered to the current user.

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

Method definition
def list_devices(
    self,
    *,
    AccessToken: str,
    Limit: int = ...,
    PaginationToken: str = ...,
) -> ListDevicesResponseTypeDef:  # (1)
    ...
  1. See ListDevicesResponseTypeDef
Usage example with kwargs
kwargs: ListDevicesRequestRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

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

list_groups

Lists the groups associated with a user pool.

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

Method definition
def list_groups(
    self,
    *,
    UserPoolId: str,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListGroupsResponseTypeDef:  # (1)
    ...
  1. See ListGroupsResponseTypeDef
Usage example with kwargs
kwargs: ListGroupsRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

list_identity_providers

Lists information about all IdPs for a user pool.

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

Method definition
def list_identity_providers(
    self,
    *,
    UserPoolId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListIdentityProvidersResponseTypeDef:  # (1)
    ...
  1. See ListIdentityProvidersResponseTypeDef
Usage example with kwargs
kwargs: ListIdentityProvidersRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

list_resource_servers

Lists the resource servers for a user pool.

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

Method definition
def list_resource_servers(
    self,
    *,
    UserPoolId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListResourceServersResponseTypeDef:  # (1)
    ...
  1. See ListResourceServersResponseTypeDef
Usage example with kwargs
kwargs: ListResourceServersRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

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

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

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

list_user_import_jobs

Lists the user import jobs.

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

Method definition
def list_user_import_jobs(
    self,
    *,
    UserPoolId: str,
    MaxResults: int,
    PaginationToken: str = ...,
) -> ListUserImportJobsResponseTypeDef:  # (1)
    ...
  1. See ListUserImportJobsResponseTypeDef
Usage example with kwargs
kwargs: ListUserImportJobsRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "MaxResults": ...,
}

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

list_user_pool_clients

Lists the clients that have been created for the specified user pool.

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

Method definition
def list_user_pool_clients(
    self,
    *,
    UserPoolId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListUserPoolClientsResponseTypeDef:  # (1)
    ...
  1. See ListUserPoolClientsResponseTypeDef
Usage example with kwargs
kwargs: ListUserPoolClientsRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

list_user_pools

Lists the user pools associated with an Amazon Web Services account.

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

Method definition
def list_user_pools(
    self,
    *,
    MaxResults: int,
    NextToken: str = ...,
) -> ListUserPoolsResponseTypeDef:  # (1)
    ...
  1. See ListUserPoolsResponseTypeDef
Usage example with kwargs
kwargs: ListUserPoolsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

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

list_users

Lists the users in the Amazon Cognito user pool.

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

Method definition
def list_users(
    self,
    *,
    UserPoolId: str,
    AttributesToGet: Sequence[str] = ...,
    Limit: int = ...,
    PaginationToken: str = ...,
    Filter: str = ...,
) -> ListUsersResponseTypeDef:  # (1)
    ...
  1. See ListUsersResponseTypeDef
Usage example with kwargs
kwargs: ListUsersRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

list_users_in_group

Lists the users in the specified group.

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

Method definition
def list_users_in_group(
    self,
    *,
    UserPoolId: str,
    GroupName: str,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListUsersInGroupResponseTypeDef:  # (1)
    ...
  1. See ListUsersInGroupResponseTypeDef
Usage example with kwargs
kwargs: ListUsersInGroupRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "GroupName": ...,
}

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

resend_confirmation_code

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

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

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
Usage example with kwargs
kwargs: ResendConfirmationCodeRequestRequestTypeDef = {  # (1)
    "ClientId": ...,
    "Username": ...,
}

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

respond_to_auth_challenge

Responds to the authentication challenge.

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

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
Usage example with kwargs
kwargs: RespondToAuthChallengeRequestRequestTypeDef = {  # (1)
    "ClientId": ...,
    "ChallengeName": ...,
}

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

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

Method definition
def revoke_token(
    self,
    *,
    Token: str,
    ClientId: str,
    ClientSecret: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: RevokeTokenRequestRequestTypeDef = {  # (1)
    "Token": ...,
    "ClientId": ...,
}

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

set_risk_configuration

Configures actions on detected risks.

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

Method definition
def set_risk_configuration(
    self,
    *,
    UserPoolId: str,
    ClientId: str = ...,
    CompromisedCredentialsRiskConfiguration: CompromisedCredentialsRiskConfigurationTypeTypeDef = ...,  # (1)
    AccountTakeoverRiskConfiguration: AccountTakeoverRiskConfigurationTypeTypeDef = ...,  # (2)
    RiskExceptionConfiguration: RiskExceptionConfigurationTypeTypeDef = ...,  # (3)
) -> SetRiskConfigurationResponseTypeDef:  # (4)
    ...
  1. See CompromisedCredentialsRiskConfigurationTypeTypeDef
  2. See AccountTakeoverRiskConfigurationTypeTypeDef
  3. See RiskExceptionConfigurationTypeTypeDef
  4. See SetRiskConfigurationResponseTypeDef
Usage example with kwargs
kwargs: SetRiskConfigurationRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

set_ui_customization

Sets the user interface (UI) customization information for a user pool's built- in app UI.

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

Method definition
def set_ui_customization(
    self,
    *,
    UserPoolId: str,
    ClientId: str = ...,
    CSS: str = ...,
    ImageFile: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> SetUICustomizationResponseTypeDef:  # (1)
    ...
  1. See SetUICustomizationResponseTypeDef
Usage example with kwargs
kwargs: SetUICustomizationRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

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

Method definition
def set_user_mfa_preference(
    self,
    *,
    AccessToken: str,
    SMSMfaSettings: SMSMfaSettingsTypeTypeDef = ...,  # (1)
    SoftwareTokenMfaSettings: SoftwareTokenMfaSettingsTypeTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See SMSMfaSettingsTypeTypeDef
  2. See SoftwareTokenMfaSettingsTypeTypeDef
Usage example with kwargs
kwargs: SetUserMFAPreferenceRequestRequestTypeDef = {  # (1)
    "AccessToken": ...,
}

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

set_user_pool_mfa_config

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

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

Method definition
def set_user_pool_mfa_config(
    self,
    *,
    UserPoolId: str,
    SmsMfaConfiguration: SmsMfaConfigTypeTypeDef = ...,  # (1)
    SoftwareTokenMfaConfiguration: SoftwareTokenMfaConfigTypeTypeDef = ...,  # (2)
    MfaConfiguration: UserPoolMfaTypeType = ...,  # (3)
) -> SetUserPoolMfaConfigResponseTypeDef:  # (4)
    ...
  1. See SmsMfaConfigTypeTypeDef
  2. See SoftwareTokenMfaConfigTypeTypeDef
  3. See UserPoolMfaTypeType
  4. See SetUserPoolMfaConfigResponseTypeDef
Usage example with kwargs
kwargs: SetUserPoolMfaConfigRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

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

Method definition
def set_user_settings(
    self,
    *,
    AccessToken: str,
    MFAOptions: Sequence[MFAOptionTypeTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See MFAOptionTypeTypeDef
Usage example with kwargs
kwargs: SetUserSettingsRequestRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "MFAOptions": ...,
}

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

sign_up

Registers the user in the specified user pool and creates a user name, password, and user attributes.

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

Method definition
def sign_up(
    self,
    *,
    ClientId: str,
    Username: str,
    Password: str,
    SecretHash: str = ...,
    UserAttributes: Sequence[AttributeTypeTypeDef] = ...,  # (1)
    ValidationData: Sequence[AttributeTypeTypeDef] = ...,  # (1)
    AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ...,  # (3)
    UserContextData: UserContextDataTypeTypeDef = ...,  # (4)
    ClientMetadata: Mapping[str, str] = ...,
) -> SignUpResponseTypeDef:  # (5)
    ...
  1. See AttributeTypeTypeDef
  2. See AttributeTypeTypeDef
  3. See AnalyticsMetadataTypeTypeDef
  4. See UserContextDataTypeTypeDef
  5. See SignUpResponseTypeDef
Usage example with kwargs
kwargs: SignUpRequestRequestTypeDef = {  # (1)
    "ClientId": ...,
    "Username": ...,
    "Password": ...,
}

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

start_user_import_job

Starts the user import.

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

Method definition
def start_user_import_job(
    self,
    *,
    UserPoolId: str,
    JobId: str,
) -> StartUserImportJobResponseTypeDef:  # (1)
    ...
  1. See StartUserImportJobResponseTypeDef
Usage example with kwargs
kwargs: StartUserImportJobRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "JobId": ...,
}

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

stop_user_import_job

Stops the user import job.

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

Method definition
def stop_user_import_job(
    self,
    *,
    UserPoolId: str,
    JobId: str,
) -> StopUserImportJobResponseTypeDef:  # (1)
    ...
  1. See StopUserImportJobResponseTypeDef
Usage example with kwargs
kwargs: StopUserImportJobRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "JobId": ...,
}

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

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

Method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

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

untag_resource

Removes the specified tags from an Amazon Cognito user pool.

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

Method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

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

update_auth_event_feedback

Provides the feedback for an authentication event, whether it was from a valid user or not.

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

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
Usage example with kwargs
kwargs: UpdateAuthEventFeedbackRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
    "EventId": ...,
    "FeedbackToken": ...,
    "FeedbackValue": ...,
}

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

update_device_status

Updates the device status.

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

Method definition
def update_device_status(
    self,
    *,
    AccessToken: str,
    DeviceKey: str,
    DeviceRememberedStatus: DeviceRememberedStatusTypeType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See DeviceRememberedStatusTypeType
Usage example with kwargs
kwargs: UpdateDeviceStatusRequestRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "DeviceKey": ...,
}

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

update_group

Updates the specified group with the specified attributes.

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

Method definition
def update_group(
    self,
    *,
    GroupName: str,
    UserPoolId: str,
    Description: str = ...,
    RoleArn: str = ...,
    Precedence: int = ...,
) -> UpdateGroupResponseTypeDef:  # (1)
    ...
  1. See UpdateGroupResponseTypeDef
Usage example with kwargs
kwargs: UpdateGroupRequestRequestTypeDef = {  # (1)
    "GroupName": ...,
    "UserPoolId": ...,
}

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

update_identity_provider

Updates IdP information for a user pool.

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

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
Usage example with kwargs
kwargs: UpdateIdentityProviderRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ProviderName": ...,
}

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

update_resource_server

Updates the name and scopes of resource server.

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

Method definition
def update_resource_server(
    self,
    *,
    UserPoolId: str,
    Identifier: str,
    Name: str,
    Scopes: Sequence[ResourceServerScopeTypeTypeDef] = ...,  # (1)
) -> UpdateResourceServerResponseTypeDef:  # (2)
    ...
  1. See ResourceServerScopeTypeTypeDef
  2. See UpdateResourceServerResponseTypeDef
Usage example with kwargs
kwargs: UpdateResourceServerRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "Identifier": ...,
    "Name": ...,
}

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

update_user_attributes

Allows a user to update a specific attribute (one at a time).

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

Method definition
def update_user_attributes(
    self,
    *,
    UserAttributes: Sequence[AttributeTypeTypeDef],  # (1)
    AccessToken: str,
    ClientMetadata: Mapping[str, str] = ...,
) -> UpdateUserAttributesResponseTypeDef:  # (2)
    ...
  1. See AttributeTypeTypeDef
  2. See UpdateUserAttributesResponseTypeDef
Usage example with kwargs
kwargs: UpdateUserAttributesRequestRequestTypeDef = {  # (1)
    "UserAttributes": ...,
    "AccessToken": ...,
}

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

update_user_pool

Updates the specified user pool with the specified attributes.

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

Method definition
def update_user_pool(
    self,
    *,
    UserPoolId: str,
    Policies: UserPoolPolicyTypeTypeDef = ...,  # (1)
    DeletionProtection: DeletionProtectionTypeType = ...,  # (2)
    LambdaConfig: LambdaConfigTypeTypeDef = ...,  # (3)
    AutoVerifiedAttributes: Sequence[VerifiedAttributeTypeType] = ...,  # (4)
    SmsVerificationMessage: str = ...,
    EmailVerificationMessage: str = ...,
    EmailVerificationSubject: str = ...,
    VerificationMessageTemplate: VerificationMessageTemplateTypeTypeDef = ...,  # (5)
    SmsAuthenticationMessage: str = ...,
    UserAttributeUpdateSettings: UserAttributeUpdateSettingsTypeTypeDef = ...,  # (6)
    MfaConfiguration: UserPoolMfaTypeType = ...,  # (7)
    DeviceConfiguration: DeviceConfigurationTypeTypeDef = ...,  # (8)
    EmailConfiguration: EmailConfigurationTypeTypeDef = ...,  # (9)
    SmsConfiguration: SmsConfigurationTypeTypeDef = ...,  # (10)
    UserPoolTags: Mapping[str, str] = ...,
    AdminCreateUserConfig: AdminCreateUserConfigTypeTypeDef = ...,  # (11)
    UserPoolAddOns: UserPoolAddOnsTypeTypeDef = ...,  # (12)
    AccountRecoverySetting: AccountRecoverySettingTypeTypeDef = ...,  # (13)
) -> Dict[str, Any]:
    ...
  1. See UserPoolPolicyTypeTypeDef
  2. See DeletionProtectionTypeType
  3. See LambdaConfigTypeTypeDef
  4. See VerifiedAttributeTypeType
  5. See VerificationMessageTemplateTypeTypeDef
  6. See UserAttributeUpdateSettingsTypeTypeDef
  7. See UserPoolMfaTypeType
  8. See DeviceConfigurationTypeTypeDef
  9. See EmailConfigurationTypeTypeDef
  10. See SmsConfigurationTypeTypeDef
  11. See AdminCreateUserConfigTypeTypeDef
  12. See UserPoolAddOnsTypeTypeDef
  13. See AccountRecoverySettingTypeTypeDef
Usage example with kwargs
kwargs: UpdateUserPoolRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
}

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

update_user_pool_client

Updates the specified user pool app client with the specified attributes.

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

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 ExplicitAuthFlowsTypeType
  3. See OAuthFlowTypeType
  4. See AnalyticsConfigurationTypeTypeDef
  5. See PreventUserExistenceErrorTypesType
  6. See UpdateUserPoolClientResponseTypeDef
Usage example with kwargs
kwargs: UpdateUserPoolClientRequestRequestTypeDef = {  # (1)
    "UserPoolId": ...,
    "ClientId": ...,
}

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

update_user_pool_domain

Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.

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

Method definition
def update_user_pool_domain(
    self,
    *,
    Domain: str,
    UserPoolId: str,
    CustomDomainConfig: CustomDomainConfigTypeTypeDef,  # (1)
) -> UpdateUserPoolDomainResponseTypeDef:  # (2)
    ...
  1. See CustomDomainConfigTypeTypeDef
  2. See UpdateUserPoolDomainResponseTypeDef
Usage example with kwargs
kwargs: UpdateUserPoolDomainRequestRequestTypeDef = {  # (1)
    "Domain": ...,
    "UserPoolId": ...,
    "CustomDomainConfig": ...,
}

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

verify_software_token

Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful.

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

Method definition
def verify_software_token(
    self,
    *,
    UserCode: str,
    AccessToken: str = ...,
    Session: str = ...,
    FriendlyDeviceName: str = ...,
) -> VerifySoftwareTokenResponseTypeDef:  # (1)
    ...
  1. See VerifySoftwareTokenResponseTypeDef
Usage example with kwargs
kwargs: VerifySoftwareTokenRequestRequestTypeDef = {  # (1)
    "UserCode": ...,
}

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

verify_user_attribute

Verifies the specified user attributes in the user pool.

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

Method definition
def verify_user_attribute(
    self,
    *,
    AccessToken: str,
    AttributeName: str,
    Code: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: VerifyUserAttributeRequestRequestTypeDef = {  # (1)
    "AccessToken": ...,
    "AttributeName": ...,
    "Code": ...,
}

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

get_paginator

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