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
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.
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)
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
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 boto3.client("cognito-idp").admin_add_user_to_group
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_confirm_sign_up
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_create_user
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_delete_user
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_delete_user_attributes
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_disable_provider_for_user
method.
boto3 documentation
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
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
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 boto3.client("cognito-idp").admin_enable_user
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_forget_device
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_get_device
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_get_user
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_initiate_auth
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_link_provider_for_user
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_list_devices
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_list_groups_for_user
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_list_user_auth_events
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_remove_user_from_group
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_reset_user_password
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_respond_to_auth_challenge
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_set_user_mfa_preference
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_set_user_password
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_set_user_settings
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_update_auth_event_feedback
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_update_device_status
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_update_user_attributes
method.
boto3 documentation
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 boto3.client("cognito-idp").admin_user_global_sign_out
method.
boto3 documentation
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 boto3.client("cognito-idp").associate_software_token
method.
boto3 documentation
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 boto3.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 boto3.client("cognito-idp").change_password
method.
boto3 documentation
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 boto3.client("cognito-idp").close
method.
boto3 documentation
confirm_device
Confirms tracking of the device.
Type annotations and code completion for boto3.client("cognito-idp").confirm_device
method.
boto3 documentation
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 boto3.client("cognito-idp").confirm_forgot_password
method.
boto3 documentation
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 boto3.client("cognito-idp").confirm_sign_up
method.
boto3 documentation
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 boto3.client("cognito-idp").create_group
method.
boto3 documentation
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 boto3.client("cognito-idp").create_identity_provider
method.
boto3 documentation
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 boto3.client("cognito-idp").create_resource_server
method.
boto3 documentation
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 boto3.client("cognito-idp").create_user_import_job
method.
boto3 documentation
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 boto3.client("cognito-idp").create_user_pool
method.
boto3 documentation
def create_user_pool(
self,
*,
PoolName: str,
Policies: UserPoolPolicyTypeTypeDef = ..., # (1)
DeletionProtection: DeletionProtectionTypeType = ..., # (2)
LambdaConfig: LambdaConfigTypeTypeDef = ..., # (3)
AutoVerifiedAttributes: Sequence[VerifiedAttributeTypeType] = ..., # (4)
AliasAttributes: Sequence[AliasAttributeTypeType] = ..., # (5)
UsernameAttributes: Sequence[UsernameAttributeTypeType] = ..., # (6)
SmsVerificationMessage: str = ...,
EmailVerificationMessage: str = ...,
EmailVerificationSubject: str = ...,
VerificationMessageTemplate: VerificationMessageTemplateTypeTypeDef = ..., # (7)
SmsAuthenticationMessage: str = ...,
MfaConfiguration: UserPoolMfaTypeType = ..., # (8)
UserAttributeUpdateSettings: UserAttributeUpdateSettingsTypeTypeDef = ..., # (9)
DeviceConfiguration: DeviceConfigurationTypeTypeDef = ..., # (10)
EmailConfiguration: EmailConfigurationTypeTypeDef = ..., # (11)
SmsConfiguration: SmsConfigurationTypeTypeDef = ..., # (12)
UserPoolTags: Mapping[str, str] = ...,
AdminCreateUserConfig: AdminCreateUserConfigTypeTypeDef = ..., # (13)
Schema: Sequence[SchemaAttributeTypeTypeDef] = ..., # (14)
UserPoolAddOns: UserPoolAddOnsTypeTypeDef = ..., # (15)
UsernameConfiguration: UsernameConfigurationTypeTypeDef = ..., # (16)
AccountRecoverySetting: AccountRecoverySettingTypeTypeDef = ..., # (17)
) -> CreateUserPoolResponseTypeDef: # (18)
...
- See UserPoolPolicyTypeTypeDef
- See DeletionProtectionTypeType
- See LambdaConfigTypeTypeDef
- See VerifiedAttributeTypeType
- See AliasAttributeTypeType
- See UsernameAttributeTypeType
- See VerificationMessageTemplateTypeTypeDef
- See UserPoolMfaTypeType
- See UserAttributeUpdateSettingsTypeTypeDef
- See DeviceConfigurationTypeTypeDef
- See EmailConfigurationTypeTypeDef
- See SmsConfigurationTypeTypeDef
- See AdminCreateUserConfigTypeTypeDef
- See SchemaAttributeTypeTypeDef
- See UserPoolAddOnsTypeTypeDef
- See UsernameConfigurationTypeTypeDef
- See AccountRecoverySettingTypeTypeDef
- See