Type definitions#
Index > CognitoIdentityProvider > Type definitions
Auto-generated documentation for CognitoIdentityProvider type annotations stubs module mypy-boto3-cognito-idp.
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
RecoveryOptionTypeTypeDef#
# RecoveryOptionTypeTypeDef definition
class RecoveryOptionTypeTypeDef(TypedDict):
Priority: int,
Name: RecoveryOptionNameTypeType, # (1)
AccountTakeoverActionTypeTypeDef#
# AccountTakeoverActionTypeTypeDef definition
class AccountTakeoverActionTypeTypeDef(TypedDict):
Notify: bool,
EventAction: AccountTakeoverEventActionTypeType, # (1)
AdminAddUserToGroupRequestRequestTypeDef#
# AdminAddUserToGroupRequestRequestTypeDef definition
class AdminAddUserToGroupRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
GroupName: str,
AdminConfirmSignUpRequestRequestTypeDef#
# AdminConfirmSignUpRequestRequestTypeDef definition
class AdminConfirmSignUpRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
ClientMetadata: NotRequired[Mapping[str, str]],
MessageTemplateTypeTypeDef#
# MessageTemplateTypeTypeDef definition
class MessageTemplateTypeTypeDef(TypedDict):
SMSMessage: NotRequired[str],
EmailMessage: NotRequired[str],
EmailSubject: NotRequired[str],
AttributeTypeTypeDef#
# AttributeTypeTypeDef definition
class AttributeTypeTypeDef(TypedDict):
Name: str,
Value: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
AdminDeleteUserAttributesRequestRequestTypeDef#
# AdminDeleteUserAttributesRequestRequestTypeDef definition
class AdminDeleteUserAttributesRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
UserAttributeNames: Sequence[str],
AdminDeleteUserRequestRequestTypeDef#
# AdminDeleteUserRequestRequestTypeDef definition
class AdminDeleteUserRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
ProviderUserIdentifierTypeTypeDef#
# ProviderUserIdentifierTypeTypeDef definition
class ProviderUserIdentifierTypeTypeDef(TypedDict):
ProviderName: NotRequired[str],
ProviderAttributeName: NotRequired[str],
ProviderAttributeValue: NotRequired[str],
AdminDisableUserRequestRequestTypeDef#
# AdminDisableUserRequestRequestTypeDef definition
class AdminDisableUserRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
AdminEnableUserRequestRequestTypeDef#
# AdminEnableUserRequestRequestTypeDef definition
class AdminEnableUserRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
AdminForgetDeviceRequestRequestTypeDef#
# AdminForgetDeviceRequestRequestTypeDef definition
class AdminForgetDeviceRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
DeviceKey: str,
AdminGetDeviceRequestRequestTypeDef#
# AdminGetDeviceRequestRequestTypeDef definition
class AdminGetDeviceRequestRequestTypeDef(TypedDict):
DeviceKey: str,
UserPoolId: str,
Username: str,
AdminGetUserRequestRequestTypeDef#
# AdminGetUserRequestRequestTypeDef definition
class AdminGetUserRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
MFAOptionTypeTypeDef#
# MFAOptionTypeTypeDef definition
class MFAOptionTypeTypeDef(TypedDict):
DeliveryMedium: NotRequired[DeliveryMediumTypeType], # (1)
AttributeName: NotRequired[str],
AnalyticsMetadataTypeTypeDef#
# AnalyticsMetadataTypeTypeDef definition
class AnalyticsMetadataTypeTypeDef(TypedDict):
AnalyticsEndpointId: NotRequired[str],
AdminListDevicesRequestRequestTypeDef#
# AdminListDevicesRequestRequestTypeDef definition
class AdminListDevicesRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
Limit: NotRequired[int],
PaginationToken: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
AdminListGroupsForUserRequestRequestTypeDef#
# AdminListGroupsForUserRequestRequestTypeDef definition
class AdminListGroupsForUserRequestRequestTypeDef(TypedDict):
Username: str,
UserPoolId: str,
Limit: NotRequired[int],
NextToken: NotRequired[str],
GroupTypeTypeDef#
# GroupTypeTypeDef definition
class GroupTypeTypeDef(TypedDict):
GroupName: NotRequired[str],
UserPoolId: NotRequired[str],
Description: NotRequired[str],
RoleArn: NotRequired[str],
Precedence: NotRequired[int],
LastModifiedDate: NotRequired[datetime],
CreationDate: NotRequired[datetime],
AdminListUserAuthEventsRequestRequestTypeDef#
# AdminListUserAuthEventsRequestRequestTypeDef definition
class AdminListUserAuthEventsRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
AdminRemoveUserFromGroupRequestRequestTypeDef#
# AdminRemoveUserFromGroupRequestRequestTypeDef definition
class AdminRemoveUserFromGroupRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
GroupName: str,
AdminResetUserPasswordRequestRequestTypeDef#
# AdminResetUserPasswordRequestRequestTypeDef definition
class AdminResetUserPasswordRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
ClientMetadata: NotRequired[Mapping[str, str]],
SMSMfaSettingsTypeTypeDef#
# SMSMfaSettingsTypeTypeDef definition
class SMSMfaSettingsTypeTypeDef(TypedDict):
Enabled: NotRequired[bool],
PreferredMfa: NotRequired[bool],
SoftwareTokenMfaSettingsTypeTypeDef#
# SoftwareTokenMfaSettingsTypeTypeDef definition
class SoftwareTokenMfaSettingsTypeTypeDef(TypedDict):
Enabled: NotRequired[bool],
PreferredMfa: NotRequired[bool],
AdminSetUserPasswordRequestRequestTypeDef#
# AdminSetUserPasswordRequestRequestTypeDef definition
class AdminSetUserPasswordRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
Password: str,
Permanent: NotRequired[bool],
AdminUpdateAuthEventFeedbackRequestRequestTypeDef#
# AdminUpdateAuthEventFeedbackRequestRequestTypeDef definition
class AdminUpdateAuthEventFeedbackRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
EventId: str,
FeedbackValue: FeedbackValueTypeType, # (1)
AdminUpdateDeviceStatusRequestRequestTypeDef#
# AdminUpdateDeviceStatusRequestRequestTypeDef definition
class AdminUpdateDeviceStatusRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
DeviceKey: str,
DeviceRememberedStatus: NotRequired[DeviceRememberedStatusTypeType], # (1)
AdminUserGlobalSignOutRequestRequestTypeDef#
# AdminUserGlobalSignOutRequestRequestTypeDef definition
class AdminUserGlobalSignOutRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
AnalyticsConfigurationTypeTypeDef#
# AnalyticsConfigurationTypeTypeDef definition
class AnalyticsConfigurationTypeTypeDef(TypedDict):
ApplicationId: NotRequired[str],
ApplicationArn: NotRequired[str],
RoleArn: NotRequired[str],
ExternalId: NotRequired[str],
UserDataShared: NotRequired[bool],
AssociateSoftwareTokenRequestRequestTypeDef#
# AssociateSoftwareTokenRequestRequestTypeDef definition
class AssociateSoftwareTokenRequestRequestTypeDef(TypedDict):
AccessToken: NotRequired[str],
Session: NotRequired[str],
ChallengeResponseTypeTypeDef#
# ChallengeResponseTypeTypeDef definition
class ChallengeResponseTypeTypeDef(TypedDict):
ChallengeName: NotRequired[ChallengeNameType], # (1)
ChallengeResponse: NotRequired[ChallengeResponseType], # (2)
EventContextDataTypeTypeDef#
# EventContextDataTypeTypeDef definition
class EventContextDataTypeTypeDef(TypedDict):
IpAddress: NotRequired[str],
DeviceName: NotRequired[str],
Timezone: NotRequired[str],
City: NotRequired[str],
Country: NotRequired[str],
EventFeedbackTypeTypeDef#
# EventFeedbackTypeTypeDef definition
class EventFeedbackTypeTypeDef(TypedDict):
FeedbackValue: FeedbackValueTypeType, # (1)
Provider: str,
FeedbackDate: NotRequired[datetime],
EventRiskTypeTypeDef#
# EventRiskTypeTypeDef definition
class EventRiskTypeTypeDef(TypedDict):
RiskDecision: NotRequired[RiskDecisionTypeType], # (1)
RiskLevel: NotRequired[RiskLevelTypeType], # (2)
CompromisedCredentialsDetected: NotRequired[bool],
NewDeviceMetadataTypeTypeDef#
# NewDeviceMetadataTypeTypeDef definition
class NewDeviceMetadataTypeTypeDef(TypedDict):
DeviceKey: NotRequired[str],
DeviceGroupKey: NotRequired[str],
ChangePasswordRequestRequestTypeDef#
# ChangePasswordRequestRequestTypeDef definition
class ChangePasswordRequestRequestTypeDef(TypedDict):
PreviousPassword: str,
ProposedPassword: str,
AccessToken: str,
CloudWatchLogsConfigurationTypeTypeDef#
# CloudWatchLogsConfigurationTypeTypeDef definition
class CloudWatchLogsConfigurationTypeTypeDef(TypedDict):
LogGroupArn: NotRequired[str],
CodeDeliveryDetailsTypeTypeDef#
# CodeDeliveryDetailsTypeTypeDef definition
class CodeDeliveryDetailsTypeTypeDef(TypedDict):
Destination: NotRequired[str],
DeliveryMedium: NotRequired[DeliveryMediumTypeType], # (1)
AttributeName: NotRequired[str],
CompromisedCredentialsActionsTypeTypeDef#
# CompromisedCredentialsActionsTypeTypeDef definition
class CompromisedCredentialsActionsTypeTypeDef(TypedDict):
EventAction: CompromisedCredentialsEventActionTypeType, # (1)
DeviceSecretVerifierConfigTypeTypeDef#
# DeviceSecretVerifierConfigTypeTypeDef definition
class DeviceSecretVerifierConfigTypeTypeDef(TypedDict):
PasswordVerifier: NotRequired[str],
Salt: NotRequired[str],
UserContextDataTypeTypeDef#
# UserContextDataTypeTypeDef definition
class UserContextDataTypeTypeDef(TypedDict):
IpAddress: NotRequired[str],
EncodedData: NotRequired[str],
HttpHeaderTypeDef#
# HttpHeaderTypeDef definition
class HttpHeaderTypeDef(TypedDict):
headerName: NotRequired[str],
headerValue: NotRequired[str],
CreateGroupRequestRequestTypeDef#
# CreateGroupRequestRequestTypeDef definition
class CreateGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
UserPoolId: str,
Description: NotRequired[str],
RoleArn: NotRequired[str],
Precedence: NotRequired[int],
CreateIdentityProviderRequestRequestTypeDef#
# CreateIdentityProviderRequestRequestTypeDef definition
class CreateIdentityProviderRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ProviderName: str,
ProviderType: IdentityProviderTypeTypeType, # (1)
ProviderDetails: Mapping[str, str],
AttributeMapping: NotRequired[Mapping[str, str]],
IdpIdentifiers: NotRequired[Sequence[str]],
IdentityProviderTypeTypeDef#
# IdentityProviderTypeTypeDef definition
class IdentityProviderTypeTypeDef(TypedDict):
UserPoolId: NotRequired[str],
ProviderName: NotRequired[str],
ProviderType: NotRequired[IdentityProviderTypeTypeType], # (1)
ProviderDetails: NotRequired[Dict[str, str]],
AttributeMapping: NotRequired[Dict[str, str]],
IdpIdentifiers: NotRequired[List[str]],
LastModifiedDate: NotRequired[datetime],
CreationDate: NotRequired[datetime],
ResourceServerScopeTypeTypeDef#
# ResourceServerScopeTypeTypeDef definition
class ResourceServerScopeTypeTypeDef(TypedDict):
ScopeName: str,
ScopeDescription: str,
CreateUserImportJobRequestRequestTypeDef#
# CreateUserImportJobRequestRequestTypeDef definition
class CreateUserImportJobRequestRequestTypeDef(TypedDict):
JobName: str,
UserPoolId: str,
CloudWatchLogsRoleArn: str,
UserImportJobTypeTypeDef#
# UserImportJobTypeTypeDef definition
class UserImportJobTypeTypeDef(TypedDict):
JobName: NotRequired[str],
JobId: NotRequired[str],
UserPoolId: NotRequired[str],
PreSignedUrl: NotRequired[str],
CreationDate: NotRequired[datetime],
StartDate: NotRequired[datetime],
CompletionDate: NotRequired[datetime],
Status: NotRequired[UserImportJobStatusTypeType], # (1)
CloudWatchLogsRoleArn: NotRequired[str],
ImportedUsers: NotRequired[int],
SkippedUsers: NotRequired[int],
FailedUsers: NotRequired[int],
CompletionMessage: NotRequired[str],
TokenValidityUnitsTypeTypeDef#
# TokenValidityUnitsTypeTypeDef definition
class TokenValidityUnitsTypeTypeDef(TypedDict):
AccessToken: NotRequired[TimeUnitsTypeType], # (1)
IdToken: NotRequired[TimeUnitsTypeType], # (1)
RefreshToken: NotRequired[TimeUnitsTypeType], # (1)
- See TimeUnitsTypeType
- See TimeUnitsTypeType
- See TimeUnitsTypeType
CustomDomainConfigTypeTypeDef#
# CustomDomainConfigTypeTypeDef definition
class CustomDomainConfigTypeTypeDef(TypedDict):
CertificateArn: str,
DeviceConfigurationTypeTypeDef#
# DeviceConfigurationTypeTypeDef definition
class DeviceConfigurationTypeTypeDef(TypedDict):
ChallengeRequiredOnNewDevice: NotRequired[bool],
DeviceOnlyRememberedOnUserPrompt: NotRequired[bool],
EmailConfigurationTypeTypeDef#
# EmailConfigurationTypeTypeDef definition
class EmailConfigurationTypeTypeDef(TypedDict):
SourceArn: NotRequired[str],
ReplyToEmailAddress: NotRequired[str],
EmailSendingAccount: NotRequired[EmailSendingAccountTypeType], # (1)
From: NotRequired[str],
ConfigurationSet: NotRequired[str],
SmsConfigurationTypeTypeDef#
# SmsConfigurationTypeTypeDef definition
class SmsConfigurationTypeTypeDef(TypedDict):
SnsCallerArn: str,
ExternalId: NotRequired[str],
SnsRegion: NotRequired[str],
UserAttributeUpdateSettingsTypeTypeDef#
# UserAttributeUpdateSettingsTypeTypeDef definition
class UserAttributeUpdateSettingsTypeTypeDef(TypedDict):
AttributesRequireVerificationBeforeUpdate: NotRequired[Sequence[VerifiedAttributeTypeType]], # (1)
UserPoolAddOnsTypeTypeDef#
# UserPoolAddOnsTypeTypeDef definition
class UserPoolAddOnsTypeTypeDef(TypedDict):
AdvancedSecurityMode: AdvancedSecurityModeTypeType, # (1)
UsernameConfigurationTypeTypeDef#
# UsernameConfigurationTypeTypeDef definition
class UsernameConfigurationTypeTypeDef(TypedDict):
CaseSensitive: bool,
VerificationMessageTemplateTypeTypeDef#
# VerificationMessageTemplateTypeTypeDef definition
class VerificationMessageTemplateTypeTypeDef(TypedDict):
SmsMessage: NotRequired[str],
EmailMessage: NotRequired[str],
EmailSubject: NotRequired[str],
EmailMessageByLink: NotRequired[str],
EmailSubjectByLink: NotRequired[str],
DefaultEmailOption: NotRequired[DefaultEmailOptionTypeType], # (1)
CustomEmailLambdaVersionConfigTypeTypeDef#
# CustomEmailLambdaVersionConfigTypeTypeDef definition
class CustomEmailLambdaVersionConfigTypeTypeDef(TypedDict):
LambdaVersion: CustomEmailSenderLambdaVersionTypeType, # (1)
LambdaArn: str,
CustomSMSLambdaVersionConfigTypeTypeDef#
# CustomSMSLambdaVersionConfigTypeTypeDef definition
class CustomSMSLambdaVersionConfigTypeTypeDef(TypedDict):
LambdaVersion: CustomSMSSenderLambdaVersionTypeType, # (1)
LambdaArn: str,
DeleteGroupRequestRequestTypeDef#
# DeleteGroupRequestRequestTypeDef definition
class DeleteGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
UserPoolId: str,
DeleteIdentityProviderRequestRequestTypeDef#
# DeleteIdentityProviderRequestRequestTypeDef definition
class DeleteIdentityProviderRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ProviderName: str,
DeleteResourceServerRequestRequestTypeDef#
# DeleteResourceServerRequestRequestTypeDef definition
class DeleteResourceServerRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Identifier: str,
DeleteUserAttributesRequestRequestTypeDef#
# DeleteUserAttributesRequestRequestTypeDef definition
class DeleteUserAttributesRequestRequestTypeDef(TypedDict):
UserAttributeNames: Sequence[str],
AccessToken: str,
DeleteUserPoolClientRequestRequestTypeDef#
# DeleteUserPoolClientRequestRequestTypeDef definition
class DeleteUserPoolClientRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ClientId: str,
DeleteUserPoolDomainRequestRequestTypeDef#
# DeleteUserPoolDomainRequestRequestTypeDef definition
class DeleteUserPoolDomainRequestRequestTypeDef(TypedDict):
Domain: str,
UserPoolId: str,
DeleteUserPoolRequestRequestTypeDef#
# DeleteUserPoolRequestRequestTypeDef definition
class DeleteUserPoolRequestRequestTypeDef(TypedDict):
UserPoolId: str,
DeleteUserRequestRequestTypeDef#
# DeleteUserRequestRequestTypeDef definition
class DeleteUserRequestRequestTypeDef(TypedDict):
AccessToken: str,
DescribeIdentityProviderRequestRequestTypeDef#
# DescribeIdentityProviderRequestRequestTypeDef definition
class DescribeIdentityProviderRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ProviderName: str,
DescribeResourceServerRequestRequestTypeDef#
# DescribeResourceServerRequestRequestTypeDef definition
class DescribeResourceServerRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Identifier: str,
DescribeRiskConfigurationRequestRequestTypeDef#
# DescribeRiskConfigurationRequestRequestTypeDef definition
class DescribeRiskConfigurationRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ClientId: NotRequired[str],
DescribeUserImportJobRequestRequestTypeDef#
# DescribeUserImportJobRequestRequestTypeDef definition
class DescribeUserImportJobRequestRequestTypeDef(TypedDict):
UserPoolId: str,
JobId: str,
DescribeUserPoolClientRequestRequestTypeDef#
# DescribeUserPoolClientRequestRequestTypeDef definition
class DescribeUserPoolClientRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ClientId: str,
DescribeUserPoolDomainRequestRequestTypeDef#
# DescribeUserPoolDomainRequestRequestTypeDef definition
class DescribeUserPoolDomainRequestRequestTypeDef(TypedDict):
Domain: str,
DescribeUserPoolRequestRequestTypeDef#
# DescribeUserPoolRequestRequestTypeDef definition
class DescribeUserPoolRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ForgetDeviceRequestRequestTypeDef#
# ForgetDeviceRequestRequestTypeDef definition
class ForgetDeviceRequestRequestTypeDef(TypedDict):
DeviceKey: str,
AccessToken: NotRequired[str],
GetCSVHeaderRequestRequestTypeDef#
# GetCSVHeaderRequestRequestTypeDef definition
class GetCSVHeaderRequestRequestTypeDef(TypedDict):
UserPoolId: str,
GetDeviceRequestRequestTypeDef#
# GetDeviceRequestRequestTypeDef definition
class GetDeviceRequestRequestTypeDef(TypedDict):
DeviceKey: str,
AccessToken: NotRequired[str],
GetGroupRequestRequestTypeDef#
# GetGroupRequestRequestTypeDef definition
class GetGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
UserPoolId: str,
GetIdentityProviderByIdentifierRequestRequestTypeDef#
# GetIdentityProviderByIdentifierRequestRequestTypeDef definition
class GetIdentityProviderByIdentifierRequestRequestTypeDef(TypedDict):
UserPoolId: str,
IdpIdentifier: str,
GetLogDeliveryConfigurationRequestRequestTypeDef#
# GetLogDeliveryConfigurationRequestRequestTypeDef definition
class GetLogDeliveryConfigurationRequestRequestTypeDef(TypedDict):
UserPoolId: str,
GetSigningCertificateRequestRequestTypeDef#
# GetSigningCertificateRequestRequestTypeDef definition
class GetSigningCertificateRequestRequestTypeDef(TypedDict):
UserPoolId: str,
GetUICustomizationRequestRequestTypeDef#
# GetUICustomizationRequestRequestTypeDef definition
class GetUICustomizationRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ClientId: NotRequired[str],
UICustomizationTypeTypeDef#
# UICustomizationTypeTypeDef definition
class UICustomizationTypeTypeDef(TypedDict):
UserPoolId: NotRequired[str],
ClientId: NotRequired[str],
ImageUrl: NotRequired[str],
CSS: NotRequired[str],
CSSVersion: NotRequired[str],
LastModifiedDate: NotRequired[datetime],
CreationDate: NotRequired[datetime],
GetUserAttributeVerificationCodeRequestRequestTypeDef#
# GetUserAttributeVerificationCodeRequestRequestTypeDef definition
class GetUserAttributeVerificationCodeRequestRequestTypeDef(TypedDict):
AccessToken: str,
AttributeName: str,
ClientMetadata: NotRequired[Mapping[str, str]],
GetUserPoolMfaConfigRequestRequestTypeDef#
# GetUserPoolMfaConfigRequestRequestTypeDef definition
class GetUserPoolMfaConfigRequestRequestTypeDef(TypedDict):
UserPoolId: str,
SoftwareTokenMfaConfigTypeTypeDef#
# SoftwareTokenMfaConfigTypeTypeDef definition
class SoftwareTokenMfaConfigTypeTypeDef(TypedDict):
Enabled: NotRequired[bool],
GetUserRequestRequestTypeDef#
# GetUserRequestRequestTypeDef definition
class GetUserRequestRequestTypeDef(TypedDict):
AccessToken: str,
GlobalSignOutRequestRequestTypeDef#
# GlobalSignOutRequestRequestTypeDef definition
class GlobalSignOutRequestRequestTypeDef(TypedDict):
AccessToken: str,
PreTokenGenerationVersionConfigTypeTypeDef#
# PreTokenGenerationVersionConfigTypeTypeDef definition
class PreTokenGenerationVersionConfigTypeTypeDef(TypedDict):
LambdaVersion: PreTokenGenerationLambdaVersionTypeType, # (1)
LambdaArn: str,
ListDevicesRequestRequestTypeDef#
# ListDevicesRequestRequestTypeDef definition
class ListDevicesRequestRequestTypeDef(TypedDict):
AccessToken: str,
Limit: NotRequired[int],
PaginationToken: NotRequired[str],
ListGroupsRequestRequestTypeDef#
# ListGroupsRequestRequestTypeDef definition
class ListGroupsRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Limit: NotRequired[int],
NextToken: NotRequired[str],
ListIdentityProvidersRequestRequestTypeDef#
# ListIdentityProvidersRequestRequestTypeDef definition
class ListIdentityProvidersRequestRequestTypeDef(TypedDict):
UserPoolId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ProviderDescriptionTypeDef#
# ProviderDescriptionTypeDef definition
class ProviderDescriptionTypeDef(TypedDict):
ProviderName: NotRequired[str],
ProviderType: NotRequired[IdentityProviderTypeTypeType], # (1)
LastModifiedDate: NotRequired[datetime],
CreationDate: NotRequired[datetime],
ListResourceServersRequestRequestTypeDef#
# ListResourceServersRequestRequestTypeDef definition
class ListResourceServersRequestRequestTypeDef(TypedDict):
UserPoolId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
ListUserImportJobsRequestRequestTypeDef#
# ListUserImportJobsRequestRequestTypeDef definition
class ListUserImportJobsRequestRequestTypeDef(TypedDict):
UserPoolId: str,
MaxResults: int,
PaginationToken: NotRequired[str],
ListUserPoolClientsRequestRequestTypeDef#
# ListUserPoolClientsRequestRequestTypeDef definition
class ListUserPoolClientsRequestRequestTypeDef(TypedDict):
UserPoolId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
UserPoolClientDescriptionTypeDef#
# UserPoolClientDescriptionTypeDef definition
class UserPoolClientDescriptionTypeDef(TypedDict):
ClientId: NotRequired[str],
UserPoolId: NotRequired[str],
ClientName: NotRequired[str],
ListUserPoolsRequestRequestTypeDef#
# ListUserPoolsRequestRequestTypeDef definition
class ListUserPoolsRequestRequestTypeDef(TypedDict):
MaxResults: int,
NextToken: NotRequired[str],
ListUsersInGroupRequestRequestTypeDef#
# ListUsersInGroupRequestRequestTypeDef definition
class ListUsersInGroupRequestRequestTypeDef(TypedDict):
UserPoolId: str,
GroupName: str,
Limit: NotRequired[int],
NextToken: NotRequired[str],
ListUsersRequestRequestTypeDef#
# ListUsersRequestRequestTypeDef definition
class ListUsersRequestRequestTypeDef(TypedDict):
UserPoolId: str,
AttributesToGet: NotRequired[Sequence[str]],
Limit: NotRequired[int],
PaginationToken: NotRequired[str],
Filter: NotRequired[str],
NotifyEmailTypeTypeDef#
# NotifyEmailTypeTypeDef definition
class NotifyEmailTypeTypeDef(TypedDict):
Subject: str,
HtmlBody: NotRequired[str],
TextBody: NotRequired[str],
NumberAttributeConstraintsTypeTypeDef#
# NumberAttributeConstraintsTypeTypeDef definition
class NumberAttributeConstraintsTypeTypeDef(TypedDict):
MinValue: NotRequired[str],
MaxValue: NotRequired[str],
PasswordPolicyTypeTypeDef#
# PasswordPolicyTypeTypeDef definition
class PasswordPolicyTypeTypeDef(TypedDict):
MinimumLength: NotRequired[int],
RequireUppercase: NotRequired[bool],
RequireLowercase: NotRequired[bool],
RequireNumbers: NotRequired[bool],
RequireSymbols: NotRequired[bool],
TemporaryPasswordValidityDays: NotRequired[int],
RevokeTokenRequestRequestTypeDef#
# RevokeTokenRequestRequestTypeDef definition
class RevokeTokenRequestRequestTypeDef(TypedDict):
Token: str,
ClientId: str,
ClientSecret: NotRequired[str],
RiskExceptionConfigurationTypeTypeDef#
# RiskExceptionConfigurationTypeTypeDef definition
class RiskExceptionConfigurationTypeTypeDef(TypedDict):
BlockedIPRangeList: NotRequired[List[str]],
SkippedIPRangeList: NotRequired[List[str]],
StringAttributeConstraintsTypeTypeDef#
# StringAttributeConstraintsTypeTypeDef definition
class StringAttributeConstraintsTypeTypeDef(TypedDict):
MinLength: NotRequired[str],
MaxLength: NotRequired[str],
StartUserImportJobRequestRequestTypeDef#
# StartUserImportJobRequestRequestTypeDef definition
class StartUserImportJobRequestRequestTypeDef(TypedDict):
UserPoolId: str,
JobId: str,
StopUserImportJobRequestRequestTypeDef#
# StopUserImportJobRequestRequestTypeDef definition
class StopUserImportJobRequestRequestTypeDef(TypedDict):
UserPoolId: str,
JobId: str,
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
UpdateAuthEventFeedbackRequestRequestTypeDef#
# UpdateAuthEventFeedbackRequestRequestTypeDef definition
class UpdateAuthEventFeedbackRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
EventId: str,
FeedbackToken: str,
FeedbackValue: FeedbackValueTypeType, # (1)
UpdateDeviceStatusRequestRequestTypeDef#
# UpdateDeviceStatusRequestRequestTypeDef definition
class UpdateDeviceStatusRequestRequestTypeDef(TypedDict):
AccessToken: str,
DeviceKey: str,
DeviceRememberedStatus: NotRequired[DeviceRememberedStatusTypeType], # (1)
UpdateGroupRequestRequestTypeDef#
# UpdateGroupRequestRequestTypeDef definition
class UpdateGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
UserPoolId: str,
Description: NotRequired[str],
RoleArn: NotRequired[str],
Precedence: NotRequired[int],
UpdateIdentityProviderRequestRequestTypeDef#
# UpdateIdentityProviderRequestRequestTypeDef definition
class UpdateIdentityProviderRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ProviderName: str,
ProviderDetails: NotRequired[Mapping[str, str]],
AttributeMapping: NotRequired[Mapping[str, str]],
IdpIdentifiers: NotRequired[Sequence[str]],
VerifySoftwareTokenRequestRequestTypeDef#
# VerifySoftwareTokenRequestRequestTypeDef definition
class VerifySoftwareTokenRequestRequestTypeDef(TypedDict):
UserCode: str,
AccessToken: NotRequired[str],
Session: NotRequired[str],
FriendlyDeviceName: NotRequired[str],
VerifyUserAttributeRequestRequestTypeDef#
# VerifyUserAttributeRequestRequestTypeDef definition
class VerifyUserAttributeRequestRequestTypeDef(TypedDict):
AccessToken: str,
AttributeName: str,
Code: str,
AccountRecoverySettingTypeTypeDef#
# AccountRecoverySettingTypeTypeDef definition
class AccountRecoverySettingTypeTypeDef(TypedDict):
RecoveryMechanisms: NotRequired[Sequence[RecoveryOptionTypeTypeDef]], # (1)
AccountTakeoverActionsTypeTypeDef#
# AccountTakeoverActionsTypeTypeDef definition
class AccountTakeoverActionsTypeTypeDef(TypedDict):
LowAction: NotRequired[AccountTakeoverActionTypeTypeDef], # (1)
MediumAction: NotRequired[AccountTakeoverActionTypeTypeDef], # (1)
HighAction: NotRequired[AccountTakeoverActionTypeTypeDef], # (1)
- See AccountTakeoverActionTypeTypeDef
- See AccountTakeoverActionTypeTypeDef
- See AccountTakeoverActionTypeTypeDef
AdminCreateUserConfigTypeTypeDef#
# AdminCreateUserConfigTypeTypeDef definition
class AdminCreateUserConfigTypeTypeDef(TypedDict):
AllowAdminCreateUserOnly: NotRequired[bool],
UnusedAccountValidityDays: NotRequired[int],
InviteMessageTemplate: NotRequired[MessageTemplateTypeTypeDef], # (1)
AdminCreateUserRequestRequestTypeDef#
# AdminCreateUserRequestRequestTypeDef definition
class AdminCreateUserRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
UserAttributes: NotRequired[Sequence[AttributeTypeTypeDef]], # (1)
ValidationData: NotRequired[Sequence[AttributeTypeTypeDef]], # (1)
TemporaryPassword: NotRequired[str],
ForceAliasCreation: NotRequired[bool],
MessageAction: NotRequired[MessageActionTypeType], # (3)
DesiredDeliveryMediums: NotRequired[Sequence[DeliveryMediumTypeType]], # (4)
ClientMetadata: NotRequired[Mapping[str, str]],
- See AttributeTypeTypeDef
- See AttributeTypeTypeDef
- See MessageActionTypeType
- See DeliveryMediumTypeType
AdminUpdateUserAttributesRequestRequestTypeDef#
# AdminUpdateUserAttributesRequestRequestTypeDef definition
class AdminUpdateUserAttributesRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
UserAttributes: Sequence[AttributeTypeTypeDef], # (1)
ClientMetadata: NotRequired[Mapping[str, str]],
DeviceTypeTypeDef#
# DeviceTypeTypeDef definition
class DeviceTypeTypeDef(TypedDict):
DeviceKey: NotRequired[str],
DeviceAttributes: NotRequired[List[AttributeTypeTypeDef]], # (1)
DeviceCreateDate: NotRequired[datetime],
DeviceLastModifiedDate: NotRequired[datetime],
DeviceLastAuthenticatedDate: NotRequired[datetime],
UpdateUserAttributesRequestRequestTypeDef#
# UpdateUserAttributesRequestRequestTypeDef definition
class UpdateUserAttributesRequestRequestTypeDef(TypedDict):
UserAttributes: Sequence[AttributeTypeTypeDef], # (1)
AccessToken: str,
ClientMetadata: NotRequired[Mapping[str, str]],
AssociateSoftwareTokenResponseTypeDef#
# AssociateSoftwareTokenResponseTypeDef definition
class AssociateSoftwareTokenResponseTypeDef(TypedDict):
SecretCode: str,
Session: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ConfirmDeviceResponseTypeDef#
# ConfirmDeviceResponseTypeDef definition
class ConfirmDeviceResponseTypeDef(TypedDict):
UserConfirmationNecessary: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUserPoolDomainResponseTypeDef#
# CreateUserPoolDomainResponseTypeDef definition
class CreateUserPoolDomainResponseTypeDef(TypedDict):
CloudFrontDomain: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCSVHeaderResponseTypeDef#
# GetCSVHeaderResponseTypeDef definition
class GetCSVHeaderResponseTypeDef(TypedDict):
UserPoolId: str,
CSVHeader: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetSigningCertificateResponseTypeDef#
# GetSigningCertificateResponseTypeDef definition
class GetSigningCertificateResponseTypeDef(TypedDict):
Certificate: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateUserPoolDomainResponseTypeDef#
# UpdateUserPoolDomainResponseTypeDef definition
class UpdateUserPoolDomainResponseTypeDef(TypedDict):
CloudFrontDomain: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
VerifySoftwareTokenResponseTypeDef#
# VerifySoftwareTokenResponseTypeDef definition
class VerifySoftwareTokenResponseTypeDef(TypedDict):
Status: VerifySoftwareTokenResponseTypeType, # (1)
Session: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AdminDisableProviderForUserRequestRequestTypeDef#
# AdminDisableProviderForUserRequestRequestTypeDef definition
class AdminDisableProviderForUserRequestRequestTypeDef(TypedDict):
UserPoolId: str,
User: ProviderUserIdentifierTypeTypeDef, # (1)
AdminLinkProviderForUserRequestRequestTypeDef#
# AdminLinkProviderForUserRequestRequestTypeDef definition
class AdminLinkProviderForUserRequestRequestTypeDef(TypedDict):
UserPoolId: str,
DestinationUser: ProviderUserIdentifierTypeTypeDef, # (1)
SourceUser: ProviderUserIdentifierTypeTypeDef, # (1)
AdminGetUserResponseTypeDef#
# AdminGetUserResponseTypeDef definition
class AdminGetUserResponseTypeDef(TypedDict):
Username: str,
UserAttributes: List[AttributeTypeTypeDef], # (1)
UserCreateDate: datetime,
UserLastModifiedDate: datetime,
Enabled: bool,
UserStatus: UserStatusTypeType, # (2)
MFAOptions: List[MFAOptionTypeTypeDef], # (3)
PreferredMfaSetting: str,
UserMFASettingList: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AttributeTypeTypeDef
- See UserStatusTypeType
- See MFAOptionTypeTypeDef
- See ResponseMetadataTypeDef
AdminSetUserSettingsRequestRequestTypeDef#
# AdminSetUserSettingsRequestRequestTypeDef definition
class AdminSetUserSettingsRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Username: str,
MFAOptions: Sequence[MFAOptionTypeTypeDef], # (1)
GetUserResponseTypeDef#
# GetUserResponseTypeDef definition
class GetUserResponseTypeDef(TypedDict):
Username: str,
UserAttributes: List[AttributeTypeTypeDef], # (1)
MFAOptions: List[MFAOptionTypeTypeDef], # (2)
PreferredMfaSetting: str,
UserMFASettingList: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (3)
SetUserSettingsRequestRequestTypeDef#
# SetUserSettingsRequestRequestTypeDef definition
class SetUserSettingsRequestRequestTypeDef(TypedDict):
AccessToken: str,
MFAOptions: Sequence[MFAOptionTypeTypeDef], # (1)
UserTypeTypeDef#
# UserTypeTypeDef definition
class UserTypeTypeDef(TypedDict):
Username: NotRequired[str],
Attributes: NotRequired[List[AttributeTypeTypeDef]], # (1)
UserCreateDate: NotRequired[datetime],
UserLastModifiedDate: NotRequired[datetime],
Enabled: NotRequired[bool],
UserStatus: NotRequired[UserStatusTypeType], # (2)
MFAOptions: NotRequired[List[MFAOptionTypeTypeDef]], # (3)
AdminListGroupsForUserRequestAdminListGroupsForUserPaginateTypeDef#
# AdminListGroupsForUserRequestAdminListGroupsForUserPaginateTypeDef definition
class AdminListGroupsForUserRequestAdminListGroupsForUserPaginateTypeDef(TypedDict):
Username: str,
UserPoolId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateTypeDef#
# AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateTypeDef definition
class AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateTypeDef(TypedDict):
UserPoolId: str,
Username: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListGroupsRequestListGroupsPaginateTypeDef#
# ListGroupsRequestListGroupsPaginateTypeDef definition
class ListGroupsRequestListGroupsPaginateTypeDef(TypedDict):
UserPoolId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef#
# ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef definition
class ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef(TypedDict):
UserPoolId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListResourceServersRequestListResourceServersPaginateTypeDef#
# ListResourceServersRequestListResourceServersPaginateTypeDef definition
class ListResourceServersRequestListResourceServersPaginateTypeDef(TypedDict):
UserPoolId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef#
# ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef definition
class ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef(TypedDict):
UserPoolId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUserPoolsRequestListUserPoolsPaginateTypeDef#
# ListUserPoolsRequestListUserPoolsPaginateTypeDef definition
class ListUserPoolsRequestListUserPoolsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUsersInGroupRequestListUsersInGroupPaginateTypeDef#
# ListUsersInGroupRequestListUsersInGroupPaginateTypeDef definition
class ListUsersInGroupRequestListUsersInGroupPaginateTypeDef(TypedDict):
UserPoolId: str,
GroupName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUsersRequestListUsersPaginateTypeDef#
# ListUsersRequestListUsersPaginateTypeDef definition
class ListUsersRequestListUsersPaginateTypeDef(TypedDict):
UserPoolId: str,
AttributesToGet: NotRequired[Sequence[str]],
Filter: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
AdminListGroupsForUserResponseTypeDef#
# AdminListGroupsForUserResponseTypeDef definition
class AdminListGroupsForUserResponseTypeDef(TypedDict):
Groups: List[GroupTypeTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateGroupResponseTypeDef#
# CreateGroupResponseTypeDef definition
class CreateGroupResponseTypeDef(TypedDict):
Group: GroupTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetGroupResponseTypeDef#
# GetGroupResponseTypeDef definition
class GetGroupResponseTypeDef(TypedDict):
Group: GroupTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListGroupsResponseTypeDef#
# ListGroupsResponseTypeDef definition
class ListGroupsResponseTypeDef(TypedDict):
Groups: List[GroupTypeTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateGroupResponseTypeDef#
# UpdateGroupResponseTypeDef definition
class UpdateGroupResponseTypeDef(TypedDict):
Group: GroupTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AdminSetUserMFAPreferenceRequestRequestTypeDef#
# AdminSetUserMFAPreferenceRequestRequestTypeDef definition
class AdminSetUserMFAPreferenceRequestRequestTypeDef(TypedDict):
Username: str,
UserPoolId: str,
SMSMfaSettings: NotRequired[SMSMfaSettingsTypeTypeDef], # (1)
SoftwareTokenMfaSettings: NotRequired[SoftwareTokenMfaSettingsTypeTypeDef], # (2)
SetUserMFAPreferenceRequestRequestTypeDef#
# SetUserMFAPreferenceRequestRequestTypeDef definition
class SetUserMFAPreferenceRequestRequestTypeDef(TypedDict):
AccessToken: str,
SMSMfaSettings: NotRequired[SMSMfaSettingsTypeTypeDef], # (1)
SoftwareTokenMfaSettings: NotRequired[SoftwareTokenMfaSettingsTypeTypeDef], # (2)
AuthEventTypeTypeDef#
# AuthEventTypeTypeDef definition
class AuthEventTypeTypeDef(TypedDict):
EventId: NotRequired[str],
EventType: NotRequired[EventTypeType], # (1)
CreationDate: NotRequired[datetime],
EventResponse: NotRequired[EventResponseTypeType], # (2)
EventRisk: NotRequired[EventRiskTypeTypeDef], # (3)
ChallengeResponses: NotRequired[List[ChallengeResponseTypeTypeDef]], # (4)
EventContextData: NotRequired[EventContextDataTypeTypeDef], # (5)
EventFeedback: NotRequired[EventFeedbackTypeTypeDef], # (6)
- See EventTypeType
- See EventResponseTypeType
- See EventRiskTypeTypeDef
- See ChallengeResponseTypeTypeDef
- See EventContextDataTypeTypeDef
- See EventFeedbackTypeTypeDef
AuthenticationResultTypeTypeDef#
# AuthenticationResultTypeTypeDef definition
class AuthenticationResultTypeTypeDef(TypedDict):
AccessToken: NotRequired[str],
ExpiresIn: NotRequired[int],
TokenType: NotRequired[str],
RefreshToken: NotRequired[str],
IdToken: NotRequired[str],
NewDeviceMetadata: NotRequired[NewDeviceMetadataTypeTypeDef], # (1)
SetUICustomizationRequestRequestTypeDef#
# SetUICustomizationRequestRequestTypeDef definition
class SetUICustomizationRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ClientId: NotRequired[str],
CSS: NotRequired[str],
ImageFile: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
LogConfigurationTypeTypeDef#
# LogConfigurationTypeTypeDef definition
class LogConfigurationTypeTypeDef(TypedDict):
LogLevel: LogLevelType, # (1)
EventSource: EventSourceNameType, # (2)
CloudWatchLogsConfiguration: NotRequired[CloudWatchLogsConfigurationTypeTypeDef], # (3)
ForgotPasswordResponseTypeDef#
# ForgotPasswordResponseTypeDef definition
class ForgotPasswordResponseTypeDef(TypedDict):
CodeDeliveryDetails: CodeDeliveryDetailsTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetUserAttributeVerificationCodeResponseTypeDef#
# GetUserAttributeVerificationCodeResponseTypeDef definition
class GetUserAttributeVerificationCodeResponseTypeDef(TypedDict):
CodeDeliveryDetails: CodeDeliveryDetailsTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ResendConfirmationCodeResponseTypeDef#
# ResendConfirmationCodeResponseTypeDef definition
class ResendConfirmationCodeResponseTypeDef(TypedDict):
CodeDeliveryDetails: CodeDeliveryDetailsTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SignUpResponseTypeDef#
# SignUpResponseTypeDef definition
class SignUpResponseTypeDef(TypedDict):
UserConfirmed: bool,
CodeDeliveryDetails: CodeDeliveryDetailsTypeTypeDef, # (1)
UserSub: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateUserAttributesResponseTypeDef#
# UpdateUserAttributesResponseTypeDef definition
class UpdateUserAttributesResponseTypeDef(TypedDict):
CodeDeliveryDetailsList: List[CodeDeliveryDetailsTypeTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CompromisedCredentialsRiskConfigurationTypeTypeDef#
# CompromisedCredentialsRiskConfigurationTypeTypeDef definition
class CompromisedCredentialsRiskConfigurationTypeTypeDef(TypedDict):
Actions: CompromisedCredentialsActionsTypeTypeDef, # (2)
EventFilter: NotRequired[List[EventFilterTypeType]], # (1)
ConfirmDeviceRequestRequestTypeDef#
# ConfirmDeviceRequestRequestTypeDef definition
class ConfirmDeviceRequestRequestTypeDef(TypedDict):
AccessToken: str,
DeviceKey: str,
DeviceSecretVerifierConfig: NotRequired[DeviceSecretVerifierConfigTypeTypeDef], # (1)
DeviceName: NotRequired[str],
ConfirmForgotPasswordRequestRequestTypeDef#
# ConfirmForgotPasswordRequestRequestTypeDef definition
class ConfirmForgotPasswordRequestRequestTypeDef(TypedDict):
ClientId: str,
Username: str,
ConfirmationCode: str,
Password: str,
SecretHash: NotRequired[str],
AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef], # (1)
UserContextData: NotRequired[UserContextDataTypeTypeDef], # (2)
ClientMetadata: NotRequired[Mapping[str, str]],
ConfirmSignUpRequestRequestTypeDef#
# ConfirmSignUpRequestRequestTypeDef definition
class ConfirmSignUpRequestRequestTypeDef(TypedDict):
ClientId: str,
Username: str,
ConfirmationCode: str,
SecretHash: NotRequired[str],
ForceAliasCreation: NotRequired[bool],
AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef], # (1)
UserContextData: NotRequired[UserContextDataTypeTypeDef], # (2)
ClientMetadata: NotRequired[Mapping[str, str]],
ForgotPasswordRequestRequestTypeDef#
# ForgotPasswordRequestRequestTypeDef definition
class ForgotPasswordRequestRequestTypeDef(TypedDict):
ClientId: str,
Username: str,
SecretHash: NotRequired[str],
UserContextData: NotRequired[UserContextDataTypeTypeDef], # (1)
AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef], # (2)
ClientMetadata: NotRequired[Mapping[str, str]],
InitiateAuthRequestRequestTypeDef#
# InitiateAuthRequestRequestTypeDef definition
class InitiateAuthRequestRequestTypeDef(TypedDict):
AuthFlow: AuthFlowTypeType, # (1)
ClientId: str,
AuthParameters: NotRequired[Mapping[str, str]],
ClientMetadata: NotRequired[Mapping[str, str]],
AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef], # (2)
UserContextData: NotRequired[UserContextDataTypeTypeDef], # (3)
ResendConfirmationCodeRequestRequestTypeDef#
# ResendConfirmationCodeRequestRequestTypeDef definition
class ResendConfirmationCodeRequestRequestTypeDef(TypedDict):
ClientId: str,
Username: str,
SecretHash: NotRequired[str],
UserContextData: NotRequired[UserContextDataTypeTypeDef], # (1)
AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef], # (2)
ClientMetadata: NotRequired[Mapping[str, str]],
RespondToAuthChallengeRequestRequestTypeDef#
# RespondToAuthChallengeRequestRequestTypeDef definition
class RespondToAuthChallengeRequestRequestTypeDef(TypedDict):
ClientId: str,
ChallengeName: ChallengeNameTypeType, # (1)
Session: NotRequired[str],
ChallengeResponses: NotRequired[Mapping[str, str]],
AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef], # (2)
UserContextData: NotRequired[UserContextDataTypeTypeDef], # (3)
ClientMetadata: NotRequired[Mapping[str, str]],
SignUpRequestRequestTypeDef#
# SignUpRequestRequestTypeDef definition
class SignUpRequestRequestTypeDef(TypedDict):
ClientId: str,
Username: str,
Password: str,
SecretHash: NotRequired[str],
UserAttributes: NotRequired[Sequence[AttributeTypeTypeDef]], # (1)
ValidationData: NotRequired[Sequence[AttributeTypeTypeDef]], # (1)
AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef], # (3)
UserContextData: NotRequired[UserContextDataTypeTypeDef], # (4)
ClientMetadata: NotRequired[Mapping[str, str]],
- See AttributeTypeTypeDef
- See AttributeTypeTypeDef
- See AnalyticsMetadataTypeTypeDef
- See UserContextDataTypeTypeDef
ContextDataTypeTypeDef#
# ContextDataTypeTypeDef definition
class ContextDataTypeTypeDef(TypedDict):
IpAddress: str,
ServerName: str,
ServerPath: str,
HttpHeaders: Sequence[HttpHeaderTypeDef], # (1)
EncodedData: NotRequired[str],
CreateIdentityProviderResponseTypeDef#
# CreateIdentityProviderResponseTypeDef definition
class CreateIdentityProviderResponseTypeDef(TypedDict):
IdentityProvider: IdentityProviderTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeIdentityProviderResponseTypeDef#
# DescribeIdentityProviderResponseTypeDef definition
class DescribeIdentityProviderResponseTypeDef(TypedDict):
IdentityProvider: IdentityProviderTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetIdentityProviderByIdentifierResponseTypeDef#
# GetIdentityProviderByIdentifierResponseTypeDef definition
class GetIdentityProviderByIdentifierResponseTypeDef(TypedDict):
IdentityProvider: IdentityProviderTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateIdentityProviderResponseTypeDef#
# UpdateIdentityProviderResponseTypeDef definition
class UpdateIdentityProviderResponseTypeDef(TypedDict):
IdentityProvider: IdentityProviderTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateResourceServerRequestRequestTypeDef#
# CreateResourceServerRequestRequestTypeDef definition
class CreateResourceServerRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Identifier: str,
Name: str,
Scopes: NotRequired[Sequence[ResourceServerScopeTypeTypeDef]], # (1)
ResourceServerTypeTypeDef#
# ResourceServerTypeTypeDef definition
class ResourceServerTypeTypeDef(TypedDict):
UserPoolId: NotRequired[str],
Identifier: NotRequired[str],
Name: NotRequired[str],
Scopes: NotRequired[List[ResourceServerScopeTypeTypeDef]], # (1)
UpdateResourceServerRequestRequestTypeDef#
# UpdateResourceServerRequestRequestTypeDef definition
class UpdateResourceServerRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Identifier: str,
Name: str,
Scopes: NotRequired[Sequence[ResourceServerScopeTypeTypeDef]], # (1)
CreateUserImportJobResponseTypeDef#
# CreateUserImportJobResponseTypeDef definition
class CreateUserImportJobResponseTypeDef(TypedDict):
UserImportJob: UserImportJobTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeUserImportJobResponseTypeDef#
# DescribeUserImportJobResponseTypeDef definition
class DescribeUserImportJobResponseTypeDef(TypedDict):
UserImportJob: UserImportJobTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUserImportJobsResponseTypeDef#
# ListUserImportJobsResponseTypeDef definition
class ListUserImportJobsResponseTypeDef(TypedDict):
UserImportJobs: List[UserImportJobTypeTypeDef], # (1)
PaginationToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartUserImportJobResponseTypeDef#
# StartUserImportJobResponseTypeDef definition
class StartUserImportJobResponseTypeDef(TypedDict):
UserImportJob: UserImportJobTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopUserImportJobResponseTypeDef#
# StopUserImportJobResponseTypeDef definition
class StopUserImportJobResponseTypeDef(TypedDict):
UserImportJob: UserImportJobTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateUserPoolClientRequestRequestTypeDef#
# CreateUserPoolClientRequestRequestTypeDef definition
class CreateUserPoolClientRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ClientName: str,
GenerateSecret: NotRequired[bool],
RefreshTokenValidity: NotRequired[int],
AccessTokenValidity: NotRequired[int],
IdTokenValidity: NotRequired[int],
TokenValidityUnits: NotRequired[TokenValidityUnitsTypeTypeDef], # (1)
ReadAttributes: NotRequired[Sequence[str]],
WriteAttributes: NotRequired[Sequence[str]],
ExplicitAuthFlows: NotRequired[Sequence[ExplicitAuthFlowsTypeType]], # (2)
SupportedIdentityProviders: NotRequired[Sequence[str]],
CallbackURLs: NotRequired[Sequence[str]],
LogoutURLs: NotRequired[Sequence[str]],
DefaultRedirectURI: NotRequired[str],
AllowedOAuthFlows: NotRequired[Sequence[OAuthFlowTypeType]], # (3)
AllowedOAuthScopes: NotRequired[Sequence[str]],
AllowedOAuthFlowsUserPoolClient: NotRequired[bool],
AnalyticsConfiguration: NotRequired[AnalyticsConfigurationTypeTypeDef], # (4)
PreventUserExistenceErrors: NotRequired[PreventUserExistenceErrorTypesType], # (5)
EnableTokenRevocation: NotRequired[bool],
EnablePropagateAdditionalUserContextData: NotRequired[bool],
AuthSessionValidity: NotRequired[int],
- See TokenValidityUnitsTypeTypeDef
- See ExplicitAuthFlowsTypeType
- See OAuthFlowTypeType
- See AnalyticsConfigurationTypeTypeDef
- See PreventUserExistenceErrorTypesType
UpdateUserPoolClientRequestRequestTypeDef#
# UpdateUserPoolClientRequestRequestTypeDef definition
class UpdateUserPoolClientRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ClientId: str,
ClientName: NotRequired[str],
RefreshTokenValidity: NotRequired[int],
AccessTokenValidity: NotRequired[int],
IdTokenValidity: NotRequired[int],
TokenValidityUnits: NotRequired[TokenValidityUnitsTypeTypeDef], # (1)
ReadAttributes: NotRequired[Sequence[str]],
WriteAttributes: NotRequired[Sequence[str]],
ExplicitAuthFlows: NotRequired[Sequence[ExplicitAuthFlowsTypeType]], # (2)
SupportedIdentityProviders: NotRequired[Sequence[str]],
CallbackURLs: NotRequired[Sequence[str]],
LogoutURLs: NotRequired[Sequence[str]],
DefaultRedirectURI: NotRequired[str],
AllowedOAuthFlows: NotRequired[Sequence[OAuthFlowTypeType]], # (3)
AllowedOAuthScopes: NotRequired[Sequence[str]],
AllowedOAuthFlowsUserPoolClient: NotRequired[bool],
AnalyticsConfiguration: NotRequired[AnalyticsConfigurationTypeTypeDef], # (4)
PreventUserExistenceErrors: NotRequired[PreventUserExistenceErrorTypesType], # (5)
EnableTokenRevocation: NotRequired[bool],
EnablePropagateAdditionalUserContextData: NotRequired[bool],
AuthSessionValidity: NotRequired[int],
- See TokenValidityUnitsTypeTypeDef
- See ExplicitAuthFlowsTypeType
- See OAuthFlowTypeType
- See AnalyticsConfigurationTypeTypeDef
- See PreventUserExistenceErrorTypesType
UserPoolClientTypeTypeDef#
# UserPoolClientTypeTypeDef definition
class UserPoolClientTypeTypeDef(TypedDict):
UserPoolId: NotRequired[str],
ClientName: NotRequired[str],
ClientId: NotRequired[str],
ClientSecret: NotRequired[str],
LastModifiedDate: NotRequired[datetime],
CreationDate: NotRequired[datetime],
RefreshTokenValidity: NotRequired[int],
AccessTokenValidity: NotRequired[int],
IdTokenValidity: NotRequired[int],
TokenValidityUnits: NotRequired[TokenValidityUnitsTypeTypeDef], # (1)
ReadAttributes: NotRequired[List[str]],
WriteAttributes: NotRequired[List[str]],
ExplicitAuthFlows: NotRequired[List[ExplicitAuthFlowsTypeType]], # (2)
SupportedIdentityProviders: NotRequired[List[str]],
CallbackURLs: NotRequired[List[str]],
LogoutURLs: NotRequired[List[str]],
DefaultRedirectURI: NotRequired[str],
AllowedOAuthFlows: NotRequired[List[OAuthFlowTypeType]], # (3)
AllowedOAuthScopes: NotRequired[List[str]],
AllowedOAuthFlowsUserPoolClient: NotRequired[bool],
AnalyticsConfiguration: NotRequired[AnalyticsConfigurationTypeTypeDef], # (4)
PreventUserExistenceErrors: NotRequired[PreventUserExistenceErrorTypesType], # (5)
EnableTokenRevocation: NotRequired[bool],
EnablePropagateAdditionalUserContextData: NotRequired[bool],
AuthSessionValidity: NotRequired[int],
- See TokenValidityUnitsTypeTypeDef
- See ExplicitAuthFlowsTypeType
- See OAuthFlowTypeType
- See AnalyticsConfigurationTypeTypeDef
- See PreventUserExistenceErrorTypesType
CreateUserPoolDomainRequestRequestTypeDef#
# CreateUserPoolDomainRequestRequestTypeDef definition
class CreateUserPoolDomainRequestRequestTypeDef(TypedDict):
Domain: str,
UserPoolId: str,
CustomDomainConfig: NotRequired[CustomDomainConfigTypeTypeDef], # (1)
DomainDescriptionTypeTypeDef#
# DomainDescriptionTypeTypeDef definition
class DomainDescriptionTypeTypeDef(TypedDict):
UserPoolId: NotRequired[str],
AWSAccountId: NotRequired[str],
Domain: NotRequired[str],
S3Bucket: NotRequired[str],
CloudFrontDistribution: NotRequired[str],
Version: NotRequired[str],
Status: NotRequired[DomainStatusTypeType], # (1)
CustomDomainConfig: NotRequired[CustomDomainConfigTypeTypeDef], # (2)
UpdateUserPoolDomainRequestRequestTypeDef#
# UpdateUserPoolDomainRequestRequestTypeDef definition
class UpdateUserPoolDomainRequestRequestTypeDef(TypedDict):
Domain: str,
UserPoolId: str,
CustomDomainConfig: CustomDomainConfigTypeTypeDef, # (1)
SmsMfaConfigTypeTypeDef#
# SmsMfaConfigTypeTypeDef definition
class SmsMfaConfigTypeTypeDef(TypedDict):
SmsAuthenticationMessage: NotRequired[str],
SmsConfiguration: NotRequired[SmsConfigurationTypeTypeDef], # (1)
GetUICustomizationResponseTypeDef#
# GetUICustomizationResponseTypeDef definition
class GetUICustomizationResponseTypeDef(TypedDict):
UICustomization: UICustomizationTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SetUICustomizationResponseTypeDef#
# SetUICustomizationResponseTypeDef definition
class SetUICustomizationResponseTypeDef(TypedDict):
UICustomization: UICustomizationTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
LambdaConfigTypeTypeDef#
# LambdaConfigTypeTypeDef definition
class LambdaConfigTypeTypeDef(TypedDict):
PreSignUp: NotRequired[str],
CustomMessage: NotRequired[str],
PostConfirmation: NotRequired[str],
PreAuthentication: NotRequired[str],
PostAuthentication: NotRequired[str],
DefineAuthChallenge: NotRequired[str],
CreateAuthChallenge: NotRequired[str],
VerifyAuthChallengeResponse: NotRequired[str],
PreTokenGeneration: NotRequired[str],
UserMigration: NotRequired[str],
PreTokenGenerationConfig: NotRequired[PreTokenGenerationVersionConfigTypeTypeDef], # (1)
CustomSMSSender: NotRequired[CustomSMSLambdaVersionConfigTypeTypeDef], # (2)
CustomEmailSender: NotRequired[CustomEmailLambdaVersionConfigTypeTypeDef], # (3)
KMSKeyID: NotRequired[str],
- See PreTokenGenerationVersionConfigTypeTypeDef
- See CustomSMSLambdaVersionConfigTypeTypeDef
- See CustomEmailLambdaVersionConfigTypeTypeDef
ListIdentityProvidersResponseTypeDef#
# ListIdentityProvidersResponseTypeDef definition
class ListIdentityProvidersResponseTypeDef(TypedDict):
Providers: List[ProviderDescriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUserPoolClientsResponseTypeDef#
# ListUserPoolClientsResponseTypeDef definition
class ListUserPoolClientsResponseTypeDef(TypedDict):
UserPoolClients: List[UserPoolClientDescriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NotifyConfigurationTypeTypeDef#
# NotifyConfigurationTypeTypeDef definition
class NotifyConfigurationTypeTypeDef(TypedDict):
SourceArn: str,
From: NotRequired[str],
ReplyTo: NotRequired[str],
BlockEmail: NotRequired[NotifyEmailTypeTypeDef], # (1)
NoActionEmail: NotRequired[NotifyEmailTypeTypeDef], # (1)
MfaEmail: NotRequired[NotifyEmailTypeTypeDef], # (1)
UserPoolPolicyTypeTypeDef#
# UserPoolPolicyTypeTypeDef definition
class UserPoolPolicyTypeTypeDef(TypedDict):
PasswordPolicy: NotRequired[PasswordPolicyTypeTypeDef], # (1)
SchemaAttributeTypeTypeDef#
# SchemaAttributeTypeTypeDef definition
class SchemaAttributeTypeTypeDef(TypedDict):
Name: NotRequired[str],
AttributeDataType: NotRequired[AttributeDataTypeType], # (1)
DeveloperOnlyAttribute: NotRequired[bool],
Mutable: NotRequired[bool],
Required: NotRequired[bool],
NumberAttributeConstraints: NotRequired[NumberAttributeConstraintsTypeTypeDef], # (2)
StringAttributeConstraints: NotRequired[StringAttributeConstraintsTypeTypeDef], # (3)
- See AttributeDataTypeType
- See NumberAttributeConstraintsTypeTypeDef
- See StringAttributeConstraintsTypeTypeDef
AdminGetDeviceResponseTypeDef#
# AdminGetDeviceResponseTypeDef definition
class AdminGetDeviceResponseTypeDef(TypedDict):
Device: DeviceTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AdminListDevicesResponseTypeDef#
# AdminListDevicesResponseTypeDef definition
class AdminListDevicesResponseTypeDef(TypedDict):
Devices: List[DeviceTypeTypeDef], # (1)
PaginationToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetDeviceResponseTypeDef#
# GetDeviceResponseTypeDef definition
class GetDeviceResponseTypeDef(TypedDict):
Device: DeviceTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDevicesResponseTypeDef#
# ListDevicesResponseTypeDef definition
class ListDevicesResponseTypeDef(TypedDict):
Devices: List[DeviceTypeTypeDef], # (1)
PaginationToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AdminCreateUserResponseTypeDef#
# AdminCreateUserResponseTypeDef definition
class AdminCreateUserResponseTypeDef(TypedDict):
User: UserTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUsersInGroupResponseTypeDef#
# ListUsersInGroupResponseTypeDef definition
class ListUsersInGroupResponseTypeDef(TypedDict):
Users: List[UserTypeTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUsersResponseTypeDef#
# ListUsersResponseTypeDef definition
class ListUsersResponseTypeDef(TypedDict):
Users: List[UserTypeTypeDef], # (1)
PaginationToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AdminListUserAuthEventsResponseTypeDef#
# AdminListUserAuthEventsResponseTypeDef definition
class AdminListUserAuthEventsResponseTypeDef(TypedDict):
AuthEvents: List[AuthEventTypeTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AdminInitiateAuthResponseTypeDef#
# AdminInitiateAuthResponseTypeDef definition
class AdminInitiateAuthResponseTypeDef(TypedDict):
ChallengeName: ChallengeNameTypeType, # (1)
Session: str,
ChallengeParameters: Dict[str, str],
AuthenticationResult: AuthenticationResultTypeTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
AdminRespondToAuthChallengeResponseTypeDef#
# AdminRespondToAuthChallengeResponseTypeDef definition
class AdminRespondToAuthChallengeResponseTypeDef(TypedDict):
ChallengeName: ChallengeNameTypeType, # (1)
Session: str,
ChallengeParameters: Dict[str, str],
AuthenticationResult: AuthenticationResultTypeTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
InitiateAuthResponseTypeDef#
# InitiateAuthResponseTypeDef definition
class InitiateAuthResponseTypeDef(TypedDict):
ChallengeName: ChallengeNameTypeType, # (1)
Session: str,
ChallengeParameters: Dict[str, str],
AuthenticationResult: AuthenticationResultTypeTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
RespondToAuthChallengeResponseTypeDef#
# RespondToAuthChallengeResponseTypeDef definition
class RespondToAuthChallengeResponseTypeDef(TypedDict):
ChallengeName: ChallengeNameTypeType, # (1)
Session: str,
ChallengeParameters: Dict[str, str],
AuthenticationResult: AuthenticationResultTypeTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
LogDeliveryConfigurationTypeTypeDef#
# LogDeliveryConfigurationTypeTypeDef definition
class LogDeliveryConfigurationTypeTypeDef(TypedDict):
UserPoolId: str,
LogConfigurations: List[LogConfigurationTypeTypeDef], # (1)
SetLogDeliveryConfigurationRequestRequestTypeDef#
# SetLogDeliveryConfigurationRequestRequestTypeDef definition
class SetLogDeliveryConfigurationRequestRequestTypeDef(TypedDict):
UserPoolId: str,
LogConfigurations: Sequence[LogConfigurationTypeTypeDef], # (1)
AdminInitiateAuthRequestRequestTypeDef#
# AdminInitiateAuthRequestRequestTypeDef definition
class AdminInitiateAuthRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ClientId: str,
AuthFlow: AuthFlowTypeType, # (1)
AuthParameters: NotRequired[Mapping[str, str]],
ClientMetadata: NotRequired[Mapping[str, str]],
AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef], # (2)
ContextData: NotRequired[ContextDataTypeTypeDef], # (3)
AdminRespondToAuthChallengeRequestRequestTypeDef#
# AdminRespondToAuthChallengeRequestRequestTypeDef definition
class AdminRespondToAuthChallengeRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ClientId: str,
ChallengeName: ChallengeNameTypeType, # (1)
ChallengeResponses: NotRequired[Mapping[str, str]],
Session: NotRequired[str],
AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef], # (2)
ContextData: NotRequired[ContextDataTypeTypeDef], # (3)
ClientMetadata: NotRequired[Mapping[str, str]],
CreateResourceServerResponseTypeDef#
# CreateResourceServerResponseTypeDef definition
class CreateResourceServerResponseTypeDef(TypedDict):
ResourceServer: ResourceServerTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeResourceServerResponseTypeDef#
# DescribeResourceServerResponseTypeDef definition
class DescribeResourceServerResponseTypeDef(TypedDict):
ResourceServer: ResourceServerTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListResourceServersResponseTypeDef#
# ListResourceServersResponseTypeDef definition
class ListResourceServersResponseTypeDef(TypedDict):
ResourceServers: List[ResourceServerTypeTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateResourceServerResponseTypeDef#
# UpdateResourceServerResponseTypeDef definition
class UpdateResourceServerResponseTypeDef(TypedDict):
ResourceServer: ResourceServerTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateUserPoolClientResponseTypeDef#
# CreateUserPoolClientResponseTypeDef definition
class CreateUserPoolClientResponseTypeDef(TypedDict):
UserPoolClient: UserPoolClientTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeUserPoolClientResponseTypeDef#
# DescribeUserPoolClientResponseTypeDef definition
class DescribeUserPoolClientResponseTypeDef(TypedDict):
UserPoolClient: UserPoolClientTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateUserPoolClientResponseTypeDef#
# UpdateUserPoolClientResponseTypeDef definition
class UpdateUserPoolClientResponseTypeDef(TypedDict):
UserPoolClient: UserPoolClientTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeUserPoolDomainResponseTypeDef#
# DescribeUserPoolDomainResponseTypeDef definition
class DescribeUserPoolDomainResponseTypeDef(TypedDict):
DomainDescription: DomainDescriptionTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetUserPoolMfaConfigResponseTypeDef#
# GetUserPoolMfaConfigResponseTypeDef definition
class GetUserPoolMfaConfigResponseTypeDef(TypedDict):
SmsMfaConfiguration: SmsMfaConfigTypeTypeDef, # (1)
SoftwareTokenMfaConfiguration: SoftwareTokenMfaConfigTypeTypeDef, # (2)
MfaConfiguration: UserPoolMfaTypeType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See SmsMfaConfigTypeTypeDef
- See SoftwareTokenMfaConfigTypeTypeDef
- See UserPoolMfaTypeType
- See ResponseMetadataTypeDef
SetUserPoolMfaConfigRequestRequestTypeDef#
# SetUserPoolMfaConfigRequestRequestTypeDef definition
class SetUserPoolMfaConfigRequestRequestTypeDef(TypedDict):
UserPoolId: str,
SmsMfaConfiguration: NotRequired[SmsMfaConfigTypeTypeDef], # (1)
SoftwareTokenMfaConfiguration: NotRequired[SoftwareTokenMfaConfigTypeTypeDef], # (2)
MfaConfiguration: NotRequired[UserPoolMfaTypeType], # (3)
SetUserPoolMfaConfigResponseTypeDef#
# SetUserPoolMfaConfigResponseTypeDef definition
class SetUserPoolMfaConfigResponseTypeDef(TypedDict):
SmsMfaConfiguration: SmsMfaConfigTypeTypeDef, # (1)
SoftwareTokenMfaConfiguration: SoftwareTokenMfaConfigTypeTypeDef, # (2)
MfaConfiguration: UserPoolMfaTypeType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See SmsMfaConfigTypeTypeDef
- See SoftwareTokenMfaConfigTypeTypeDef
- See UserPoolMfaTypeType
- See ResponseMetadataTypeDef
UserPoolDescriptionTypeTypeDef#
# UserPoolDescriptionTypeTypeDef definition
class UserPoolDescriptionTypeTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
LambdaConfig: NotRequired[LambdaConfigTypeTypeDef], # (1)
Status: NotRequired[StatusTypeType], # (2)
LastModifiedDate: NotRequired[datetime],
CreationDate: NotRequired[datetime],
AccountTakeoverRiskConfigurationTypeTypeDef#
# AccountTakeoverRiskConfigurationTypeTypeDef definition
class AccountTakeoverRiskConfigurationTypeTypeDef(TypedDict):
Actions: AccountTakeoverActionsTypeTypeDef, # (2)
NotifyConfiguration: NotRequired[NotifyConfigurationTypeTypeDef], # (1)
UpdateUserPoolRequestRequestTypeDef#
# UpdateUserPoolRequestRequestTypeDef definition
class UpdateUserPoolRequestRequestTypeDef(TypedDict):
UserPoolId: str,
Policies: NotRequired[UserPoolPolicyTypeTypeDef], # (1)
DeletionProtection: NotRequired[DeletionProtectionTypeType], # (2)
LambdaConfig: NotRequired[LambdaConfigTypeTypeDef], # (3)
AutoVerifiedAttributes: NotRequired[Sequence[VerifiedAttributeTypeType]], # (4)
SmsVerificationMessage: NotRequired[str],
EmailVerificationMessage: NotRequired[str],
EmailVerificationSubject: NotRequired[str],
VerificationMessageTemplate: NotRequired[VerificationMessageTemplateTypeTypeDef], # (5)
SmsAuthenticationMessage: NotRequired[str],
UserAttributeUpdateSettings: NotRequired[UserAttributeUpdateSettingsTypeTypeDef], # (6)
MfaConfiguration: NotRequired[UserPoolMfaTypeType], # (7)
DeviceConfiguration: NotRequired[DeviceConfigurationTypeTypeDef], # (8)
EmailConfiguration: NotRequired[EmailConfigurationTypeTypeDef], # (9)
SmsConfiguration: NotRequired[SmsConfigurationTypeTypeDef], # (10)
UserPoolTags: NotRequired[Mapping[str, str]],
AdminCreateUserConfig: NotRequired[AdminCreateUserConfigTypeTypeDef], # (11)
UserPoolAddOns: NotRequired[UserPoolAddOnsTypeTypeDef], # (12)
AccountRecoverySetting: NotRequired[AccountRecoverySettingTypeTypeDef], # (13)
- See UserPoolPolicyTypeTypeDef
- See DeletionProtectionTypeType
- See LambdaConfigTypeTypeDef
- See VerifiedAttributeTypeType
- See VerificationMessageTemplateTypeTypeDef
- See UserAttributeUpdateSettingsTypeTypeDef
- See UserPoolMfaTypeType
- See DeviceConfigurationTypeTypeDef
- See EmailConfigurationTypeTypeDef
- See SmsConfigurationTypeTypeDef
- See AdminCreateUserConfigTypeTypeDef
- See UserPoolAddOnsTypeTypeDef
- See AccountRecoverySettingTypeTypeDef
AddCustomAttributesRequestRequestTypeDef#
# AddCustomAttributesRequestRequestTypeDef definition
class AddCustomAttributesRequestRequestTypeDef(TypedDict):
UserPoolId: str,
CustomAttributes: Sequence[SchemaAttributeTypeTypeDef], # (1)
CreateUserPoolRequestRequestTypeDef#
# CreateUserPoolRequestRequestTypeDef definition
class CreateUserPoolRequestRequestTypeDef(TypedDict):
PoolName: str,
Policies: NotRequired[UserPoolPolicyTypeTypeDef], # (1)
DeletionProtection: NotRequired[DeletionProtectionTypeType], # (2)
LambdaConfig: NotRequired[LambdaConfigTypeTypeDef], # (3)
AutoVerifiedAttributes: NotRequired[Sequence[VerifiedAttributeTypeType]], # (4)
AliasAttributes: NotRequired[Sequence[AliasAttributeTypeType]], # (5)
UsernameAttributes: NotRequired[Sequence[UsernameAttributeTypeType]], # (6)
SmsVerificationMessage: NotRequired[str],
EmailVerificationMessage: NotRequired[str],
EmailVerificationSubject: NotRequired[str],
VerificationMessageTemplate: NotRequired[VerificationMessageTemplateTypeTypeDef], # (7)
SmsAuthenticationMessage: NotRequired[str],
MfaConfiguration: NotRequired[UserPoolMfaTypeType], # (8)
UserAttributeUpdateSettings: NotRequired[UserAttributeUpdateSettingsTypeTypeDef], # (9)
DeviceConfiguration: NotRequired[DeviceConfigurationTypeTypeDef], # (10)
EmailConfiguration: NotRequired[EmailConfigurationTypeTypeDef], # (11)
SmsConfiguration: NotRequired[SmsConfigurationTypeTypeDef], # (12)
UserPoolTags: NotRequired[Mapping[str, str]],
AdminCreateUserConfig: NotRequired[AdminCreateUserConfigTypeTypeDef], # (13)
Schema: NotRequired[Sequence[SchemaAttributeTypeTypeDef]], # (14)
UserPoolAddOns: NotRequired[UserPoolAddOnsTypeTypeDef], # (15)
UsernameConfiguration: NotRequired[UsernameConfigurationTypeTypeDef], # (16)
AccountRecoverySetting: NotRequired[AccountRecoverySettingTypeTypeDef], # (17)
- 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
UserPoolTypeTypeDef#
# UserPoolTypeTypeDef definition
class UserPoolTypeTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
Policies: NotRequired[UserPoolPolicyTypeTypeDef], # (1)
DeletionProtection: NotRequired[DeletionProtectionTypeType], # (2)
LambdaConfig: NotRequired[LambdaConfigTypeTypeDef], # (3)
Status: NotRequired[StatusTypeType], # (4)
LastModifiedDate: NotRequired[datetime],
CreationDate: NotRequired[datetime],
SchemaAttributes: NotRequired[List[SchemaAttributeTypeTypeDef]], # (5)
AutoVerifiedAttributes: NotRequired[List[VerifiedAttributeTypeType]], # (6)
AliasAttributes: NotRequired[List[AliasAttributeTypeType]], # (7)
UsernameAttributes: NotRequired[List[UsernameAttributeTypeType]], # (8)
SmsVerificationMessage: NotRequired[str],
EmailVerificationMessage: NotRequired[str],
EmailVerificationSubject: NotRequired[str],
VerificationMessageTemplate: NotRequired[VerificationMessageTemplateTypeTypeDef], # (9)
SmsAuthenticationMessage: NotRequired[str],
UserAttributeUpdateSettings: NotRequired[UserAttributeUpdateSettingsTypeTypeDef], # (10)
MfaConfiguration: NotRequired[UserPoolMfaTypeType], # (11)
DeviceConfiguration: NotRequired[DeviceConfigurationTypeTypeDef], # (12)
EstimatedNumberOfUsers: NotRequired[int],
EmailConfiguration: NotRequired[EmailConfigurationTypeTypeDef], # (13)
SmsConfiguration: NotRequired[SmsConfigurationTypeTypeDef], # (14)
UserPoolTags: NotRequired[Dict[str, str]],
SmsConfigurationFailure: NotRequired[str],
EmailConfigurationFailure: NotRequired[str],
Domain: NotRequired[str],
CustomDomain: NotRequired[str],
AdminCreateUserConfig: NotRequired[AdminCreateUserConfigTypeTypeDef], # (15)
UserPoolAddOns: NotRequired[UserPoolAddOnsTypeTypeDef], # (16)
UsernameConfiguration: NotRequired[UsernameConfigurationTypeTypeDef], # (17)
Arn: NotRequired[str],
AccountRecoverySetting: NotRequired[AccountRecoverySettingTypeTypeDef], # (18)
- See UserPoolPolicyTypeTypeDef
- See DeletionProtectionTypeType
- See LambdaConfigTypeTypeDef
- See StatusTypeType
- See SchemaAttributeTypeTypeDef
- See VerifiedAttributeTypeType
- See AliasAttributeTypeType
- See UsernameAttributeTypeType
- See VerificationMessageTemplateTypeTypeDef
- See UserAttributeUpdateSettingsTypeTypeDef
- See UserPoolMfaTypeType
- See DeviceConfigurationTypeTypeDef
- See EmailConfigurationTypeTypeDef
- See SmsConfigurationTypeTypeDef
- See AdminCreateUserConfigTypeTypeDef
- See UserPoolAddOnsTypeTypeDef
- See UsernameConfigurationTypeTypeDef
- See AccountRecoverySettingTypeTypeDef
GetLogDeliveryConfigurationResponseTypeDef#
# GetLogDeliveryConfigurationResponseTypeDef definition
class GetLogDeliveryConfigurationResponseTypeDef(TypedDict):
LogDeliveryConfiguration: LogDeliveryConfigurationTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SetLogDeliveryConfigurationResponseTypeDef#
# SetLogDeliveryConfigurationResponseTypeDef definition
class SetLogDeliveryConfigurationResponseTypeDef(TypedDict):
LogDeliveryConfiguration: LogDeliveryConfigurationTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUserPoolsResponseTypeDef#
# ListUserPoolsResponseTypeDef definition
class ListUserPoolsResponseTypeDef(TypedDict):
UserPools: List[UserPoolDescriptionTypeTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RiskConfigurationTypeTypeDef#
# RiskConfigurationTypeTypeDef definition
class RiskConfigurationTypeTypeDef(TypedDict):
UserPoolId: NotRequired[str],
ClientId: NotRequired[str],
CompromisedCredentialsRiskConfiguration: NotRequired[CompromisedCredentialsRiskConfigurationTypeTypeDef], # (1)
AccountTakeoverRiskConfiguration: NotRequired[AccountTakeoverRiskConfigurationTypeTypeDef], # (2)
RiskExceptionConfiguration: NotRequired[RiskExceptionConfigurationTypeTypeDef], # (3)
LastModifiedDate: NotRequired[datetime],
- See CompromisedCredentialsRiskConfigurationTypeTypeDef
- See AccountTakeoverRiskConfigurationTypeTypeDef
- See RiskExceptionConfigurationTypeTypeDef
SetRiskConfigurationRequestRequestTypeDef#
# SetRiskConfigurationRequestRequestTypeDef definition
class SetRiskConfigurationRequestRequestTypeDef(TypedDict):
UserPoolId: str,
ClientId: NotRequired[str],
CompromisedCredentialsRiskConfiguration: NotRequired[CompromisedCredentialsRiskConfigurationTypeTypeDef], # (1)
AccountTakeoverRiskConfiguration: NotRequired[AccountTakeoverRiskConfigurationTypeTypeDef], # (2)
RiskExceptionConfiguration: NotRequired[RiskExceptionConfigurationTypeTypeDef], # (3)
- See CompromisedCredentialsRiskConfigurationTypeTypeDef
- See AccountTakeoverRiskConfigurationTypeTypeDef
- See RiskExceptionConfigurationTypeTypeDef
CreateUserPoolResponseTypeDef#
# CreateUserPoolResponseTypeDef definition
class CreateUserPoolResponseTypeDef(TypedDict):
UserPool: UserPoolTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeUserPoolResponseTypeDef#
# DescribeUserPoolResponseTypeDef definition
class DescribeUserPoolResponseTypeDef(TypedDict):
UserPool: UserPoolTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeRiskConfigurationResponseTypeDef#
# DescribeRiskConfigurationResponseTypeDef definition
class DescribeRiskConfigurationResponseTypeDef(TypedDict):
RiskConfiguration: RiskConfigurationTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SetRiskConfigurationResponseTypeDef#
# SetRiskConfigurationResponseTypeDef definition
class SetRiskConfigurationResponseTypeDef(TypedDict):
RiskConfiguration: RiskConfigurationTypeTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)