CognitoIdentityProviderClient
Index > CognitoIdentityProvider > CognitoIdentityProviderClient
Auto-generated documentation for CognitoIdentityProvider type annotations stubs module types-aiobotocore-cognito-idp.
CognitoIdentityProviderClient
Type annotations and code completion for session.client("cognito-idp")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_cognito_idp.client import CognitoIdentityProviderClient
session = Session()
async with session.client("cognito-idp") as client:
client: CognitoIdentityProviderClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("cognito-idp").exceptions
structure.
async with session.client("cognito-idp") as client:
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)
from types_aiobotocore_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 session.client("cognito-idp").add_custom_attributes
method.
boto3 documentation
await def add_custom_attributes(
self,
*,
UserPoolId: str,
CustomAttributes: Sequence[SchemaAttributeTypeTypeDef], # (1)
) -> Dict[str, Any]:
...
kwargs: AddCustomAttributesRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"CustomAttributes": ...,
}
parent.add_custom_attributes(**kwargs)
admin_add_user_to_group
Adds the specified user to the specified group.
Type annotations and code completion for session.client("cognito-idp").admin_add_user_to_group
method.
boto3 documentation
await def admin_add_user_to_group(
self,
*,
UserPoolId: str,
Username: str,
GroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AdminAddUserToGroupRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"GroupName": ...,
}
parent.admin_add_user_to_group(**kwargs)
admin_confirm_sign_up
Confirms user registration as an admin without using a confirmation code.
Type annotations and code completion for session.client("cognito-idp").admin_confirm_sign_up
method.
boto3 documentation
await def admin_confirm_sign_up(
self,
*,
UserPoolId: str,
Username: str,
ClientMetadata: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
kwargs: AdminConfirmSignUpRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_confirm_sign_up(**kwargs)
admin_create_user
Creates a new user in the specified user pool.
Type annotations and code completion for session.client("cognito-idp").admin_create_user
method.
boto3 documentation
await def admin_create_user(
self,
*,
UserPoolId: str,
Username: str,
UserAttributes: Sequence[AttributeTypeTypeDef] = ..., # (1)
ValidationData: Sequence[AttributeTypeTypeDef] = ..., # (1)
TemporaryPassword: str = ...,
ForceAliasCreation: bool = ...,
MessageAction: MessageActionTypeType = ..., # (3)
DesiredDeliveryMediums: Sequence[DeliveryMediumTypeType] = ..., # (4)
ClientMetadata: Mapping[str, str] = ...,
) -> AdminCreateUserResponseTypeDef: # (5)
...
- See AttributeTypeTypeDef
- See AttributeTypeTypeDef
- See MessageActionTypeType
- See DeliveryMediumTypeType
- See AdminCreateUserResponseTypeDef
kwargs: AdminCreateUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_create_user(**kwargs)
admin_delete_user
Deletes a user as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_delete_user
method.
boto3 documentation
await def admin_delete_user(
self,
*,
UserPoolId: str,
Username: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AdminDeleteUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_delete_user(**kwargs)
admin_delete_user_attributes
Deletes the user attributes in a user pool as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_delete_user_attributes
method.
boto3 documentation
await def admin_delete_user_attributes(
self,
*,
UserPoolId: str,
Username: str,
UserAttributeNames: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: AdminDeleteUserAttributesRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"UserAttributeNames": ...,
}
parent.admin_delete_user_attributes(**kwargs)
admin_disable_provider_for_user
Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP).
Type annotations and code completion for session.client("cognito-idp").admin_disable_provider_for_user
method.
boto3 documentation
await def admin_disable_provider_for_user(
self,
*,
UserPoolId: str,
User: ProviderUserIdentifierTypeTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: AdminDisableProviderForUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"User": ...,
}
parent.admin_disable_provider_for_user(**kwargs)
admin_disable_user
Disables the specified user.
Type annotations and code completion for session.client("cognito-idp").admin_disable_user
method.
boto3 documentation
await def admin_disable_user(
self,
*,
UserPoolId: str,
Username: str,
) -> Dict[str, Any]:
...
kwargs: AdminDisableUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_disable_user(**kwargs)
admin_enable_user
Enables the specified user as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_enable_user
method.
boto3 documentation
await def admin_enable_user(
self,
*,
UserPoolId: str,
Username: str,
) -> Dict[str, Any]:
...
kwargs: AdminEnableUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_enable_user(**kwargs)
admin_forget_device
Forgets the device, as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_forget_device
method.
boto3 documentation
await def admin_forget_device(
self,
*,
UserPoolId: str,
Username: str,
DeviceKey: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AdminForgetDeviceRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"DeviceKey": ...,
}
parent.admin_forget_device(**kwargs)
admin_get_device
Gets the device, as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_get_device
method.
boto3 documentation
await def admin_get_device(
self,
*,
DeviceKey: str,
UserPoolId: str,
Username: str,
) -> AdminGetDeviceResponseTypeDef: # (1)
...
kwargs: AdminGetDeviceRequestRequestTypeDef = { # (1)
"DeviceKey": ...,
"UserPoolId": ...,
"Username": ...,
}
parent.admin_get_device(**kwargs)
admin_get_user
Gets the specified user by user name in a user pool as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_get_user
method.
boto3 documentation
await def admin_get_user(
self,
*,
UserPoolId: str,
Username: str,
) -> AdminGetUserResponseTypeDef: # (1)
...
kwargs: AdminGetUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_get_user(**kwargs)
admin_initiate_auth
Initiates the authentication flow, as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_initiate_auth
method.
boto3 documentation
await def admin_initiate_auth(
self,
*,
UserPoolId: str,
ClientId: str,
AuthFlow: AuthFlowTypeType, # (1)
AuthParameters: Mapping[str, str] = ...,
ClientMetadata: Mapping[str, str] = ...,
AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ..., # (2)
ContextData: ContextDataTypeTypeDef = ..., # (3)
) -> AdminInitiateAuthResponseTypeDef: # (4)
...
- See AuthFlowTypeType
- See AnalyticsMetadataTypeTypeDef
- See ContextDataTypeTypeDef
- See AdminInitiateAuthResponseTypeDef
kwargs: AdminInitiateAuthRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ClientId": ...,
"AuthFlow": ...,
}
parent.admin_initiate_auth(**kwargs)
admin_link_provider_for_user
Links an existing user account in a user pool (DestinationUser
) to an
identity from an external IdP (SourceUser
) based on a specified attribute
name and value from the external IdP.
Type annotations and code completion for session.client("cognito-idp").admin_link_provider_for_user
method.
boto3 documentation
await def admin_link_provider_for_user(
self,
*,
UserPoolId: str,
DestinationUser: ProviderUserIdentifierTypeTypeDef, # (1)
SourceUser: ProviderUserIdentifierTypeTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: AdminLinkProviderForUserRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"DestinationUser": ...,
"SourceUser": ...,
}
parent.admin_link_provider_for_user(**kwargs)
admin_list_devices
Lists devices, as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_list_devices
method.
boto3 documentation
await def admin_list_devices(
self,
*,
UserPoolId: str,
Username: str,
Limit: int = ...,
PaginationToken: str = ...,
) -> AdminListDevicesResponseTypeDef: # (1)
...
kwargs: AdminListDevicesRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_list_devices(**kwargs)
admin_list_groups_for_user
Lists the groups that the user belongs to.
Type annotations and code completion for session.client("cognito-idp").admin_list_groups_for_user
method.
boto3 documentation
await def admin_list_groups_for_user(
self,
*,
Username: str,
UserPoolId: str,
Limit: int = ...,
NextToken: str = ...,
) -> AdminListGroupsForUserResponseTypeDef: # (1)
...
kwargs: AdminListGroupsForUserRequestRequestTypeDef = { # (1)
"Username": ...,
"UserPoolId": ...,
}
parent.admin_list_groups_for_user(**kwargs)
admin_list_user_auth_events
A history of user activity and any risks detected as part of Amazon Cognito advanced security.
Type annotations and code completion for session.client("cognito-idp").admin_list_user_auth_events
method.
boto3 documentation
await def admin_list_user_auth_events(
self,
*,
UserPoolId: str,
Username: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> AdminListUserAuthEventsResponseTypeDef: # (1)
...
kwargs: AdminListUserAuthEventsRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_list_user_auth_events(**kwargs)
admin_remove_user_from_group
Removes the specified user from the specified group.
Type annotations and code completion for session.client("cognito-idp").admin_remove_user_from_group
method.
boto3 documentation
await def admin_remove_user_from_group(
self,
*,
UserPoolId: str,
Username: str,
GroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AdminRemoveUserFromGroupRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"GroupName": ...,
}
parent.admin_remove_user_from_group(**kwargs)
admin_reset_user_password
Resets the specified user's password in a user pool as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_reset_user_password
method.
boto3 documentation
await def admin_reset_user_password(
self,
*,
UserPoolId: str,
Username: str,
ClientMetadata: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
kwargs: AdminResetUserPasswordRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_reset_user_password(**kwargs)
admin_respond_to_auth_challenge
Responds to an authentication challenge, as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_respond_to_auth_challenge
method.
boto3 documentation
await def admin_respond_to_auth_challenge(
self,
*,
UserPoolId: str,
ClientId: str,
ChallengeName: ChallengeNameTypeType, # (1)
ChallengeResponses: Mapping[str, str] = ...,
Session: str = ...,
AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ..., # (2)
ContextData: ContextDataTypeTypeDef = ..., # (3)
ClientMetadata: Mapping[str, str] = ...,
) -> AdminRespondToAuthChallengeResponseTypeDef: # (4)
...
- See ChallengeNameTypeType
- See AnalyticsMetadataTypeTypeDef
- See ContextDataTypeTypeDef
- See AdminRespondToAuthChallengeResponseTypeDef
kwargs: AdminRespondToAuthChallengeRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ClientId": ...,
"ChallengeName": ...,
}
parent.admin_respond_to_auth_challenge(**kwargs)
admin_set_user_mfa_preference
The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred.
Type annotations and code completion for session.client("cognito-idp").admin_set_user_mfa_preference
method.
boto3 documentation
await def admin_set_user_mfa_preference(
self,
*,
Username: str,
UserPoolId: str,
SMSMfaSettings: SMSMfaSettingsTypeTypeDef = ..., # (1)
SoftwareTokenMfaSettings: SoftwareTokenMfaSettingsTypeTypeDef = ..., # (2)
) -> Dict[str, Any]:
...
kwargs: AdminSetUserMFAPreferenceRequestRequestTypeDef = { # (1)
"Username": ...,
"UserPoolId": ...,
}
parent.admin_set_user_mfa_preference(**kwargs)
admin_set_user_password
Sets the specified user's password in a user pool as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_set_user_password
method.
boto3 documentation
await def admin_set_user_password(
self,
*,
UserPoolId: str,
Username: str,
Password: str,
Permanent: bool = ...,
) -> Dict[str, Any]:
...
kwargs: AdminSetUserPasswordRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"Password": ...,
}
parent.admin_set_user_password(**kwargs)
admin_set_user_settings
This action is no longer supported. You can use it to configure only SMS MFA.
Type annotations and code completion for session.client("cognito-idp").admin_set_user_settings
method.
boto3 documentation
await def admin_set_user_settings(
self,
*,
UserPoolId: str,
Username: str,
MFAOptions: Sequence[MFAOptionTypeTypeDef], # (1)
) -> Dict[str, Any]:
...
kwargs: AdminSetUserSettingsRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"MFAOptions": ...,
}
parent.admin_set_user_settings(**kwargs)
admin_update_auth_event_feedback
Provides feedback for an authentication event indicating if it was from a valid user.
Type annotations and code completion for session.client("cognito-idp").admin_update_auth_event_feedback
method.
boto3 documentation
await def admin_update_auth_event_feedback(
self,
*,
UserPoolId: str,
Username: str,
EventId: str,
FeedbackValue: FeedbackValueTypeType, # (1)
) -> Dict[str, Any]:
...
kwargs: AdminUpdateAuthEventFeedbackRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"EventId": ...,
"FeedbackValue": ...,
}
parent.admin_update_auth_event_feedback(**kwargs)
admin_update_device_status
Updates the device status as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_update_device_status
method.
boto3 documentation
await def admin_update_device_status(
self,
*,
UserPoolId: str,
Username: str,
DeviceKey: str,
DeviceRememberedStatus: DeviceRememberedStatusTypeType = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: AdminUpdateDeviceStatusRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"DeviceKey": ...,
}
parent.admin_update_device_status(**kwargs)
admin_update_user_attributes
Updates the specified user's attributes, including developer attributes, as an administrator.
Type annotations and code completion for session.client("cognito-idp").admin_update_user_attributes
method.
boto3 documentation
await def admin_update_user_attributes(
self,
*,
UserPoolId: str,
Username: str,
UserAttributes: Sequence[AttributeTypeTypeDef], # (1)
ClientMetadata: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
kwargs: AdminUpdateUserAttributesRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"UserAttributes": ...,
}
parent.admin_update_user_attributes(**kwargs)
admin_user_global_sign_out
Signs out a user from all devices.
Type annotations and code completion for session.client("cognito-idp").admin_user_global_sign_out
method.
boto3 documentation
await def admin_user_global_sign_out(
self,
*,
UserPoolId: str,
Username: str,
) -> Dict[str, Any]:
...
kwargs: AdminUserGlobalSignOutRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
}
parent.admin_user_global_sign_out(**kwargs)
associate_software_token
Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response.
Type annotations and code completion for session.client("cognito-idp").associate_software_token
method.
boto3 documentation
await def associate_software_token(
self,
*,
AccessToken: str = ...,
Session: str = ...,
) -> AssociateSoftwareTokenResponseTypeDef: # (1)
...
kwargs: AssociateSoftwareTokenRequestRequestTypeDef = { # (1)
"AccessToken": ...,
}
parent.associate_software_token(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("cognito-idp").can_paginate
method.
boto3 documentation
change_password
Changes the password for a specified user in a user pool.
Type annotations and code completion for session.client("cognito-idp").change_password
method.
boto3 documentation
await def change_password(
self,
*,
PreviousPassword: str,
ProposedPassword: str,
AccessToken: str,
) -> Dict[str, Any]:
...
kwargs: ChangePasswordRequestRequestTypeDef = { # (1)
"PreviousPassword": ...,
"ProposedPassword": ...,
"AccessToken": ...,
}
parent.change_password(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("cognito-idp").close
method.
boto3 documentation
confirm_device
Confirms tracking of the device.
Type annotations and code completion for session.client("cognito-idp").confirm_device
method.
boto3 documentation
await def confirm_device(
self,
*,
AccessToken: str,
DeviceKey: str,
DeviceSecretVerifierConfig: DeviceSecretVerifierConfigTypeTypeDef = ..., # (1)
DeviceName: str = ...,
) -> ConfirmDeviceResponseTypeDef: # (2)
...
kwargs: ConfirmDeviceRequestRequestTypeDef = { # (1)
"AccessToken": ...,
"DeviceKey": ...,
}
parent.confirm_device(**kwargs)
confirm_forgot_password
Allows a user to enter a confirmation code to reset a forgotten password.
Type annotations and code completion for session.client("cognito-idp").confirm_forgot_password
method.
boto3 documentation
await 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]:
...
kwargs: ConfirmForgotPasswordRequestRequestTypeDef = { # (1)
"ClientId": ...,
"Username": ...,
"ConfirmationCode": ...,
"Password": ...,
}
parent.confirm_forgot_password(**kwargs)
confirm_sign_up
Confirms registration of a new user.
Type annotations and code completion for session.client("cognito-idp").confirm_sign_up
method.
boto3 documentation
await 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]:
...
kwargs: ConfirmSignUpRequestRequestTypeDef = { # (1)
"ClientId": ...,
"Username": ...,
"ConfirmationCode": ...,
}
parent.confirm_sign_up(**kwargs)
create_group
Creates a new group in the specified user pool.
Type annotations and code completion for session.client("cognito-idp").create_group
method.
boto3 documentation
await def create_group(
self,
*,
GroupName: str,
UserPoolId: str,
Description: str = ...,
RoleArn: str = ...,
Precedence: int = ...,
) -> CreateGroupResponseTypeDef: # (1)
...
kwargs: CreateGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"UserPoolId": ...,
}
parent.create_group(**kwargs)
create_identity_provider
Creates an IdP for a user pool.
Type annotations and code completion for session.client("cognito-idp").create_identity_provider
method.
boto3 documentation
await 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)
...
kwargs: CreateIdentityProviderRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ProviderName": ...,
"ProviderType": ...,
"ProviderDetails": ...,
}
parent.create_identity_provider(**kwargs)
create_resource_server
Creates a new OAuth2.0 resource server and defines custom scopes within it.
Type annotations and code completion for session.client("cognito-idp").create_resource_server
method.
boto3 documentation
await def create_resource_server(
self,
*,
UserPoolId: str,
Identifier: str,
Name: str,
Scopes: Sequence[ResourceServerScopeTypeTypeDef] = ..., # (1)
) -> CreateResourceServerResponseTypeDef: # (2)
...
kwargs: CreateResourceServerRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Identifier": ...,
"Name": ...,
}
parent.create_resource_server(**kwargs)
create_user_import_job
Creates the user import job.
Type annotations and code completion for session.client("cognito-idp").create_user_import_job
method.
boto3 documentation
await def create_user_import_job(
self,
*,
JobName: str,
UserPoolId: str,
CloudWatchLogsRoleArn: str,
) -> CreateUserImportJobResponseTypeDef: # (1)
...
kwargs: CreateUserImportJobRequestRequestTypeDef = { # (1)
"JobName": ...,
"UserPoolId": ...,
"CloudWatchLogsRoleArn": ...,
}
parent.create_user_import_job(**kwargs)
create_user_pool
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
Type annotations and code completion for session.client("cognito-idp").create_user_pool
method.
boto3 documentation
await def create_user_pool(
self,
*,
PoolName: str,
Policies: UserPoolPolicyTypeTypeDef = ..., # (1)
LambdaConfig: LambdaConfigTypeTypeDef = ..., # (2)
AutoVerifiedAttributes: Sequence[VerifiedAttributeTypeType] = ..., # (3)
AliasAttributes: Sequence[AliasAttributeTypeType] = ..., # (4)
UsernameAttributes: Sequence[UsernameAttributeTypeType] = ..., # (5)
SmsVerificationMessage: str = ...,
EmailVerificationMessage: str = ...,
EmailVerificationSubject: str = ...,
VerificationMessageTemplate: VerificationMessageTemplateTypeTypeDef = ..., # (6)
SmsAuthenticationMessage: str = ...,
MfaConfiguration: UserPoolMfaTypeType = ..., # (7)
UserAttributeUpdateSettings: UserAttributeUpdateSettingsTypeTypeDef = ..., # (8)
DeviceConfiguration: DeviceConfigurationTypeTypeDef = ..., # (9)
EmailConfiguration: EmailConfigurationTypeTypeDef = ..., # (10)
SmsConfiguration: SmsConfigurationTypeTypeDef = ..., # (11)
UserPoolTags: Mapping[str, str] = ...,
AdminCreateUserConfig: AdminCreateUserConfigTypeTypeDef = ..., # (12)
Schema: Sequence[SchemaAttributeTypeTypeDef] = ..., # (13)
UserPoolAddOns: UserPoolAddOnsTypeTypeDef = ..., # (14)
UsernameConfiguration: UsernameConfigurationTypeTypeDef = ..., # (15)
AccountRecoverySetting: AccountRecoverySettingTypeTypeDef = ..., # (16)
) -> CreateUserPoolResponseTypeDef: # (17)
...
- See UserPoolPolicyTypeTypeDef
- See LambdaConfigTypeTypeDef
- See VerifiedAttributeTypeType
- See AliasAttributeTypeType
- See UsernameAttributeTypeType
- See VerificationMessageTemplateTypeTypeDef
- See UserPoolMfaTypeType
- See UserAttributeUpdateSettingsTypeTypeDef
- See DeviceConfigurationTypeTypeDef
- See EmailConfigurationTypeTypeDef
- See SmsConfigurationTypeTypeDef
- See AdminCreateUserConfigTypeTypeDef
- See SchemaAttributeTypeTypeDef
- See UserPoolAddOnsTypeTypeDef
- See UsernameConfigurationTypeTypeDef
- See AccountRecoverySettingTypeTypeDef
- See CreateUserPoolResponseTypeDef
kwargs: CreateUserPoolRequestRequestTypeDef = { # (1)
"PoolName": ...,
}
parent.create_user_pool(**kwargs)
create_user_pool_client
Creates the user pool client.
Type annotations and code completion for session.client("cognito-idp").create_user_pool_client
method.
boto3 documentation
await 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 = ...,
) -> CreateUserPoolClientResponseTypeDef: # (6)
...
- See TokenValidityUnitsTypeTypeDef
- See ExplicitAuthFlowsTypeType
- See OAuthFlowTypeType
- See AnalyticsConfigurationTypeTypeDef
- See PreventUserExistenceErrorTypesType
- See CreateUserPoolClientResponseTypeDef
kwargs: CreateUserPoolClientRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ClientName": ...,
}
parent.create_user_pool_client(**kwargs)
create_user_pool_domain
Creates a new domain for a user pool.
Type annotations and code completion for session.client("cognito-idp").create_user_pool_domain
method.
boto3 documentation
await def create_user_pool_domain(
self,
*,
Domain: str,
UserPoolId: str,
CustomDomainConfig: CustomDomainConfigTypeTypeDef = ..., # (1)
) -> CreateUserPoolDomainResponseTypeDef: # (2)
...
kwargs: CreateUserPoolDomainRequestRequestTypeDef = { # (1)
"Domain": ...,
"UserPoolId": ...,
}
parent.create_user_pool_domain(**kwargs)
delete_group
Deletes a group.
Type annotations and code completion for session.client("cognito-idp").delete_group
method.
boto3 documentation
await def delete_group(
self,
*,
GroupName: str,
UserPoolId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"UserPoolId": ...,
}
parent.delete_group(**kwargs)
delete_identity_provider
Deletes an IdP for a user pool.
Type annotations and code completion for session.client("cognito-idp").delete_identity_provider
method.
boto3 documentation
await def delete_identity_provider(
self,
*,
UserPoolId: str,
ProviderName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteIdentityProviderRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ProviderName": ...,
}
parent.delete_identity_provider(**kwargs)
delete_resource_server
Deletes a resource server.
Type annotations and code completion for session.client("cognito-idp").delete_resource_server
method.
boto3 documentation
await def delete_resource_server(
self,
*,
UserPoolId: str,
Identifier: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteResourceServerRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Identifier": ...,
}
parent.delete_resource_server(**kwargs)
delete_user
Allows a user to delete himself or herself.
Type annotations and code completion for session.client("cognito-idp").delete_user
method.
boto3 documentation
await def delete_user(
self,
*,
AccessToken: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"AccessToken": ...,
}
parent.delete_user(**kwargs)
delete_user_attributes
Deletes the attributes for a user.
Type annotations and code completion for session.client("cognito-idp").delete_user_attributes
method.
boto3 documentation
await def delete_user_attributes(
self,
*,
UserAttributeNames: Sequence[str],
AccessToken: str,
) -> Dict[str, Any]:
...
kwargs: DeleteUserAttributesRequestRequestTypeDef = { # (1)
"UserAttributeNames": ...,
"AccessToken": ...,
}
parent.delete_user_attributes(**kwargs)
delete_user_pool
Deletes the specified Amazon Cognito user pool.
Type annotations and code completion for session.client("cognito-idp").delete_user_pool
method.
boto3 documentation
await def delete_user_pool(
self,
*,
UserPoolId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUserPoolRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.delete_user_pool(**kwargs)
delete_user_pool_client
Allows the developer to delete the user pool client.
Type annotations and code completion for session.client("cognito-idp").delete_user_pool_client
method.
boto3 documentation
await def delete_user_pool_client(
self,
*,
UserPoolId: str,
ClientId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUserPoolClientRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ClientId": ...,
}
parent.delete_user_pool_client(**kwargs)
delete_user_pool_domain
Deletes a domain for a user pool.
Type annotations and code completion for session.client("cognito-idp").delete_user_pool_domain
method.
boto3 documentation
await def delete_user_pool_domain(
self,
*,
Domain: str,
UserPoolId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteUserPoolDomainRequestRequestTypeDef = { # (1)
"Domain": ...,
"UserPoolId": ...,
}
parent.delete_user_pool_domain(**kwargs)
describe_identity_provider
Gets information about a specific IdP.
Type annotations and code completion for session.client("cognito-idp").describe_identity_provider
method.
boto3 documentation
await def describe_identity_provider(
self,
*,
UserPoolId: str,
ProviderName: str,
) -> DescribeIdentityProviderResponseTypeDef: # (1)
...
kwargs: DescribeIdentityProviderRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ProviderName": ...,
}
parent.describe_identity_provider(**kwargs)
describe_resource_server
Describes a resource server.
Type annotations and code completion for session.client("cognito-idp").describe_resource_server
method.
boto3 documentation
await def describe_resource_server(
self,
*,
UserPoolId: str,
Identifier: str,
) -> DescribeResourceServerResponseTypeDef: # (1)
...
kwargs: DescribeResourceServerRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Identifier": ...,
}
parent.describe_resource_server(**kwargs)
describe_risk_configuration
Describes the risk configuration.
Type annotations and code completion for session.client("cognito-idp").describe_risk_configuration
method.
boto3 documentation
await def describe_risk_configuration(
self,
*,
UserPoolId: str,
ClientId: str = ...,
) -> DescribeRiskConfigurationResponseTypeDef: # (1)
...
kwargs: DescribeRiskConfigurationRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.describe_risk_configuration(**kwargs)
describe_user_import_job
Describes the user import job.
Type annotations and code completion for session.client("cognito-idp").describe_user_import_job
method.
boto3 documentation
await def describe_user_import_job(
self,
*,
UserPoolId: str,
JobId: str,
) -> DescribeUserImportJobResponseTypeDef: # (1)
...
kwargs: DescribeUserImportJobRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"JobId": ...,
}
parent.describe_user_import_job(**kwargs)
describe_user_pool
Returns the configuration information and metadata of the specified user pool.
Type annotations and code completion for session.client("cognito-idp").describe_user_pool
method.
boto3 documentation
await def describe_user_pool(
self,
*,
UserPoolId: str,
) -> DescribeUserPoolResponseTypeDef: # (1)
...
kwargs: DescribeUserPoolRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.describe_user_pool(**kwargs)
describe_user_pool_client
Client method for returning the configuration information and metadata of the specified user pool app client.
Type annotations and code completion for session.client("cognito-idp").describe_user_pool_client
method.
boto3 documentation
await def describe_user_pool_client(
self,
*,
UserPoolId: str,
ClientId: str,
) -> DescribeUserPoolClientResponseTypeDef: # (1)
...
kwargs: DescribeUserPoolClientRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ClientId": ...,
}
parent.describe_user_pool_client(**kwargs)
describe_user_pool_domain
Gets information about a domain.
Type annotations and code completion for session.client("cognito-idp").describe_user_pool_domain
method.
boto3 documentation
await def describe_user_pool_domain(
self,
*,
Domain: str,
) -> DescribeUserPoolDomainResponseTypeDef: # (1)
...
kwargs: DescribeUserPoolDomainRequestRequestTypeDef = { # (1)
"Domain": ...,
}
parent.describe_user_pool_domain(**kwargs)
forget_device
Forgets the specified device.
Type annotations and code completion for session.client("cognito-idp").forget_device
method.
boto3 documentation
await def forget_device(
self,
*,
DeviceKey: str,
AccessToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: ForgetDeviceRequestRequestTypeDef = { # (1)
"DeviceKey": ...,
}
parent.forget_device(**kwargs)
forgot_password
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password.
Type annotations and code completion for session.client("cognito-idp").forgot_password
method.
boto3 documentation
await def forgot_password(
self,
*,
ClientId: str,
Username: str,
SecretHash: str = ...,
UserContextData: UserContextDataTypeTypeDef = ..., # (1)
AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ..., # (2)
ClientMetadata: Mapping[str, str] = ...,
) -> ForgotPasswordResponseTypeDef: # (3)
...
kwargs: ForgotPasswordRequestRequestTypeDef = { # (1)
"ClientId": ...,
"Username": ...,
}
parent.forgot_password(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("cognito-idp").generate_presigned_url
method.
boto3 documentation
await 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 session.client("cognito-idp").get_csv_header
method.
boto3 documentation
await def get_csv_header(
self,
*,
UserPoolId: str,
) -> GetCSVHeaderResponseTypeDef: # (1)
...
kwargs: GetCSVHeaderRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.get_csv_header(**kwargs)
get_device
Gets the device.
Type annotations and code completion for session.client("cognito-idp").get_device
method.
boto3 documentation
await def get_device(
self,
*,
DeviceKey: str,
AccessToken: str = ...,
) -> GetDeviceResponseTypeDef: # (1)
...
kwargs: GetDeviceRequestRequestTypeDef = { # (1)
"DeviceKey": ...,
}
parent.get_device(**kwargs)
get_group
Gets a group.
Type annotations and code completion for session.client("cognito-idp").get_group
method.
boto3 documentation
await def get_group(
self,
*,
GroupName: str,
UserPoolId: str,
) -> GetGroupResponseTypeDef: # (1)
...
kwargs: GetGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"UserPoolId": ...,
}
parent.get_group(**kwargs)
get_identity_provider_by_identifier
Gets the specified IdP.
Type annotations and code completion for session.client("cognito-idp").get_identity_provider_by_identifier
method.
boto3 documentation
await def get_identity_provider_by_identifier(
self,
*,
UserPoolId: str,
IdpIdentifier: str,
) -> GetIdentityProviderByIdentifierResponseTypeDef: # (1)
...
kwargs: GetIdentityProviderByIdentifierRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"IdpIdentifier": ...,
}
parent.get_identity_provider_by_identifier(**kwargs)
get_signing_certificate
This method takes a user pool ID, and returns the signing certificate.
Type annotations and code completion for session.client("cognito-idp").get_signing_certificate
method.
boto3 documentation
await def get_signing_certificate(
self,
*,
UserPoolId: str,
) -> GetSigningCertificateResponseTypeDef: # (1)
...
kwargs: GetSigningCertificateRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.get_signing_certificate(**kwargs)
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 session.client("cognito-idp").get_ui_customization
method.
boto3 documentation
await def get_ui_customization(
self,
*,
UserPoolId: str,
ClientId: str = ...,
) -> GetUICustomizationResponseTypeDef: # (1)
...
kwargs: GetUICustomizationRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.get_ui_customization(**kwargs)
get_user
Gets the user attributes and metadata for a user.
Type annotations and code completion for session.client("cognito-idp").get_user
method.
boto3 documentation
await def get_user(
self,
*,
AccessToken: str,
) -> GetUserResponseTypeDef: # (1)
...
kwargs: GetUserRequestRequestTypeDef = { # (1)
"AccessToken": ...,
}
parent.get_user(**kwargs)
get_user_attribute_verification_code
Generates a user attribute verification code for the specified attribute name.
Type annotations and code completion for session.client("cognito-idp").get_user_attribute_verification_code
method.
boto3 documentation
await def get_user_attribute_verification_code(
self,
*,
AccessToken: str,
AttributeName: str,
ClientMetadata: Mapping[str, str] = ...,
) -> GetUserAttributeVerificationCodeResponseTypeDef: # (1)
...
kwargs: GetUserAttributeVerificationCodeRequestRequestTypeDef = { # (1)
"AccessToken": ...,
"AttributeName": ...,
}
parent.get_user_attribute_verification_code(**kwargs)
get_user_pool_mfa_config
Gets the user pool multi-factor authentication (MFA) configuration.
Type annotations and code completion for session.client("cognito-idp").get_user_pool_mfa_config
method.
boto3 documentation
await def get_user_pool_mfa_config(
self,
*,
UserPoolId: str,
) -> GetUserPoolMfaConfigResponseTypeDef: # (1)
...
kwargs: GetUserPoolMfaConfigRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.get_user_pool_mfa_config(**kwargs)
global_sign_out
Signs out users from all devices.
Type annotations and code completion for session.client("cognito-idp").global_sign_out
method.
boto3 documentation
kwargs: GlobalSignOutRequestRequestTypeDef = { # (1)
"AccessToken": ...,
}
parent.global_sign_out(**kwargs)
initiate_auth
Initiates sign-in for a user in the Amazon Cognito user directory.
Type annotations and code completion for session.client("cognito-idp").initiate_auth
method.
boto3 documentation
await 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)
...
- See AuthFlowTypeType
- See AnalyticsMetadataTypeTypeDef
- See UserContextDataTypeTypeDef
- See InitiateAuthResponseTypeDef
kwargs: InitiateAuthRequestRequestTypeDef = { # (1)
"AuthFlow": ...,
"ClientId": ...,
}
parent.initiate_auth(**kwargs)
list_devices
Lists the sign-in devices that Amazon Cognito has registered to the current user.
Type annotations and code completion for session.client("cognito-idp").list_devices
method.
boto3 documentation
await def list_devices(
self,
*,
AccessToken: str,
Limit: int = ...,
PaginationToken: str = ...,
) -> ListDevicesResponseTypeDef: # (1)
...
kwargs: ListDevicesRequestRequestTypeDef = { # (1)
"AccessToken": ...,
}
parent.list_devices(**kwargs)
list_groups
Lists the groups associated with a user pool.
Type annotations and code completion for session.client("cognito-idp").list_groups
method.
boto3 documentation
await def list_groups(
self,
*,
UserPoolId: str,
Limit: int = ...,
NextToken: str = ...,
) -> ListGroupsResponseTypeDef: # (1)
...
kwargs: ListGroupsRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.list_groups(**kwargs)
list_identity_providers
Lists information about all IdPs for a user pool.
Type annotations and code completion for session.client("cognito-idp").list_identity_providers
method.
boto3 documentation
await def list_identity_providers(
self,
*,
UserPoolId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListIdentityProvidersResponseTypeDef: # (1)
...
kwargs: ListIdentityProvidersRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.list_identity_providers(**kwargs)
list_resource_servers
Lists the resource servers for a user pool.
Type annotations and code completion for session.client("cognito-idp").list_resource_servers
method.
boto3 documentation
await def list_resource_servers(
self,
*,
UserPoolId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListResourceServersResponseTypeDef: # (1)
...
kwargs: ListResourceServersRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.list_resource_servers(**kwargs)
list_tags_for_resource
Lists the tags that are assigned to an Amazon Cognito user pool.
Type annotations and code completion for session.client("cognito-idp").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_user_import_jobs
Lists the user import jobs.
Type annotations and code completion for session.client("cognito-idp").list_user_import_jobs
method.
boto3 documentation
await def list_user_import_jobs(
self,
*,
UserPoolId: str,
MaxResults: int,
PaginationToken: str = ...,
) -> ListUserImportJobsResponseTypeDef: # (1)
...
kwargs: ListUserImportJobsRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"MaxResults": ...,
}
parent.list_user_import_jobs(**kwargs)
list_user_pool_clients
Lists the clients that have been created for the specified user pool.
Type annotations and code completion for session.client("cognito-idp").list_user_pool_clients
method.
boto3 documentation
await def list_user_pool_clients(
self,
*,
UserPoolId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListUserPoolClientsResponseTypeDef: # (1)
...
kwargs: ListUserPoolClientsRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.list_user_pool_clients(**kwargs)
list_user_pools
Lists the user pools associated with an Amazon Web Services account.
Type annotations and code completion for session.client("cognito-idp").list_user_pools
method.
boto3 documentation
await def list_user_pools(
self,
*,
MaxResults: int,
NextToken: str = ...,
) -> ListUserPoolsResponseTypeDef: # (1)
...
kwargs: ListUserPoolsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_user_pools(**kwargs)
list_users
Lists the users in the Amazon Cognito user pool.
Type annotations and code completion for session.client("cognito-idp").list_users
method.
boto3 documentation
await def list_users(
self,
*,
UserPoolId: str,
AttributesToGet: Sequence[str] = ...,
Limit: int = ...,
PaginationToken: str = ...,
Filter: str = ...,
) -> ListUsersResponseTypeDef: # (1)
...
kwargs: ListUsersRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.list_users(**kwargs)
list_users_in_group
Lists the users in the specified group.
Type annotations and code completion for session.client("cognito-idp").list_users_in_group
method.
boto3 documentation
await def list_users_in_group(
self,
*,
UserPoolId: str,
GroupName: str,
Limit: int = ...,
NextToken: str = ...,
) -> ListUsersInGroupResponseTypeDef: # (1)
...
kwargs: ListUsersInGroupRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"GroupName": ...,
}
parent.list_users_in_group(**kwargs)
resend_confirmation_code
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
Type annotations and code completion for session.client("cognito-idp").resend_confirmation_code
method.
boto3 documentation
await def resend_confirmation_code(
self,
*,
ClientId: str,
Username: str,
SecretHash: str = ...,
UserContextData: UserContextDataTypeTypeDef = ..., # (1)
AnalyticsMetadata: AnalyticsMetadataTypeTypeDef = ..., # (2)
ClientMetadata: Mapping[str, str] = ...,
) -> ResendConfirmationCodeResponseTypeDef: # (3)
...
- See UserContextDataTypeTypeDef
- See AnalyticsMetadataTypeTypeDef
- See ResendConfirmationCodeResponseTypeDef
kwargs: ResendConfirmationCodeRequestRequestTypeDef = { # (1)
"ClientId": ...,
"Username": ...,
}
parent.resend_confirmation_code(**kwargs)
respond_to_auth_challenge
Responds to the authentication challenge.
Type annotations and code completion for session.client("cognito-idp").respond_to_auth_challenge
method.
boto3 documentation
await 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)
...
- See ChallengeNameTypeType
- See AnalyticsMetadataTypeTypeDef
- See UserContextDataTypeTypeDef
- See RespondToAuthChallengeResponseTypeDef
kwargs: RespondToAuthChallengeRequestRequestTypeDef = { # (1)
"ClientId": ...,
"ChallengeName": ...,
}
parent.respond_to_auth_challenge(**kwargs)
revoke_token
Revokes all of the access tokens generated by the specified refresh token.
Type annotations and code completion for session.client("cognito-idp").revoke_token
method.
boto3 documentation
await def revoke_token(
self,
*,
Token: str,
ClientId: str,
ClientSecret: str = ...,
) -> Dict[str, Any]:
...
kwargs: RevokeTokenRequestRequestTypeDef = { # (1)
"Token": ...,
"ClientId": ...,
}
parent.revoke_token(**kwargs)
set_risk_configuration
Configures actions on detected risks.
Type annotations and code completion for session.client("cognito-idp").set_risk_configuration
method.
boto3 documentation
await def set_risk_configuration(
self,
*,
UserPoolId: str,
ClientId: str = ...,
CompromisedCredentialsRiskConfiguration: CompromisedCredentialsRiskConfigurationTypeTypeDef = ..., # (1)
AccountTakeoverRiskConfiguration: AccountTakeoverRiskConfigurationTypeTypeDef = ..., # (2)
RiskExceptionConfiguration: RiskExceptionConfigurationTypeTypeDef = ..., # (3)
) -> SetRiskConfigurationResponseTypeDef: # (4)
...
- See CompromisedCredentialsRiskConfigurationTypeTypeDef
- See AccountTakeoverRiskConfigurationTypeTypeDef
- See RiskExceptionConfigurationTypeTypeDef
- See SetRiskConfigurationResponseTypeDef
kwargs: SetRiskConfigurationRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.set_risk_configuration(**kwargs)
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 session.client("cognito-idp").set_ui_customization
method.
boto3 documentation
await def set_ui_customization(
self,
*,
UserPoolId: str,
ClientId: str = ...,
CSS: str = ...,
ImageFile: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> SetUICustomizationResponseTypeDef: # (1)
...
kwargs: SetUICustomizationRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.set_ui_customization(**kwargs)
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 session.client("cognito-idp").set_user_mfa_preference
method.
boto3 documentation
await def set_user_mfa_preference(
self,
*,
AccessToken: str,
SMSMfaSettings: SMSMfaSettingsTypeTypeDef = ..., # (1)
SoftwareTokenMfaSettings: SoftwareTokenMfaSettingsTypeTypeDef = ..., # (2)
) -> Dict[str, Any]:
...
kwargs: SetUserMFAPreferenceRequestRequestTypeDef = { # (1)
"AccessToken": ...,
}
parent.set_user_mfa_preference(**kwargs)
set_user_pool_mfa_config
Sets the user pool multi-factor authentication (MFA) configuration.
Type annotations and code completion for session.client("cognito-idp").set_user_pool_mfa_config
method.
boto3 documentation
await def set_user_pool_mfa_config(
self,
*,
UserPoolId: str,
SmsMfaConfiguration: SmsMfaConfigTypeTypeDef = ..., # (1)
SoftwareTokenMfaConfiguration: SoftwareTokenMfaConfigTypeTypeDef = ..., # (2)
MfaConfiguration: UserPoolMfaTypeType = ..., # (3)
) -> SetUserPoolMfaConfigResponseTypeDef: # (4)
...
- See SmsMfaConfigTypeTypeDef
- See SoftwareTokenMfaConfigTypeTypeDef
- See UserPoolMfaTypeType
- See SetUserPoolMfaConfigResponseTypeDef
kwargs: SetUserPoolMfaConfigRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.set_user_pool_mfa_config(**kwargs)
set_user_settings
This action is no longer supported. You can use it to configure only SMS MFA.
Type annotations and code completion for session.client("cognito-idp").set_user_settings
method.
boto3 documentation
await def set_user_settings(
self,
*,
AccessToken: str,
MFAOptions: Sequence[MFAOptionTypeTypeDef], # (1)
) -> Dict[str, Any]:
...
kwargs: SetUserSettingsRequestRequestTypeDef = { # (1)
"AccessToken": ...,
"MFAOptions": ...,
}
parent.set_user_settings(**kwargs)
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 session.client("cognito-idp").sign_up
method.
boto3 documentation
await 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)
...
- See AttributeTypeTypeDef
- See AttributeTypeTypeDef
- See AnalyticsMetadataTypeTypeDef
- See UserContextDataTypeTypeDef
- See SignUpResponseTypeDef
kwargs: SignUpRequestRequestTypeDef = { # (1)
"ClientId": ...,
"Username": ...,
"Password": ...,
}
parent.sign_up(**kwargs)
start_user_import_job
Starts the user import.
Type annotations and code completion for session.client("cognito-idp").start_user_import_job
method.
boto3 documentation
await def start_user_import_job(
self,
*,
UserPoolId: str,
JobId: str,
) -> StartUserImportJobResponseTypeDef: # (1)
...
kwargs: StartUserImportJobRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"JobId": ...,
}
parent.start_user_import_job(**kwargs)
stop_user_import_job
Stops the user import job.
Type annotations and code completion for session.client("cognito-idp").stop_user_import_job
method.
boto3 documentation
await def stop_user_import_job(
self,
*,
UserPoolId: str,
JobId: str,
) -> StopUserImportJobResponseTypeDef: # (1)
...
kwargs: StopUserImportJobRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"JobId": ...,
}
parent.stop_user_import_job(**kwargs)
tag_resource
Assigns a set of tags to an Amazon Cognito user pool.
Type annotations and code completion for session.client("cognito-idp").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes the specified tags from an Amazon Cognito user pool.
Type annotations and code completion for session.client("cognito-idp").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
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 session.client("cognito-idp").update_auth_event_feedback
method.
boto3 documentation
await def update_auth_event_feedback(
self,
*,
UserPoolId: str,
Username: str,
EventId: str,
FeedbackToken: str,
FeedbackValue: FeedbackValueTypeType, # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateAuthEventFeedbackRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Username": ...,
"EventId": ...,
"FeedbackToken": ...,
"FeedbackValue": ...,
}
parent.update_auth_event_feedback(**kwargs)
update_device_status
Updates the device status.
Type annotations and code completion for session.client("cognito-idp").update_device_status
method.
boto3 documentation
await def update_device_status(
self,
*,
AccessToken: str,
DeviceKey: str,
DeviceRememberedStatus: DeviceRememberedStatusTypeType = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateDeviceStatusRequestRequestTypeDef = { # (1)
"AccessToken": ...,
"DeviceKey": ...,
}
parent.update_device_status(**kwargs)
update_group
Updates the specified group with the specified attributes.
Type annotations and code completion for session.client("cognito-idp").update_group
method.
boto3 documentation
await def update_group(
self,
*,
GroupName: str,
UserPoolId: str,
Description: str = ...,
RoleArn: str = ...,
Precedence: int = ...,
) -> UpdateGroupResponseTypeDef: # (1)
...
kwargs: UpdateGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"UserPoolId": ...,
}
parent.update_group(**kwargs)
update_identity_provider
Updates IdP information for a user pool.
Type annotations and code completion for session.client("cognito-idp").update_identity_provider
method.
boto3 documentation
await def update_identity_provider(
self,
*,
UserPoolId: str,
ProviderName: str,
ProviderDetails: Mapping[str, str] = ...,
AttributeMapping: Mapping[str, str] = ...,
IdpIdentifiers: Sequence[str] = ...,
) -> UpdateIdentityProviderResponseTypeDef: # (1)
...
kwargs: UpdateIdentityProviderRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ProviderName": ...,
}
parent.update_identity_provider(**kwargs)
update_resource_server
Updates the name and scopes of resource server.
Type annotations and code completion for session.client("cognito-idp").update_resource_server
method.
boto3 documentation
await def update_resource_server(
self,
*,
UserPoolId: str,
Identifier: str,
Name: str,
Scopes: Sequence[ResourceServerScopeTypeTypeDef] = ..., # (1)
) -> UpdateResourceServerResponseTypeDef: # (2)
...
kwargs: UpdateResourceServerRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"Identifier": ...,
"Name": ...,
}
parent.update_resource_server(**kwargs)
update_user_attributes
Allows a user to update a specific attribute (one at a time).
Type annotations and code completion for session.client("cognito-idp").update_user_attributes
method.
boto3 documentation
await def update_user_attributes(
self,
*,
UserAttributes: Sequence[AttributeTypeTypeDef], # (1)
AccessToken: str,
ClientMetadata: Mapping[str, str] = ...,
) -> UpdateUserAttributesResponseTypeDef: # (2)
...
kwargs: UpdateUserAttributesRequestRequestTypeDef = { # (1)
"UserAttributes": ...,
"AccessToken": ...,
}
parent.update_user_attributes(**kwargs)
update_user_pool
Updates the specified user pool with the specified attributes.
Type annotations and code completion for session.client("cognito-idp").update_user_pool
method.
boto3 documentation
await def update_user_pool(
self,
*,
UserPoolId: str,
Policies: UserPoolPolicyTypeTypeDef = ..., # (1)
LambdaConfig: LambdaConfigTypeTypeDef = ..., # (2)
AutoVerifiedAttributes: Sequence[VerifiedAttributeTypeType] = ..., # (3)
SmsVerificationMessage: str = ...,
EmailVerificationMessage: str = ...,
EmailVerificationSubject: str = ...,
VerificationMessageTemplate: VerificationMessageTemplateTypeTypeDef = ..., # (4)
SmsAuthenticationMessage: str = ...,
UserAttributeUpdateSettings: UserAttributeUpdateSettingsTypeTypeDef = ..., # (5)
MfaConfiguration: UserPoolMfaTypeType = ..., # (6)
DeviceConfiguration: DeviceConfigurationTypeTypeDef = ..., # (7)
EmailConfiguration: EmailConfigurationTypeTypeDef = ..., # (8)
SmsConfiguration: SmsConfigurationTypeTypeDef = ..., # (9)
UserPoolTags: Mapping[str, str] = ...,
AdminCreateUserConfig: AdminCreateUserConfigTypeTypeDef = ..., # (10)
UserPoolAddOns: UserPoolAddOnsTypeTypeDef = ..., # (11)
AccountRecoverySetting: AccountRecoverySettingTypeTypeDef = ..., # (12)
) -> Dict[str, Any]:
...
- See UserPoolPolicyTypeTypeDef
- See LambdaConfigTypeTypeDef
- See VerifiedAttributeTypeType
- See VerificationMessageTemplateTypeTypeDef
- See UserAttributeUpdateSettingsTypeTypeDef
- See UserPoolMfaTypeType
- See DeviceConfigurationTypeTypeDef
- See EmailConfigurationTypeTypeDef
- See SmsConfigurationTypeTypeDef
- See AdminCreateUserConfigTypeTypeDef
- See UserPoolAddOnsTypeTypeDef
- See AccountRecoverySettingTypeTypeDef
kwargs: UpdateUserPoolRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
}
parent.update_user_pool(**kwargs)
update_user_pool_client
Updates the specified user pool app client with the specified attributes.
Type annotations and code completion for session.client("cognito-idp").update_user_pool_client
method.
boto3 documentation
await 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 = ...,
) -> UpdateUserPoolClientResponseTypeDef: # (6)
...
- See TokenValidityUnitsTypeTypeDef
- See ExplicitAuthFlowsTypeType
- See OAuthFlowTypeType
- See AnalyticsConfigurationTypeTypeDef
- See PreventUserExistenceErrorTypesType
- See UpdateUserPoolClientResponseTypeDef
kwargs: UpdateUserPoolClientRequestRequestTypeDef = { # (1)
"UserPoolId": ...,
"ClientId": ...,
}
parent.update_user_pool_client(**kwargs)
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 session.client("cognito-idp").update_user_pool_domain
method.
boto3 documentation
await def update_user_pool_domain(
self,
*,
Domain: str,
UserPoolId: str,
CustomDomainConfig: CustomDomainConfigTypeTypeDef, # (1)
) -> UpdateUserPoolDomainResponseTypeDef: # (2)
...
kwargs: UpdateUserPoolDomainRequestRequestTypeDef = { # (1)
"Domain": ...,
"UserPoolId": ...,
"CustomDomainConfig": ...,
}
parent.update_user_pool_domain(**kwargs)
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 session.client("cognito-idp").verify_software_token
method.
boto3 documentation
await def verify_software_token(
self,
*,
UserCode: str,
AccessToken: str = ...,
Session: str = ...,
FriendlyDeviceName: str = ...,
) -> VerifySoftwareTokenResponseTypeDef: # (1)
...
kwargs: VerifySoftwareTokenRequestRequestTypeDef = { # (1)
"UserCode": ...,
}
parent.verify_software_token(**kwargs)
verify_user_attribute
Verifies the specified user attributes in the user pool.
Type annotations and code completion for session.client("cognito-idp").verify_user_attribute
method.
boto3 documentation
await def verify_user_attribute(
self,
*,
AccessToken: str,
AttributeName: str,
Code: str,
) -> Dict[str, Any]:
...
kwargs: VerifyUserAttributeRequestRequestTypeDef = { # (1)
"AccessToken": ...,
"AttributeName": ...,
"Code": ...,
}
parent.verify_user_attribute(**kwargs)
__aenter__
Type annotations and code completion for session.client("cognito-idp").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("cognito-idp").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("cognito-idp").get_paginator
method with overloads.
client.get_paginator("admin_list_groups_for_user")
-> AdminListGroupsForUserPaginatorclient.get_paginator("admin_list_user_auth_events")
-> AdminListUserAuthEventsPaginatorclient.get_paginator("list_groups")
-> ListGroupsPaginatorclient.get_paginator("list_identity_providers")
-> ListIdentityProvidersPaginatorclient.get_paginator("list_resource_servers")
-> ListResourceServersPaginatorclient.get_paginator("list_user_pool_clients")
-> ListUserPoolClientsPaginatorclient.get_paginator("list_user_pools")
-> ListUserPoolsPaginatorclient.get_paginator("list_users")
-> ListUsersPaginatorclient.get_paginator("list_users_in_group")
-> ListUsersInGroupPaginator