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