Skip to content

Typed dictionaries

Index > CognitoIdentityProvider > Typed dictionaries

Auto-generated documentation for CognitoIdentityProvider type annotations stubs module mypy-boto3-cognito-idp.

RecoveryOptionTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import RecoveryOptionTypeTypeDef

def get_value() -> RecoveryOptionTypeTypeDef:
    return {
        "Priority": ...,
        "Name": ...,
    }
Definition
class RecoveryOptionTypeTypeDef(TypedDict):
    Priority: int,
    Name: RecoveryOptionNameTypeType,  # (1)
  1. See RecoveryOptionNameTypeType

AccountTakeoverActionTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import AccountTakeoverActionTypeTypeDef

def get_value() -> AccountTakeoverActionTypeTypeDef:
    return {
        "Notify": ...,
        "EventAction": ...,
    }
Definition
class AccountTakeoverActionTypeTypeDef(TypedDict):
    Notify: bool,
    EventAction: AccountTakeoverEventActionTypeType,  # (1)
  1. See AccountTakeoverEventActionTypeType

AdminAddUserToGroupRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import AttributeTypeTypeDef

def get_value() -> AttributeTypeTypeDef:
    return {
        "Name": ...,
    }
Definition
class AttributeTypeTypeDef(TypedDict):
    Name: str,
    Value: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import AdminDeleteUserRequestRequestTypeDef

def get_value() -> AdminDeleteUserRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
Definition
class AdminDeleteUserRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,

ProviderUserIdentifierTypeTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import AdminDisableUserRequestRequestTypeDef

def get_value() -> AdminDisableUserRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
Definition
class AdminDisableUserRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,

AdminEnableUserRequestRequestTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import AdminEnableUserRequestRequestTypeDef

def get_value() -> AdminEnableUserRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
Definition
class AdminEnableUserRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,

AdminForgetDeviceRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import AdminGetUserRequestRequestTypeDef

def get_value() -> AdminGetUserRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
Definition
class AdminGetUserRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,

MFAOptionTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import MFAOptionTypeTypeDef

def get_value() -> MFAOptionTypeTypeDef:
    return {
        "DeliveryMedium": ...,
    }
Definition
class MFAOptionTypeTypeDef(TypedDict):
    DeliveryMedium: NotRequired[DeliveryMediumTypeType],  # (1)
    AttributeName: NotRequired[str],
  1. See DeliveryMediumTypeType

AnalyticsMetadataTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import AnalyticsMetadataTypeTypeDef

def get_value() -> AnalyticsMetadataTypeTypeDef:
    return {
        "AnalyticsEndpointId": ...,
    }
Definition
class AnalyticsMetadataTypeTypeDef(TypedDict):
    AnalyticsEndpointId: NotRequired[str],

AdminListDevicesRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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)
  1. See FeedbackValueTypeType

AdminUpdateDeviceStatusRequestRequestTypeDef

Usage Example
from mypy_boto3_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)
  1. See DeviceRememberedStatusTypeType

AdminUserGlobalSignOutRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import ChallengeResponseTypeTypeDef

def get_value() -> ChallengeResponseTypeTypeDef:
    return {
        "ChallengeName": ...,
    }
Definition
class ChallengeResponseTypeTypeDef(TypedDict):
    ChallengeName: NotRequired[ChallengeNameType],  # (1)
    ChallengeResponse: NotRequired[ChallengeResponseType],  # (2)
  1. See ChallengeNameType
  2. See ChallengeResponseType

EventContextDataTypeTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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],
  1. See FeedbackValueTypeType

EventRiskTypeTypeDef

Usage Example
from mypy_boto3_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],
  1. See RiskDecisionTypeType
  2. See RiskLevelTypeType

NewDeviceMetadataTypeTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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],
  1. See DeliveryMediumTypeType

CompromisedCredentialsActionsTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import CompromisedCredentialsActionsTypeTypeDef

def get_value() -> CompromisedCredentialsActionsTypeTypeDef:
    return {
        "EventAction": ...,
    }
Definition
class CompromisedCredentialsActionsTypeTypeDef(TypedDict):
    EventAction: CompromisedCredentialsEventActionTypeType,  # (1)
  1. See CompromisedCredentialsEventActionTypeType

DeviceSecretVerifierConfigTypeTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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]],
  1. See IdentityProviderTypeTypeType

IdentityProviderTypeTypeDef

Usage Example
from mypy_boto3_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],
  1. See IdentityProviderTypeTypeType

ResourceServerScopeTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import ResourceServerScopeTypeTypeDef

def get_value() -> ResourceServerScopeTypeTypeDef:
    return {
        "ScopeName": ...,
        "ScopeDescription": ...,
    }
Definition
class ResourceServerScopeTypeTypeDef(TypedDict):
    ScopeName: str,
    ScopeDescription: str,

CreateUserImportJobRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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],
  1. See UserImportJobStatusTypeType

TokenValidityUnitsTypeTypeDef

Usage Example
from mypy_boto3_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)
  1. See TimeUnitsTypeType
  2. See TimeUnitsTypeType
  3. See TimeUnitsTypeType

CustomDomainConfigTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import CustomDomainConfigTypeTypeDef

def get_value() -> CustomDomainConfigTypeTypeDef:
    return {
        "CertificateArn": ...,
    }
Definition
class CustomDomainConfigTypeTypeDef(TypedDict):
    CertificateArn: str,

DeviceConfigurationTypeTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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],
  1. See EmailSendingAccountTypeType

SmsConfigurationTypeTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import UserAttributeUpdateSettingsTypeTypeDef

def get_value() -> UserAttributeUpdateSettingsTypeTypeDef:
    return {
        "AttributesRequireVerificationBeforeUpdate": ...,
    }
Definition
class UserAttributeUpdateSettingsTypeTypeDef(TypedDict):
    AttributesRequireVerificationBeforeUpdate: NotRequired[Sequence[VerifiedAttributeTypeType]],  # (1)
  1. See VerifiedAttributeTypeType

UserPoolAddOnsTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import UserPoolAddOnsTypeTypeDef

def get_value() -> UserPoolAddOnsTypeTypeDef:
    return {
        "AdvancedSecurityMode": ...,
    }
Definition
class UserPoolAddOnsTypeTypeDef(TypedDict):
    AdvancedSecurityMode: AdvancedSecurityModeTypeType,  # (1)
  1. See AdvancedSecurityModeTypeType

UsernameConfigurationTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import UsernameConfigurationTypeTypeDef

def get_value() -> UsernameConfigurationTypeTypeDef:
    return {
        "CaseSensitive": ...,
    }
Definition
class UsernameConfigurationTypeTypeDef(TypedDict):
    CaseSensitive: bool,

VerificationMessageTemplateTypeTypeDef

Usage Example
from mypy_boto3_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)
  1. See DefaultEmailOptionTypeType

CustomEmailLambdaVersionConfigTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import CustomEmailLambdaVersionConfigTypeTypeDef

def get_value() -> CustomEmailLambdaVersionConfigTypeTypeDef:
    return {
        "LambdaVersion": ...,
        "LambdaArn": ...,
    }
Definition
class CustomEmailLambdaVersionConfigTypeTypeDef(TypedDict):
    LambdaVersion: CustomEmailSenderLambdaVersionTypeType,  # (1)
    LambdaArn: str,
  1. See CustomEmailSenderLambdaVersionTypeType

CustomSMSLambdaVersionConfigTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import CustomSMSLambdaVersionConfigTypeTypeDef

def get_value() -> CustomSMSLambdaVersionConfigTypeTypeDef:
    return {
        "LambdaVersion": ...,
        "LambdaArn": ...,
    }
Definition
class CustomSMSLambdaVersionConfigTypeTypeDef(TypedDict):
    LambdaVersion: CustomSMSSenderLambdaVersionTypeType,  # (1)
    LambdaArn: str,
  1. See CustomSMSSenderLambdaVersionTypeType

DeleteGroupRequestRequestTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import DeleteGroupRequestRequestTypeDef

def get_value() -> DeleteGroupRequestRequestTypeDef:
    return {
        "GroupName": ...,
        "UserPoolId": ...,
    }
Definition
class DeleteGroupRequestRequestTypeDef(TypedDict):
    GroupName: str,
    UserPoolId: str,

DeleteIdentityProviderRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import DeleteUserPoolDomainRequestRequestTypeDef

def get_value() -> DeleteUserPoolDomainRequestRequestTypeDef:
    return {
        "Domain": ...,
        "UserPoolId": ...,
    }
Definition
class DeleteUserPoolDomainRequestRequestTypeDef(TypedDict):
    Domain: str,
    UserPoolId: str,

DeleteUserPoolRequestRequestTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import DeleteUserPoolRequestRequestTypeDef

def get_value() -> DeleteUserPoolRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
Definition
class DeleteUserPoolRequestRequestTypeDef(TypedDict):
    UserPoolId: str,

DeleteUserRequestRequestTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import DeleteUserRequestRequestTypeDef

def get_value() -> DeleteUserRequestRequestTypeDef:
    return {
        "AccessToken": ...,
    }
Definition
class DeleteUserRequestRequestTypeDef(TypedDict):
    AccessToken: str,

DescribeIdentityProviderRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import DescribeUserImportJobRequestRequestTypeDef

def get_value() -> DescribeUserImportJobRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "JobId": ...,
    }
Definition
class DescribeUserImportJobRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    JobId: str,

DescribeUserPoolClientRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import DescribeUserPoolDomainRequestRequestTypeDef

def get_value() -> DescribeUserPoolDomainRequestRequestTypeDef:
    return {
        "Domain": ...,
    }
Definition
class DescribeUserPoolDomainRequestRequestTypeDef(TypedDict):
    Domain: str,

DescribeUserPoolRequestRequestTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import DescribeUserPoolRequestRequestTypeDef

def get_value() -> DescribeUserPoolRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
Definition
class DescribeUserPoolRequestRequestTypeDef(TypedDict):
    UserPoolId: str,

ForgetDeviceRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import GetCSVHeaderRequestRequestTypeDef

def get_value() -> GetCSVHeaderRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
Definition
class GetCSVHeaderRequestRequestTypeDef(TypedDict):
    UserPoolId: str,

GetDeviceRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import GetGroupRequestRequestTypeDef

def get_value() -> GetGroupRequestRequestTypeDef:
    return {
        "GroupName": ...,
        "UserPoolId": ...,
    }
Definition
class GetGroupRequestRequestTypeDef(TypedDict):
    GroupName: str,
    UserPoolId: str,

GetIdentityProviderByIdentifierRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import GetSigningCertificateRequestRequestTypeDef

def get_value() -> GetSigningCertificateRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
Definition
class GetSigningCertificateRequestRequestTypeDef(TypedDict):
    UserPoolId: str,

GetUICustomizationRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import GetUserPoolMfaConfigRequestRequestTypeDef

def get_value() -> GetUserPoolMfaConfigRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
Definition
class GetUserPoolMfaConfigRequestRequestTypeDef(TypedDict):
    UserPoolId: str,

SoftwareTokenMfaConfigTypeTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import SoftwareTokenMfaConfigTypeTypeDef

def get_value() -> SoftwareTokenMfaConfigTypeTypeDef:
    return {
        "Enabled": ...,
    }
Definition
class SoftwareTokenMfaConfigTypeTypeDef(TypedDict):
    Enabled: NotRequired[bool],

GetUserRequestRequestTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import GetUserRequestRequestTypeDef

def get_value() -> GetUserRequestRequestTypeDef:
    return {
        "AccessToken": ...,
    }
Definition
class GetUserRequestRequestTypeDef(TypedDict):
    AccessToken: str,

GlobalSignOutRequestRequestTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import GlobalSignOutRequestRequestTypeDef

def get_value() -> GlobalSignOutRequestRequestTypeDef:
    return {
        "AccessToken": ...,
    }
Definition
class GlobalSignOutRequestRequestTypeDef(TypedDict):
    AccessToken: str,

ListDevicesRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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],
  1. See IdentityProviderTypeTypeType

ListResourceServersRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListUserImportJobsRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import StartUserImportJobRequestRequestTypeDef

def get_value() -> StartUserImportJobRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "JobId": ...,
    }
Definition
class StartUserImportJobRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    JobId: str,

StopUserImportJobRequestRequestTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import StopUserImportJobRequestRequestTypeDef

def get_value() -> StopUserImportJobRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "JobId": ...,
    }
Definition
class StopUserImportJobRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    JobId: str,

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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)
  1. See FeedbackValueTypeType

UpdateDeviceStatusRequestRequestTypeDef

Usage Example
from mypy_boto3_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)
  1. See DeviceRememberedStatusTypeType

UpdateGroupRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_cognito_idp.type_defs import AccountRecoverySettingTypeTypeDef

def get_value() -> AccountRecoverySettingTypeTypeDef:
    return {
        "RecoveryMechanisms": ...,
    }
Definition
class AccountRecoverySettingTypeTypeDef(TypedDict):
    RecoveryMechanisms: NotRequired[Sequence[RecoveryOptionTypeTypeDef]],  # (1)
  1. See RecoveryOptionTypeTypeDef

AccountTakeoverActionsTypeTypeDef

Usage Example
from mypy_boto3_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)
  1. See AccountTakeoverActionTypeTypeDef
  2. See AccountTakeoverActionTypeTypeDef
  3. See AccountTakeoverActionTypeTypeDef

AdminCreateUserConfigTypeTypeDef

Usage Example
from mypy_boto3_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)
  1. See MessageTemplateTypeTypeDef

AdminCreateUserRequestRequestTypeDef

Usage Example
from mypy_boto3_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]],
  1. See AttributeTypeTypeDef
  2. See AttributeTypeTypeDef
  3. See MessageActionTypeType
  4. See DeliveryMediumTypeType

AdminUpdateUserAttributesRequestRequestTypeDef

Usage Example
from mypy_boto3_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]],
  1. See AttributeTypeTypeDef

DeviceTypeTypeDef

Usage Example
from mypy_boto3_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],
  1. See AttributeTypeTypeDef

UpdateUserAttributesRequestRequestTypeDef

Usage Example
from mypy_boto3_cognito_idp.type_defs import UpdateUserAttributesRequestRequestTypeDef

def get_value() -> UpdateUserAttributesRequestRequestTypeDef:
    return {
        "UserAttributes": ...,
        "AccessToken":