Type definitions

Index > CognitoIdentityProvider > Type definitions

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

BlobTypeDef

# BlobTypeDef Union usage example

from mypy_boto3_cognito_idp.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

RiskExceptionConfigurationTypeUnionTypeDef

# RiskExceptionConfigurationTypeUnionTypeDef Union usage example

from mypy_boto3_cognito_idp.type_defs import RiskExceptionConfigurationTypeUnionTypeDef


def get_value() -> RiskExceptionConfigurationTypeUnionTypeDef:
    return ...


# RiskExceptionConfigurationTypeUnionTypeDef definition

RiskExceptionConfigurationTypeUnionTypeDef = Union[
    RiskExceptionConfigurationTypeTypeDef,  # (1)
    RiskExceptionConfigurationTypeOutputTypeDef,  # (2)
]

1. See RiskExceptionConfigurationTypeTypeDef
2. See RiskExceptionConfigurationTypeOutputTypeDef

UserAttributeUpdateSettingsTypeUnionTypeDef

# UserAttributeUpdateSettingsTypeUnionTypeDef Union usage example

from mypy_boto3_cognito_idp.type_defs import UserAttributeUpdateSettingsTypeUnionTypeDef


def get_value() -> UserAttributeUpdateSettingsTypeUnionTypeDef:
    return ...


# UserAttributeUpdateSettingsTypeUnionTypeDef definition

UserAttributeUpdateSettingsTypeUnionTypeDef = Union[
    UserAttributeUpdateSettingsTypeTypeDef,  # (1)
    UserAttributeUpdateSettingsTypeOutputTypeDef,  # (2)
]

1. See UserAttributeUpdateSettingsTypeTypeDef
2. See UserAttributeUpdateSettingsTypeOutputTypeDef

AccountRecoverySettingTypeUnionTypeDef

# AccountRecoverySettingTypeUnionTypeDef Union usage example

from mypy_boto3_cognito_idp.type_defs import AccountRecoverySettingTypeUnionTypeDef


def get_value() -> AccountRecoverySettingTypeUnionTypeDef:
    return ...


# AccountRecoverySettingTypeUnionTypeDef definition

AccountRecoverySettingTypeUnionTypeDef = Union[
    AccountRecoverySettingTypeTypeDef,  # (1)
    AccountRecoverySettingTypeOutputTypeDef,  # (2)
]

1. See AccountRecoverySettingTypeTypeDef
2. See AccountRecoverySettingTypeOutputTypeDef

AssetTypeUnionTypeDef

# AssetTypeUnionTypeDef Union usage example

from mypy_boto3_cognito_idp.type_defs import AssetTypeUnionTypeDef


def get_value() -> AssetTypeUnionTypeDef:
    return ...


# AssetTypeUnionTypeDef definition

AssetTypeUnionTypeDef = Union[
    AssetTypeTypeDef,  # (1)
    AssetTypeOutputTypeDef,  # (2)
]

1. See AssetTypeTypeDef
2. See AssetTypeOutputTypeDef

CompromisedCredentialsRiskConfigurationTypeUnionTypeDef

# CompromisedCredentialsRiskConfigurationTypeUnionTypeDef Union usage example

from mypy_boto3_cognito_idp.type_defs import CompromisedCredentialsRiskConfigurationTypeUnionTypeDef


def get_value() -> CompromisedCredentialsRiskConfigurationTypeUnionTypeDef:
    return ...


# CompromisedCredentialsRiskConfigurationTypeUnionTypeDef definition

CompromisedCredentialsRiskConfigurationTypeUnionTypeDef = Union[
    CompromisedCredentialsRiskConfigurationTypeTypeDef,  # (1)
    CompromisedCredentialsRiskConfigurationTypeOutputTypeDef,  # (2)
]

1. See CompromisedCredentialsRiskConfigurationTypeTypeDef
2. See CompromisedCredentialsRiskConfigurationTypeOutputTypeDef

UserPoolPolicyTypeUnionTypeDef

# UserPoolPolicyTypeUnionTypeDef Union usage example

from mypy_boto3_cognito_idp.type_defs import UserPoolPolicyTypeUnionTypeDef


def get_value() -> UserPoolPolicyTypeUnionTypeDef:
    return ...


# UserPoolPolicyTypeUnionTypeDef definition

UserPoolPolicyTypeUnionTypeDef = Union[
    UserPoolPolicyTypeTypeDef,  # (1)
    UserPoolPolicyTypeOutputTypeDef,  # (2)
]

1. See UserPoolPolicyTypeTypeDef
2. See UserPoolPolicyTypeOutputTypeDef

RecoveryOptionTypeTypeDef

# RecoveryOptionTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import RecoveryOptionTypeTypeDef


def get_value() -> RecoveryOptionTypeTypeDef:
    return {
        "Priority": ...,
    }


# RecoveryOptionTypeTypeDef definition

class RecoveryOptionTypeTypeDef(TypedDict):
    Priority: int,
    Name: RecoveryOptionNameTypeType,  # (1)

1. See RecoveryOptionNameTypeType

AccountTakeoverActionTypeTypeDef

# AccountTakeoverActionTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AccountTakeoverActionTypeTypeDef


def get_value() -> AccountTakeoverActionTypeTypeDef:
    return {
        "Notify": ...,
    }


# AccountTakeoverActionTypeTypeDef definition

class AccountTakeoverActionTypeTypeDef(TypedDict):
    Notify: bool,
    EventAction: AccountTakeoverEventActionTypeType,  # (1)

1. See AccountTakeoverEventActionTypeType

AdminAddUserToGroupRequestTypeDef

# AdminAddUserToGroupRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminAddUserToGroupRequestTypeDef


def get_value() -> AdminAddUserToGroupRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminAddUserToGroupRequestTypeDef definition

class AdminAddUserToGroupRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    GroupName: str,

AdminConfirmSignUpRequestTypeDef

# AdminConfirmSignUpRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminConfirmSignUpRequestTypeDef


def get_value() -> AdminConfirmSignUpRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminConfirmSignUpRequestTypeDef definition

class AdminConfirmSignUpRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    ClientMetadata: NotRequired[Mapping[str, str]],

MessageTemplateTypeTypeDef

# MessageTemplateTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import MessageTemplateTypeTypeDef


def get_value() -> MessageTemplateTypeTypeDef:
    return {
        "SMSMessage": ...,
    }


# MessageTemplateTypeTypeDef definition

class MessageTemplateTypeTypeDef(TypedDict):
    SMSMessage: NotRequired[str],
    EmailMessage: NotRequired[str],
    EmailSubject: NotRequired[str],

AttributeTypeTypeDef

# AttributeTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AttributeTypeTypeDef


def get_value() -> AttributeTypeTypeDef:
    return {
        "Name": ...,
    }


# AttributeTypeTypeDef definition

class AttributeTypeTypeDef(TypedDict):
    Name: str,
    Value: NotRequired[str],

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

AdminDeleteUserAttributesRequestTypeDef

# AdminDeleteUserAttributesRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminDeleteUserAttributesRequestTypeDef


def get_value() -> AdminDeleteUserAttributesRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminDeleteUserAttributesRequestTypeDef definition

class AdminDeleteUserAttributesRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    UserAttributeNames: Sequence[str],

AdminDeleteUserRequestTypeDef

# AdminDeleteUserRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminDeleteUserRequestTypeDef


def get_value() -> AdminDeleteUserRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminDeleteUserRequestTypeDef definition

class AdminDeleteUserRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,

ProviderUserIdentifierTypeTypeDef

# ProviderUserIdentifierTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ProviderUserIdentifierTypeTypeDef


def get_value() -> ProviderUserIdentifierTypeTypeDef:
    return {
        "ProviderName": ...,
    }


# ProviderUserIdentifierTypeTypeDef definition

class ProviderUserIdentifierTypeTypeDef(TypedDict):
    ProviderName: NotRequired[str],
    ProviderAttributeName: NotRequired[str],
    ProviderAttributeValue: NotRequired[str],

AdminDisableUserRequestTypeDef

# AdminDisableUserRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminDisableUserRequestTypeDef


def get_value() -> AdminDisableUserRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminDisableUserRequestTypeDef definition

class AdminDisableUserRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,

AdminEnableUserRequestTypeDef

# AdminEnableUserRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminEnableUserRequestTypeDef


def get_value() -> AdminEnableUserRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminEnableUserRequestTypeDef definition

class AdminEnableUserRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,

AdminForgetDeviceRequestTypeDef

# AdminForgetDeviceRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminForgetDeviceRequestTypeDef


def get_value() -> AdminForgetDeviceRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminForgetDeviceRequestTypeDef definition

class AdminForgetDeviceRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    DeviceKey: str,

AdminGetDeviceRequestTypeDef

# AdminGetDeviceRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminGetDeviceRequestTypeDef


def get_value() -> AdminGetDeviceRequestTypeDef:
    return {
        "DeviceKey": ...,
    }


# AdminGetDeviceRequestTypeDef definition

class AdminGetDeviceRequestTypeDef(TypedDict):
    DeviceKey: str,
    UserPoolId: str,
    Username: str,

AdminGetUserRequestTypeDef

# AdminGetUserRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminGetUserRequestTypeDef


def get_value() -> AdminGetUserRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminGetUserRequestTypeDef definition

class AdminGetUserRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,

MFAOptionTypeTypeDef

# MFAOptionTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import MFAOptionTypeTypeDef


def get_value() -> MFAOptionTypeTypeDef:
    return {
        "DeliveryMedium": ...,
    }


# MFAOptionTypeTypeDef definition

class MFAOptionTypeTypeDef(TypedDict):
    DeliveryMedium: NotRequired[DeliveryMediumTypeType],  # (1)
    AttributeName: NotRequired[str],

1. See DeliveryMediumTypeType

AnalyticsMetadataTypeTypeDef

# AnalyticsMetadataTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AnalyticsMetadataTypeTypeDef


def get_value() -> AnalyticsMetadataTypeTypeDef:
    return {
        "AnalyticsEndpointId": ...,
    }


# AnalyticsMetadataTypeTypeDef definition

class AnalyticsMetadataTypeTypeDef(TypedDict):
    AnalyticsEndpointId: NotRequired[str],

AdminListDevicesRequestTypeDef

# AdminListDevicesRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminListDevicesRequestTypeDef


def get_value() -> AdminListDevicesRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminListDevicesRequestTypeDef definition

class AdminListDevicesRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    Limit: NotRequired[int],
    PaginationToken: NotRequired[str],

PaginatorConfigTypeDef

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

AdminListGroupsForUserRequestTypeDef

# AdminListGroupsForUserRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminListGroupsForUserRequestTypeDef


def get_value() -> AdminListGroupsForUserRequestTypeDef:
    return {
        "Username": ...,
    }


# AdminListGroupsForUserRequestTypeDef definition

class AdminListGroupsForUserRequestTypeDef(TypedDict):
    Username: str,
    UserPoolId: str,
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

GroupTypeTypeDef

# GroupTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GroupTypeTypeDef


def get_value() -> GroupTypeTypeDef:
    return {
        "GroupName": ...,
    }


# GroupTypeTypeDef definition

class GroupTypeTypeDef(TypedDict):
    GroupName: NotRequired[str],
    UserPoolId: NotRequired[str],
    Description: NotRequired[str],
    RoleArn: NotRequired[str],
    Precedence: NotRequired[int],
    LastModifiedDate: NotRequired[datetime.datetime],
    CreationDate: NotRequired[datetime.datetime],

AdminListUserAuthEventsRequestTypeDef

# AdminListUserAuthEventsRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminListUserAuthEventsRequestTypeDef


def get_value() -> AdminListUserAuthEventsRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminListUserAuthEventsRequestTypeDef definition

class AdminListUserAuthEventsRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

AdminRemoveUserFromGroupRequestTypeDef

# AdminRemoveUserFromGroupRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminRemoveUserFromGroupRequestTypeDef


def get_value() -> AdminRemoveUserFromGroupRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminRemoveUserFromGroupRequestTypeDef definition

class AdminRemoveUserFromGroupRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    GroupName: str,

AdminResetUserPasswordRequestTypeDef

# AdminResetUserPasswordRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminResetUserPasswordRequestTypeDef


def get_value() -> AdminResetUserPasswordRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminResetUserPasswordRequestTypeDef definition

class AdminResetUserPasswordRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    ClientMetadata: NotRequired[Mapping[str, str]],

EmailMfaSettingsTypeTypeDef

# EmailMfaSettingsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import EmailMfaSettingsTypeTypeDef


def get_value() -> EmailMfaSettingsTypeTypeDef:
    return {
        "Enabled": ...,
    }


# EmailMfaSettingsTypeTypeDef definition

class EmailMfaSettingsTypeTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    PreferredMfa: NotRequired[bool],

SMSMfaSettingsTypeTypeDef

# SMSMfaSettingsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SMSMfaSettingsTypeTypeDef


def get_value() -> SMSMfaSettingsTypeTypeDef:
    return {
        "Enabled": ...,
    }


# SMSMfaSettingsTypeTypeDef definition

class SMSMfaSettingsTypeTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    PreferredMfa: NotRequired[bool],

SoftwareTokenMfaSettingsTypeTypeDef

# SoftwareTokenMfaSettingsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SoftwareTokenMfaSettingsTypeTypeDef


def get_value() -> SoftwareTokenMfaSettingsTypeTypeDef:
    return {
        "Enabled": ...,
    }


# SoftwareTokenMfaSettingsTypeTypeDef definition

class SoftwareTokenMfaSettingsTypeTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    PreferredMfa: NotRequired[bool],

AdminSetUserPasswordRequestTypeDef

# AdminSetUserPasswordRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminSetUserPasswordRequestTypeDef


def get_value() -> AdminSetUserPasswordRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminSetUserPasswordRequestTypeDef definition

class AdminSetUserPasswordRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    Password: str,
    Permanent: NotRequired[bool],

AdminUpdateAuthEventFeedbackRequestTypeDef

# AdminUpdateAuthEventFeedbackRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminUpdateAuthEventFeedbackRequestTypeDef


def get_value() -> AdminUpdateAuthEventFeedbackRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminUpdateAuthEventFeedbackRequestTypeDef definition

class AdminUpdateAuthEventFeedbackRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    EventId: str,
    FeedbackValue: FeedbackValueTypeType,  # (1)

1. See FeedbackValueTypeType

AdminUpdateDeviceStatusRequestTypeDef

# AdminUpdateDeviceStatusRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminUpdateDeviceStatusRequestTypeDef


def get_value() -> AdminUpdateDeviceStatusRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminUpdateDeviceStatusRequestTypeDef definition

class AdminUpdateDeviceStatusRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    DeviceKey: str,
    DeviceRememberedStatus: NotRequired[DeviceRememberedStatusTypeType],  # (1)

1. See DeviceRememberedStatusTypeType

AdminUserGlobalSignOutRequestTypeDef

# AdminUserGlobalSignOutRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminUserGlobalSignOutRequestTypeDef


def get_value() -> AdminUserGlobalSignOutRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminUserGlobalSignOutRequestTypeDef definition

class AdminUserGlobalSignOutRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,

AdvancedSecurityAdditionalFlowsTypeTypeDef

# AdvancedSecurityAdditionalFlowsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdvancedSecurityAdditionalFlowsTypeTypeDef


def get_value() -> AdvancedSecurityAdditionalFlowsTypeTypeDef:
    return {
        "CustomAuthMode": ...,
    }


# AdvancedSecurityAdditionalFlowsTypeTypeDef definition

class AdvancedSecurityAdditionalFlowsTypeTypeDef(TypedDict):
    CustomAuthMode: NotRequired[AdvancedSecurityEnabledModeTypeType],  # (1)

1. See AdvancedSecurityEnabledModeTypeType

AnalyticsConfigurationTypeTypeDef

# AnalyticsConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AnalyticsConfigurationTypeTypeDef


def get_value() -> AnalyticsConfigurationTypeTypeDef:
    return {
        "ApplicationId": ...,
    }


# AnalyticsConfigurationTypeTypeDef definition

class AnalyticsConfigurationTypeTypeDef(TypedDict):
    ApplicationId: NotRequired[str],
    ApplicationArn: NotRequired[str],
    RoleArn: NotRequired[str],
    ExternalId: NotRequired[str],
    UserDataShared: NotRequired[bool],

AssetTypeOutputTypeDef

# AssetTypeOutputTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AssetTypeOutputTypeDef


def get_value() -> AssetTypeOutputTypeDef:
    return {
        "Category": ...,
    }


# AssetTypeOutputTypeDef definition

class AssetTypeOutputTypeDef(TypedDict):
    Category: AssetCategoryTypeType,  # (1)
    ColorMode: ColorSchemeModeTypeType,  # (2)
    Extension: AssetExtensionTypeType,  # (3)
    Bytes: NotRequired[bytes],
    ResourceId: NotRequired[str],

1. See AssetCategoryTypeType
2. See ColorSchemeModeTypeType
3. See AssetExtensionTypeType

AssociateSoftwareTokenRequestTypeDef

# AssociateSoftwareTokenRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AssociateSoftwareTokenRequestTypeDef


def get_value() -> AssociateSoftwareTokenRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# AssociateSoftwareTokenRequestTypeDef definition

class AssociateSoftwareTokenRequestTypeDef(TypedDict):
    AccessToken: NotRequired[str],
    Session: NotRequired[str],

ChallengeResponseTypeTypeDef

# ChallengeResponseTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ChallengeResponseTypeTypeDef


def get_value() -> ChallengeResponseTypeTypeDef:
    return {
        "ChallengeName": ...,
    }


# ChallengeResponseTypeTypeDef definition

class ChallengeResponseTypeTypeDef(TypedDict):
    ChallengeName: NotRequired[ChallengeNameType],  # (1)
    ChallengeResponse: NotRequired[ChallengeResponseType],  # (2)

1. See ChallengeNameType
2. See ChallengeResponseType

EventContextDataTypeTypeDef

# EventContextDataTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import EventContextDataTypeTypeDef


def get_value() -> EventContextDataTypeTypeDef:
    return {
        "IpAddress": ...,
    }


# EventContextDataTypeTypeDef definition

class EventContextDataTypeTypeDef(TypedDict):
    IpAddress: NotRequired[str],
    DeviceName: NotRequired[str],
    Timezone: NotRequired[str],
    City: NotRequired[str],
    Country: NotRequired[str],

EventFeedbackTypeTypeDef

# EventFeedbackTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import EventFeedbackTypeTypeDef


def get_value() -> EventFeedbackTypeTypeDef:
    return {
        "FeedbackValue": ...,
    }


# EventFeedbackTypeTypeDef definition

class EventFeedbackTypeTypeDef(TypedDict):
    FeedbackValue: FeedbackValueTypeType,  # (1)
    Provider: str,
    FeedbackDate: NotRequired[datetime.datetime],

1. See FeedbackValueTypeType

EventRiskTypeTypeDef

# EventRiskTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import EventRiskTypeTypeDef


def get_value() -> EventRiskTypeTypeDef:
    return {
        "RiskDecision": ...,
    }


# EventRiskTypeTypeDef definition

class EventRiskTypeTypeDef(TypedDict):
    RiskDecision: NotRequired[RiskDecisionTypeType],  # (1)
    RiskLevel: NotRequired[RiskLevelTypeType],  # (2)
    CompromisedCredentialsDetected: NotRequired[bool],

1. See RiskDecisionTypeType
2. See RiskLevelTypeType

NewDeviceMetadataTypeTypeDef

# NewDeviceMetadataTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import NewDeviceMetadataTypeTypeDef


def get_value() -> NewDeviceMetadataTypeTypeDef:
    return {
        "DeviceKey": ...,
    }


# NewDeviceMetadataTypeTypeDef definition

class NewDeviceMetadataTypeTypeDef(TypedDict):
    DeviceKey: NotRequired[str],
    DeviceGroupKey: NotRequired[str],

ChangePasswordRequestTypeDef

# ChangePasswordRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ChangePasswordRequestTypeDef


def get_value() -> ChangePasswordRequestTypeDef:
    return {
        "ProposedPassword": ...,
    }


# ChangePasswordRequestTypeDef definition

class ChangePasswordRequestTypeDef(TypedDict):
    ProposedPassword: str,
    AccessToken: str,
    PreviousPassword: NotRequired[str],

CloudWatchLogsConfigurationTypeTypeDef

# CloudWatchLogsConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CloudWatchLogsConfigurationTypeTypeDef


def get_value() -> CloudWatchLogsConfigurationTypeTypeDef:
    return {
        "LogGroupArn": ...,
    }


# CloudWatchLogsConfigurationTypeTypeDef definition

class CloudWatchLogsConfigurationTypeTypeDef(TypedDict):
    LogGroupArn: NotRequired[str],

CodeDeliveryDetailsTypeTypeDef

# CodeDeliveryDetailsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CodeDeliveryDetailsTypeTypeDef


def get_value() -> CodeDeliveryDetailsTypeTypeDef:
    return {
        "Destination": ...,
    }


# CodeDeliveryDetailsTypeTypeDef definition

class CodeDeliveryDetailsTypeTypeDef(TypedDict):
    Destination: NotRequired[str],
    DeliveryMedium: NotRequired[DeliveryMediumTypeType],  # (1)
    AttributeName: NotRequired[str],

1. See DeliveryMediumTypeType

CompleteWebAuthnRegistrationRequestTypeDef

# CompleteWebAuthnRegistrationRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CompleteWebAuthnRegistrationRequestTypeDef


def get_value() -> CompleteWebAuthnRegistrationRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# CompleteWebAuthnRegistrationRequestTypeDef definition

class CompleteWebAuthnRegistrationRequestTypeDef(TypedDict):
    AccessToken: str,
    Credential: Mapping[str, Any],

CompromisedCredentialsActionsTypeTypeDef

# CompromisedCredentialsActionsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CompromisedCredentialsActionsTypeTypeDef


def get_value() -> CompromisedCredentialsActionsTypeTypeDef:
    return {
        "EventAction": ...,
    }


# CompromisedCredentialsActionsTypeTypeDef definition

class CompromisedCredentialsActionsTypeTypeDef(TypedDict):
    EventAction: CompromisedCredentialsEventActionTypeType,  # (1)

1. See CompromisedCredentialsEventActionTypeType

DeviceSecretVerifierConfigTypeTypeDef

# DeviceSecretVerifierConfigTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeviceSecretVerifierConfigTypeTypeDef


def get_value() -> DeviceSecretVerifierConfigTypeTypeDef:
    return {
        "PasswordVerifier": ...,
    }


# DeviceSecretVerifierConfigTypeTypeDef definition

class DeviceSecretVerifierConfigTypeTypeDef(TypedDict):
    PasswordVerifier: NotRequired[str],
    Salt: NotRequired[str],

UserContextDataTypeTypeDef

# UserContextDataTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserContextDataTypeTypeDef


def get_value() -> UserContextDataTypeTypeDef:
    return {
        "IpAddress": ...,
    }


# UserContextDataTypeTypeDef definition

class UserContextDataTypeTypeDef(TypedDict):
    IpAddress: NotRequired[str],
    EncodedData: NotRequired[str],

HttpHeaderTypeDef

# HttpHeaderTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import HttpHeaderTypeDef


def get_value() -> HttpHeaderTypeDef:
    return {
        "headerName": ...,
    }


# HttpHeaderTypeDef definition

class HttpHeaderTypeDef(TypedDict):
    headerName: NotRequired[str],
    headerValue: NotRequired[str],

CreateGroupRequestTypeDef

# CreateGroupRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateGroupRequestTypeDef


def get_value() -> CreateGroupRequestTypeDef:
    return {
        "GroupName": ...,
    }


# CreateGroupRequestTypeDef definition

class CreateGroupRequestTypeDef(TypedDict):
    GroupName: str,
    UserPoolId: str,
    Description: NotRequired[str],
    RoleArn: NotRequired[str],
    Precedence: NotRequired[int],

CreateIdentityProviderRequestTypeDef

# CreateIdentityProviderRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateIdentityProviderRequestTypeDef


def get_value() -> CreateIdentityProviderRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# CreateIdentityProviderRequestTypeDef definition

class CreateIdentityProviderRequestTypeDef(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

# IdentityProviderTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import IdentityProviderTypeTypeDef


def get_value() -> IdentityProviderTypeTypeDef:
    return {
        "UserPoolId": ...,
    }


# IdentityProviderTypeTypeDef definition

class IdentityProviderTypeTypeDef(TypedDict):
    UserPoolId: NotRequired[str],
    ProviderName: NotRequired[str],
    ProviderType: NotRequired[IdentityProviderTypeTypeType],  # (1)
    ProviderDetails: NotRequired[Dict[str, str]],
    AttributeMapping: NotRequired[Dict[str, str]],
    IdpIdentifiers: NotRequired[List[str]],
    LastModifiedDate: NotRequired[datetime.datetime],
    CreationDate: NotRequired[datetime.datetime],

1. See IdentityProviderTypeTypeType

ResourceServerScopeTypeTypeDef

# ResourceServerScopeTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ResourceServerScopeTypeTypeDef


def get_value() -> ResourceServerScopeTypeTypeDef:
    return {
        "ScopeName": ...,
    }


# ResourceServerScopeTypeTypeDef definition

class ResourceServerScopeTypeTypeDef(TypedDict):
    ScopeName: str,
    ScopeDescription: str,

CreateUserImportJobRequestTypeDef

# CreateUserImportJobRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserImportJobRequestTypeDef


def get_value() -> CreateUserImportJobRequestTypeDef:
    return {
        "JobName": ...,
    }


# CreateUserImportJobRequestTypeDef definition

class CreateUserImportJobRequestTypeDef(TypedDict):
    JobName: str,
    UserPoolId: str,
    CloudWatchLogsRoleArn: str,

UserImportJobTypeTypeDef

# UserImportJobTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserImportJobTypeTypeDef


def get_value() -> UserImportJobTypeTypeDef:
    return {
        "JobName": ...,
    }


# UserImportJobTypeTypeDef definition

class UserImportJobTypeTypeDef(TypedDict):
    JobName: NotRequired[str],
    JobId: NotRequired[str],
    UserPoolId: NotRequired[str],
    PreSignedUrl: NotRequired[str],
    CreationDate: NotRequired[datetime.datetime],
    StartDate: NotRequired[datetime.datetime],
    CompletionDate: NotRequired[datetime.datetime],
    Status: NotRequired[UserImportJobStatusTypeType],  # (1)
    CloudWatchLogsRoleArn: NotRequired[str],
    ImportedUsers: NotRequired[int],
    SkippedUsers: NotRequired[int],
    FailedUsers: NotRequired[int],
    CompletionMessage: NotRequired[str],

1. See UserImportJobStatusTypeType

RefreshTokenRotationTypeTypeDef

# RefreshTokenRotationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import RefreshTokenRotationTypeTypeDef


def get_value() -> RefreshTokenRotationTypeTypeDef:
    return {
        "Feature": ...,
    }


# RefreshTokenRotationTypeTypeDef definition

class RefreshTokenRotationTypeTypeDef(TypedDict):
    Feature: FeatureTypeType,  # (1)
    RetryGracePeriodSeconds: NotRequired[int],

1. See FeatureTypeType

TokenValidityUnitsTypeTypeDef

# TokenValidityUnitsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import TokenValidityUnitsTypeTypeDef


def get_value() -> TokenValidityUnitsTypeTypeDef:
    return {
        "AccessToken": ...,
    }


# TokenValidityUnitsTypeTypeDef 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

# CustomDomainConfigTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CustomDomainConfigTypeTypeDef


def get_value() -> CustomDomainConfigTypeTypeDef:
    return {
        "CertificateArn": ...,
    }


# CustomDomainConfigTypeTypeDef definition

class CustomDomainConfigTypeTypeDef(TypedDict):
    CertificateArn: str,

DeviceConfigurationTypeTypeDef

# DeviceConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeviceConfigurationTypeTypeDef


def get_value() -> DeviceConfigurationTypeTypeDef:
    return {
        "ChallengeRequiredOnNewDevice": ...,
    }


# DeviceConfigurationTypeTypeDef definition

class DeviceConfigurationTypeTypeDef(TypedDict):
    ChallengeRequiredOnNewDevice: NotRequired[bool],
    DeviceOnlyRememberedOnUserPrompt: NotRequired[bool],

EmailConfigurationTypeTypeDef

# EmailConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import EmailConfigurationTypeTypeDef


def get_value() -> EmailConfigurationTypeTypeDef:
    return {
        "SourceArn": ...,
    }


# EmailConfigurationTypeTypeDef definition

class EmailConfigurationTypeTypeDef(TypedDict):
    SourceArn: NotRequired[str],
    ReplyToEmailAddress: NotRequired[str],
    EmailSendingAccount: NotRequired[EmailSendingAccountTypeType],  # (1)
    From: NotRequired[str],
    ConfigurationSet: NotRequired[str],

1. See EmailSendingAccountTypeType

SmsConfigurationTypeTypeDef

# SmsConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SmsConfigurationTypeTypeDef


def get_value() -> SmsConfigurationTypeTypeDef:
    return {
        "SnsCallerArn": ...,
    }


# SmsConfigurationTypeTypeDef definition

class SmsConfigurationTypeTypeDef(TypedDict):
    SnsCallerArn: str,
    ExternalId: NotRequired[str],
    SnsRegion: NotRequired[str],

UsernameConfigurationTypeTypeDef

# UsernameConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UsernameConfigurationTypeTypeDef


def get_value() -> UsernameConfigurationTypeTypeDef:
    return {
        "CaseSensitive": ...,
    }


# UsernameConfigurationTypeTypeDef definition

class UsernameConfigurationTypeTypeDef(TypedDict):
    CaseSensitive: bool,

VerificationMessageTemplateTypeTypeDef

# VerificationMessageTemplateTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import VerificationMessageTemplateTypeTypeDef


def get_value() -> VerificationMessageTemplateTypeTypeDef:
    return {
        "SmsMessage": ...,
    }


# VerificationMessageTemplateTypeTypeDef 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

# CustomEmailLambdaVersionConfigTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CustomEmailLambdaVersionConfigTypeTypeDef


def get_value() -> CustomEmailLambdaVersionConfigTypeTypeDef:
    return {
        "LambdaVersion": ...,
    }


# CustomEmailLambdaVersionConfigTypeTypeDef definition

class CustomEmailLambdaVersionConfigTypeTypeDef(TypedDict):
    LambdaVersion: CustomEmailSenderLambdaVersionTypeType,  # (1)
    LambdaArn: str,

1. See CustomEmailSenderLambdaVersionTypeType

CustomSMSLambdaVersionConfigTypeTypeDef

# CustomSMSLambdaVersionConfigTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CustomSMSLambdaVersionConfigTypeTypeDef


def get_value() -> CustomSMSLambdaVersionConfigTypeTypeDef:
    return {
        "LambdaVersion": ...,
    }


# CustomSMSLambdaVersionConfigTypeTypeDef definition

class CustomSMSLambdaVersionConfigTypeTypeDef(TypedDict):
    LambdaVersion: CustomSMSSenderLambdaVersionTypeType,  # (1)
    LambdaArn: str,

1. See CustomSMSSenderLambdaVersionTypeType

DeleteGroupRequestTypeDef

# DeleteGroupRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeleteGroupRequestTypeDef


def get_value() -> DeleteGroupRequestTypeDef:
    return {
        "GroupName": ...,
    }


# DeleteGroupRequestTypeDef definition

class DeleteGroupRequestTypeDef(TypedDict):
    GroupName: str,
    UserPoolId: str,

DeleteIdentityProviderRequestTypeDef

# DeleteIdentityProviderRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeleteIdentityProviderRequestTypeDef


def get_value() -> DeleteIdentityProviderRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DeleteIdentityProviderRequestTypeDef definition

class DeleteIdentityProviderRequestTypeDef(TypedDict):
    UserPoolId: str,
    ProviderName: str,

DeleteManagedLoginBrandingRequestTypeDef

# DeleteManagedLoginBrandingRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeleteManagedLoginBrandingRequestTypeDef


def get_value() -> DeleteManagedLoginBrandingRequestTypeDef:
    return {
        "ManagedLoginBrandingId": ...,
    }


# DeleteManagedLoginBrandingRequestTypeDef definition

class DeleteManagedLoginBrandingRequestTypeDef(TypedDict):
    ManagedLoginBrandingId: str,
    UserPoolId: str,

DeleteResourceServerRequestTypeDef

# DeleteResourceServerRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeleteResourceServerRequestTypeDef


def get_value() -> DeleteResourceServerRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DeleteResourceServerRequestTypeDef definition

class DeleteResourceServerRequestTypeDef(TypedDict):
    UserPoolId: str,
    Identifier: str,

DeleteUserAttributesRequestTypeDef

# DeleteUserAttributesRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeleteUserAttributesRequestTypeDef


def get_value() -> DeleteUserAttributesRequestTypeDef:
    return {
        "UserAttributeNames": ...,
    }


# DeleteUserAttributesRequestTypeDef definition

class DeleteUserAttributesRequestTypeDef(TypedDict):
    UserAttributeNames: Sequence[str],
    AccessToken: str,

DeleteUserPoolClientRequestTypeDef

# DeleteUserPoolClientRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeleteUserPoolClientRequestTypeDef


def get_value() -> DeleteUserPoolClientRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DeleteUserPoolClientRequestTypeDef definition

class DeleteUserPoolClientRequestTypeDef(TypedDict):
    UserPoolId: str,
    ClientId: str,

DeleteUserPoolDomainRequestTypeDef

# DeleteUserPoolDomainRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeleteUserPoolDomainRequestTypeDef


def get_value() -> DeleteUserPoolDomainRequestTypeDef:
    return {
        "Domain": ...,
    }


# DeleteUserPoolDomainRequestTypeDef definition

class DeleteUserPoolDomainRequestTypeDef(TypedDict):
    Domain: str,
    UserPoolId: str,

DeleteUserPoolRequestTypeDef

# DeleteUserPoolRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeleteUserPoolRequestTypeDef


def get_value() -> DeleteUserPoolRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DeleteUserPoolRequestTypeDef definition

class DeleteUserPoolRequestTypeDef(TypedDict):
    UserPoolId: str,

DeleteUserRequestTypeDef

# DeleteUserRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeleteUserRequestTypeDef


def get_value() -> DeleteUserRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# DeleteUserRequestTypeDef definition

class DeleteUserRequestTypeDef(TypedDict):
    AccessToken: str,

DeleteWebAuthnCredentialRequestTypeDef

# DeleteWebAuthnCredentialRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeleteWebAuthnCredentialRequestTypeDef


def get_value() -> DeleteWebAuthnCredentialRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# DeleteWebAuthnCredentialRequestTypeDef definition

class DeleteWebAuthnCredentialRequestTypeDef(TypedDict):
    AccessToken: str,
    CredentialId: str,

DescribeIdentityProviderRequestTypeDef

# DescribeIdentityProviderRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeIdentityProviderRequestTypeDef


def get_value() -> DescribeIdentityProviderRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DescribeIdentityProviderRequestTypeDef definition

class DescribeIdentityProviderRequestTypeDef(TypedDict):
    UserPoolId: str,
    ProviderName: str,

DescribeManagedLoginBrandingByClientRequestTypeDef

# DescribeManagedLoginBrandingByClientRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeManagedLoginBrandingByClientRequestTypeDef


def get_value() -> DescribeManagedLoginBrandingByClientRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DescribeManagedLoginBrandingByClientRequestTypeDef definition

class DescribeManagedLoginBrandingByClientRequestTypeDef(TypedDict):
    UserPoolId: str,
    ClientId: str,
    ReturnMergedResources: NotRequired[bool],

DescribeManagedLoginBrandingRequestTypeDef

# DescribeManagedLoginBrandingRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeManagedLoginBrandingRequestTypeDef


def get_value() -> DescribeManagedLoginBrandingRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DescribeManagedLoginBrandingRequestTypeDef definition

class DescribeManagedLoginBrandingRequestTypeDef(TypedDict):
    UserPoolId: str,
    ManagedLoginBrandingId: str,
    ReturnMergedResources: NotRequired[bool],

DescribeResourceServerRequestTypeDef

# DescribeResourceServerRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeResourceServerRequestTypeDef


def get_value() -> DescribeResourceServerRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DescribeResourceServerRequestTypeDef definition

class DescribeResourceServerRequestTypeDef(TypedDict):
    UserPoolId: str,
    Identifier: str,

DescribeRiskConfigurationRequestTypeDef

# DescribeRiskConfigurationRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeRiskConfigurationRequestTypeDef


def get_value() -> DescribeRiskConfigurationRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DescribeRiskConfigurationRequestTypeDef definition

class DescribeRiskConfigurationRequestTypeDef(TypedDict):
    UserPoolId: str,
    ClientId: NotRequired[str],

DescribeUserImportJobRequestTypeDef

# DescribeUserImportJobRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserImportJobRequestTypeDef


def get_value() -> DescribeUserImportJobRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DescribeUserImportJobRequestTypeDef definition

class DescribeUserImportJobRequestTypeDef(TypedDict):
    UserPoolId: str,
    JobId: str,

DescribeUserPoolClientRequestTypeDef

# DescribeUserPoolClientRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserPoolClientRequestTypeDef


def get_value() -> DescribeUserPoolClientRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DescribeUserPoolClientRequestTypeDef definition

class DescribeUserPoolClientRequestTypeDef(TypedDict):
    UserPoolId: str,
    ClientId: str,

DescribeUserPoolDomainRequestTypeDef

# DescribeUserPoolDomainRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserPoolDomainRequestTypeDef


def get_value() -> DescribeUserPoolDomainRequestTypeDef:
    return {
        "Domain": ...,
    }


# DescribeUserPoolDomainRequestTypeDef definition

class DescribeUserPoolDomainRequestTypeDef(TypedDict):
    Domain: str,

DescribeUserPoolRequestTypeDef

# DescribeUserPoolRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserPoolRequestTypeDef


def get_value() -> DescribeUserPoolRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# DescribeUserPoolRequestTypeDef definition

class DescribeUserPoolRequestTypeDef(TypedDict):
    UserPoolId: str,

EmailMfaConfigTypeTypeDef

# EmailMfaConfigTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import EmailMfaConfigTypeTypeDef


def get_value() -> EmailMfaConfigTypeTypeDef:
    return {
        "Message": ...,
    }


# EmailMfaConfigTypeTypeDef definition

class EmailMfaConfigTypeTypeDef(TypedDict):
    Message: NotRequired[str],
    Subject: NotRequired[str],

FirehoseConfigurationTypeTypeDef

# FirehoseConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import FirehoseConfigurationTypeTypeDef


def get_value() -> FirehoseConfigurationTypeTypeDef:
    return {
        "StreamArn": ...,
    }


# FirehoseConfigurationTypeTypeDef definition

class FirehoseConfigurationTypeTypeDef(TypedDict):
    StreamArn: NotRequired[str],

ForgetDeviceRequestTypeDef

# ForgetDeviceRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ForgetDeviceRequestTypeDef


def get_value() -> ForgetDeviceRequestTypeDef:
    return {
        "DeviceKey": ...,
    }


# ForgetDeviceRequestTypeDef definition

class ForgetDeviceRequestTypeDef(TypedDict):
    DeviceKey: str,
    AccessToken: NotRequired[str],

GetCSVHeaderRequestTypeDef

# GetCSVHeaderRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetCSVHeaderRequestTypeDef


def get_value() -> GetCSVHeaderRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# GetCSVHeaderRequestTypeDef definition

class GetCSVHeaderRequestTypeDef(TypedDict):
    UserPoolId: str,

GetDeviceRequestTypeDef

# GetDeviceRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetDeviceRequestTypeDef


def get_value() -> GetDeviceRequestTypeDef:
    return {
        "DeviceKey": ...,
    }


# GetDeviceRequestTypeDef definition

class GetDeviceRequestTypeDef(TypedDict):
    DeviceKey: str,
    AccessToken: NotRequired[str],

GetGroupRequestTypeDef

# GetGroupRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetGroupRequestTypeDef


def get_value() -> GetGroupRequestTypeDef:
    return {
        "GroupName": ...,
    }


# GetGroupRequestTypeDef definition

class GetGroupRequestTypeDef(TypedDict):
    GroupName: str,
    UserPoolId: str,

GetIdentityProviderByIdentifierRequestTypeDef

# GetIdentityProviderByIdentifierRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetIdentityProviderByIdentifierRequestTypeDef


def get_value() -> GetIdentityProviderByIdentifierRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# GetIdentityProviderByIdentifierRequestTypeDef definition

class GetIdentityProviderByIdentifierRequestTypeDef(TypedDict):
    UserPoolId: str,
    IdpIdentifier: str,

GetLogDeliveryConfigurationRequestTypeDef

# GetLogDeliveryConfigurationRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetLogDeliveryConfigurationRequestTypeDef


def get_value() -> GetLogDeliveryConfigurationRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# GetLogDeliveryConfigurationRequestTypeDef definition

class GetLogDeliveryConfigurationRequestTypeDef(TypedDict):
    UserPoolId: str,

GetSigningCertificateRequestTypeDef

# GetSigningCertificateRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetSigningCertificateRequestTypeDef


def get_value() -> GetSigningCertificateRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# GetSigningCertificateRequestTypeDef definition

class GetSigningCertificateRequestTypeDef(TypedDict):
    UserPoolId: str,

GetTokensFromRefreshTokenRequestTypeDef

# GetTokensFromRefreshTokenRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetTokensFromRefreshTokenRequestTypeDef


def get_value() -> GetTokensFromRefreshTokenRequestTypeDef:
    return {
        "RefreshToken": ...,
    }


# GetTokensFromRefreshTokenRequestTypeDef definition

class GetTokensFromRefreshTokenRequestTypeDef(TypedDict):
    RefreshToken: str,
    ClientId: str,
    ClientSecret: NotRequired[str],
    DeviceKey: NotRequired[str],
    ClientMetadata: NotRequired[Mapping[str, str]],

GetUICustomizationRequestTypeDef

# GetUICustomizationRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetUICustomizationRequestTypeDef


def get_value() -> GetUICustomizationRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# GetUICustomizationRequestTypeDef definition

class GetUICustomizationRequestTypeDef(TypedDict):
    UserPoolId: str,
    ClientId: NotRequired[str],

UICustomizationTypeTypeDef

# UICustomizationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UICustomizationTypeTypeDef


def get_value() -> UICustomizationTypeTypeDef:
    return {
        "UserPoolId": ...,
    }


# UICustomizationTypeTypeDef definition

class UICustomizationTypeTypeDef(TypedDict):
    UserPoolId: NotRequired[str],
    ClientId: NotRequired[str],
    ImageUrl: NotRequired[str],
    CSS: NotRequired[str],
    CSSVersion: NotRequired[str],
    LastModifiedDate: NotRequired[datetime.datetime],
    CreationDate: NotRequired[datetime.datetime],

GetUserAttributeVerificationCodeRequestTypeDef

# GetUserAttributeVerificationCodeRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetUserAttributeVerificationCodeRequestTypeDef


def get_value() -> GetUserAttributeVerificationCodeRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# GetUserAttributeVerificationCodeRequestTypeDef definition

class GetUserAttributeVerificationCodeRequestTypeDef(TypedDict):
    AccessToken: str,
    AttributeName: str,
    ClientMetadata: NotRequired[Mapping[str, str]],

GetUserAuthFactorsRequestTypeDef

# GetUserAuthFactorsRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetUserAuthFactorsRequestTypeDef


def get_value() -> GetUserAuthFactorsRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# GetUserAuthFactorsRequestTypeDef definition

class GetUserAuthFactorsRequestTypeDef(TypedDict):
    AccessToken: str,

GetUserPoolMfaConfigRequestTypeDef

# GetUserPoolMfaConfigRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetUserPoolMfaConfigRequestTypeDef


def get_value() -> GetUserPoolMfaConfigRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# GetUserPoolMfaConfigRequestTypeDef definition

class GetUserPoolMfaConfigRequestTypeDef(TypedDict):
    UserPoolId: str,

SoftwareTokenMfaConfigTypeTypeDef

# SoftwareTokenMfaConfigTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SoftwareTokenMfaConfigTypeTypeDef


def get_value() -> SoftwareTokenMfaConfigTypeTypeDef:
    return {
        "Enabled": ...,
    }


# SoftwareTokenMfaConfigTypeTypeDef definition

class SoftwareTokenMfaConfigTypeTypeDef(TypedDict):
    Enabled: NotRequired[bool],

WebAuthnConfigurationTypeTypeDef

# WebAuthnConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import WebAuthnConfigurationTypeTypeDef


def get_value() -> WebAuthnConfigurationTypeTypeDef:
    return {
        "RelyingPartyId": ...,
    }


# WebAuthnConfigurationTypeTypeDef definition

class WebAuthnConfigurationTypeTypeDef(TypedDict):
    RelyingPartyId: NotRequired[str],
    UserVerification: NotRequired[UserVerificationTypeType],  # (1)

1. See UserVerificationTypeType

GetUserRequestTypeDef

# GetUserRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetUserRequestTypeDef


def get_value() -> GetUserRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# GetUserRequestTypeDef definition

class GetUserRequestTypeDef(TypedDict):
    AccessToken: str,

GlobalSignOutRequestTypeDef

# GlobalSignOutRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GlobalSignOutRequestTypeDef


def get_value() -> GlobalSignOutRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# GlobalSignOutRequestTypeDef definition

class GlobalSignOutRequestTypeDef(TypedDict):
    AccessToken: str,

PreTokenGenerationVersionConfigTypeTypeDef

# PreTokenGenerationVersionConfigTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import PreTokenGenerationVersionConfigTypeTypeDef


def get_value() -> PreTokenGenerationVersionConfigTypeTypeDef:
    return {
        "LambdaVersion": ...,
    }


# PreTokenGenerationVersionConfigTypeTypeDef definition

class PreTokenGenerationVersionConfigTypeTypeDef(TypedDict):
    LambdaVersion: PreTokenGenerationLambdaVersionTypeType,  # (1)
    LambdaArn: str,

1. See PreTokenGenerationLambdaVersionTypeType

ListDevicesRequestTypeDef

# ListDevicesRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListDevicesRequestTypeDef


def get_value() -> ListDevicesRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# ListDevicesRequestTypeDef definition

class ListDevicesRequestTypeDef(TypedDict):
    AccessToken: str,
    Limit: NotRequired[int],
    PaginationToken: NotRequired[str],

ListGroupsRequestTypeDef

# ListGroupsRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListGroupsRequestTypeDef


def get_value() -> ListGroupsRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListGroupsRequestTypeDef definition

class ListGroupsRequestTypeDef(TypedDict):
    UserPoolId: str,
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

ListIdentityProvidersRequestTypeDef

# ListIdentityProvidersRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListIdentityProvidersRequestTypeDef


def get_value() -> ListIdentityProvidersRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListIdentityProvidersRequestTypeDef definition

class ListIdentityProvidersRequestTypeDef(TypedDict):
    UserPoolId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ProviderDescriptionTypeDef

# ProviderDescriptionTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ProviderDescriptionTypeDef


def get_value() -> ProviderDescriptionTypeDef:
    return {
        "ProviderName": ...,
    }


# ProviderDescriptionTypeDef definition

class ProviderDescriptionTypeDef(TypedDict):
    ProviderName: NotRequired[str],
    ProviderType: NotRequired[IdentityProviderTypeTypeType],  # (1)
    LastModifiedDate: NotRequired[datetime.datetime],
    CreationDate: NotRequired[datetime.datetime],

1. See IdentityProviderTypeTypeType

ListResourceServersRequestTypeDef

# ListResourceServersRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListResourceServersRequestTypeDef


def get_value() -> ListResourceServersRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListResourceServersRequestTypeDef definition

class ListResourceServersRequestTypeDef(TypedDict):
    UserPoolId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestTypeDef

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    ResourceArn: str,

ListUserImportJobsRequestTypeDef

# ListUserImportJobsRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUserImportJobsRequestTypeDef


def get_value() -> ListUserImportJobsRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListUserImportJobsRequestTypeDef definition

class ListUserImportJobsRequestTypeDef(TypedDict):
    UserPoolId: str,
    MaxResults: int,
    PaginationToken: NotRequired[str],

ListUserPoolClientsRequestTypeDef

# ListUserPoolClientsRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUserPoolClientsRequestTypeDef


def get_value() -> ListUserPoolClientsRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListUserPoolClientsRequestTypeDef definition

class ListUserPoolClientsRequestTypeDef(TypedDict):
    UserPoolId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

UserPoolClientDescriptionTypeDef

# UserPoolClientDescriptionTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserPoolClientDescriptionTypeDef


def get_value() -> UserPoolClientDescriptionTypeDef:
    return {
        "ClientId": ...,
    }


# UserPoolClientDescriptionTypeDef definition

class UserPoolClientDescriptionTypeDef(TypedDict):
    ClientId: NotRequired[str],
    UserPoolId: NotRequired[str],
    ClientName: NotRequired[str],

ListUserPoolsRequestTypeDef

# ListUserPoolsRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUserPoolsRequestTypeDef


def get_value() -> ListUserPoolsRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListUserPoolsRequestTypeDef definition

class ListUserPoolsRequestTypeDef(TypedDict):
    MaxResults: int,
    NextToken: NotRequired[str],

ListUsersInGroupRequestTypeDef

# ListUsersInGroupRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersInGroupRequestTypeDef


def get_value() -> ListUsersInGroupRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListUsersInGroupRequestTypeDef definition

class ListUsersInGroupRequestTypeDef(TypedDict):
    UserPoolId: str,
    GroupName: str,
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

ListUsersRequestTypeDef

# ListUsersRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersRequestTypeDef


def get_value() -> ListUsersRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListUsersRequestTypeDef definition

class ListUsersRequestTypeDef(TypedDict):
    UserPoolId: str,
    AttributesToGet: NotRequired[Sequence[str]],
    Limit: NotRequired[int],
    PaginationToken: NotRequired[str],
    Filter: NotRequired[str],

ListWebAuthnCredentialsRequestTypeDef

# ListWebAuthnCredentialsRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListWebAuthnCredentialsRequestTypeDef


def get_value() -> ListWebAuthnCredentialsRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# ListWebAuthnCredentialsRequestTypeDef definition

class ListWebAuthnCredentialsRequestTypeDef(TypedDict):
    AccessToken: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

WebAuthnCredentialDescriptionTypeDef

# WebAuthnCredentialDescriptionTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import WebAuthnCredentialDescriptionTypeDef


def get_value() -> WebAuthnCredentialDescriptionTypeDef:
    return {
        "CredentialId": ...,
    }


# WebAuthnCredentialDescriptionTypeDef definition

class WebAuthnCredentialDescriptionTypeDef(TypedDict):
    CredentialId: str,
    FriendlyCredentialName: str,
    RelyingPartyId: str,
    AuthenticatorTransports: List[str],
    CreatedAt: datetime.datetime,
    AuthenticatorAttachment: NotRequired[str],

S3ConfigurationTypeTypeDef

# S3ConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import S3ConfigurationTypeTypeDef


def get_value() -> S3ConfigurationTypeTypeDef:
    return {
        "BucketArn": ...,
    }


# S3ConfigurationTypeTypeDef definition

class S3ConfigurationTypeTypeDef(TypedDict):
    BucketArn: NotRequired[str],

NotifyEmailTypeTypeDef

# NotifyEmailTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import NotifyEmailTypeTypeDef


def get_value() -> NotifyEmailTypeTypeDef:
    return {
        "Subject": ...,
    }


# NotifyEmailTypeTypeDef definition

class NotifyEmailTypeTypeDef(TypedDict):
    Subject: str,
    HtmlBody: NotRequired[str],
    TextBody: NotRequired[str],

NumberAttributeConstraintsTypeTypeDef

# NumberAttributeConstraintsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import NumberAttributeConstraintsTypeTypeDef


def get_value() -> NumberAttributeConstraintsTypeTypeDef:
    return {
        "MinValue": ...,
    }


# NumberAttributeConstraintsTypeTypeDef definition

class NumberAttributeConstraintsTypeTypeDef(TypedDict):
    MinValue: NotRequired[str],
    MaxValue: NotRequired[str],

PasswordPolicyTypeTypeDef

# PasswordPolicyTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import PasswordPolicyTypeTypeDef


def get_value() -> PasswordPolicyTypeTypeDef:
    return {
        "MinimumLength": ...,
    }


# PasswordPolicyTypeTypeDef definition

class PasswordPolicyTypeTypeDef(TypedDict):
    MinimumLength: NotRequired[int],
    RequireUppercase: NotRequired[bool],
    RequireLowercase: NotRequired[bool],
    RequireNumbers: NotRequired[bool],
    RequireSymbols: NotRequired[bool],
    PasswordHistorySize: NotRequired[int],
    TemporaryPasswordValidityDays: NotRequired[int],

RevokeTokenRequestTypeDef

# RevokeTokenRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import RevokeTokenRequestTypeDef


def get_value() -> RevokeTokenRequestTypeDef:
    return {
        "Token": ...,
    }


# RevokeTokenRequestTypeDef definition

class RevokeTokenRequestTypeDef(TypedDict):
    Token: str,
    ClientId: str,
    ClientSecret: NotRequired[str],

RiskExceptionConfigurationTypeOutputTypeDef

# RiskExceptionConfigurationTypeOutputTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import RiskExceptionConfigurationTypeOutputTypeDef


def get_value() -> RiskExceptionConfigurationTypeOutputTypeDef:
    return {
        "BlockedIPRangeList": ...,
    }


# RiskExceptionConfigurationTypeOutputTypeDef definition

class RiskExceptionConfigurationTypeOutputTypeDef(TypedDict):
    BlockedIPRangeList: NotRequired[List[str]],
    SkippedIPRangeList: NotRequired[List[str]],

RiskExceptionConfigurationTypeTypeDef

# RiskExceptionConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import RiskExceptionConfigurationTypeTypeDef


def get_value() -> RiskExceptionConfigurationTypeTypeDef:
    return {
        "BlockedIPRangeList": ...,
    }


# RiskExceptionConfigurationTypeTypeDef definition

class RiskExceptionConfigurationTypeTypeDef(TypedDict):
    BlockedIPRangeList: NotRequired[Sequence[str]],
    SkippedIPRangeList: NotRequired[Sequence[str]],

StringAttributeConstraintsTypeTypeDef

# StringAttributeConstraintsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import StringAttributeConstraintsTypeTypeDef


def get_value() -> StringAttributeConstraintsTypeTypeDef:
    return {
        "MinLength": ...,
    }


# StringAttributeConstraintsTypeTypeDef definition

class StringAttributeConstraintsTypeTypeDef(TypedDict):
    MinLength: NotRequired[str],
    MaxLength: NotRequired[str],

SignInPolicyTypeOutputTypeDef

# SignInPolicyTypeOutputTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SignInPolicyTypeOutputTypeDef


def get_value() -> SignInPolicyTypeOutputTypeDef:
    return {
        "AllowedFirstAuthFactors": ...,
    }


# SignInPolicyTypeOutputTypeDef definition

class SignInPolicyTypeOutputTypeDef(TypedDict):
    AllowedFirstAuthFactors: NotRequired[List[AuthFactorTypeType]],  # (1)

1. See List[AuthFactorTypeType]

SignInPolicyTypeTypeDef

# SignInPolicyTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SignInPolicyTypeTypeDef


def get_value() -> SignInPolicyTypeTypeDef:
    return {
        "AllowedFirstAuthFactors": ...,
    }


# SignInPolicyTypeTypeDef definition

class SignInPolicyTypeTypeDef(TypedDict):
    AllowedFirstAuthFactors: NotRequired[Sequence[AuthFactorTypeType]],  # (1)

1. See Sequence[AuthFactorTypeType]

StartUserImportJobRequestTypeDef

# StartUserImportJobRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import StartUserImportJobRequestTypeDef


def get_value() -> StartUserImportJobRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# StartUserImportJobRequestTypeDef definition

class StartUserImportJobRequestTypeDef(TypedDict):
    UserPoolId: str,
    JobId: str,

StartWebAuthnRegistrationRequestTypeDef

# StartWebAuthnRegistrationRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import StartWebAuthnRegistrationRequestTypeDef


def get_value() -> StartWebAuthnRegistrationRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# StartWebAuthnRegistrationRequestTypeDef definition

class StartWebAuthnRegistrationRequestTypeDef(TypedDict):
    AccessToken: str,

StopUserImportJobRequestTypeDef

# StopUserImportJobRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import StopUserImportJobRequestTypeDef


def get_value() -> StopUserImportJobRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# StopUserImportJobRequestTypeDef definition

class StopUserImportJobRequestTypeDef(TypedDict):
    UserPoolId: str,
    JobId: str,

TagResourceRequestTypeDef

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestTypeDef

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateAuthEventFeedbackRequestTypeDef

# UpdateAuthEventFeedbackRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateAuthEventFeedbackRequestTypeDef


def get_value() -> UpdateAuthEventFeedbackRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# UpdateAuthEventFeedbackRequestTypeDef definition

class UpdateAuthEventFeedbackRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    EventId: str,
    FeedbackToken: str,
    FeedbackValue: FeedbackValueTypeType,  # (1)

1. See FeedbackValueTypeType

UpdateDeviceStatusRequestTypeDef

# UpdateDeviceStatusRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateDeviceStatusRequestTypeDef


def get_value() -> UpdateDeviceStatusRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# UpdateDeviceStatusRequestTypeDef definition

class UpdateDeviceStatusRequestTypeDef(TypedDict):
    AccessToken: str,
    DeviceKey: str,
    DeviceRememberedStatus: NotRequired[DeviceRememberedStatusTypeType],  # (1)

1. See DeviceRememberedStatusTypeType

UpdateGroupRequestTypeDef

# UpdateGroupRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateGroupRequestTypeDef


def get_value() -> UpdateGroupRequestTypeDef:
    return {
        "GroupName": ...,
    }


# UpdateGroupRequestTypeDef definition

class UpdateGroupRequestTypeDef(TypedDict):
    GroupName: str,
    UserPoolId: str,
    Description: NotRequired[str],
    RoleArn: NotRequired[str],
    Precedence: NotRequired[int],

UpdateIdentityProviderRequestTypeDef

# UpdateIdentityProviderRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateIdentityProviderRequestTypeDef


def get_value() -> UpdateIdentityProviderRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# UpdateIdentityProviderRequestTypeDef definition

class UpdateIdentityProviderRequestTypeDef(TypedDict):
    UserPoolId: str,
    ProviderName: str,
    ProviderDetails: NotRequired[Mapping[str, str]],
    AttributeMapping: NotRequired[Mapping[str, str]],
    IdpIdentifiers: NotRequired[Sequence[str]],

UserAttributeUpdateSettingsTypeOutputTypeDef

# UserAttributeUpdateSettingsTypeOutputTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserAttributeUpdateSettingsTypeOutputTypeDef


def get_value() -> UserAttributeUpdateSettingsTypeOutputTypeDef:
    return {
        "AttributesRequireVerificationBeforeUpdate": ...,
    }


# UserAttributeUpdateSettingsTypeOutputTypeDef definition

class UserAttributeUpdateSettingsTypeOutputTypeDef(TypedDict):
    AttributesRequireVerificationBeforeUpdate: NotRequired[List[VerifiedAttributeTypeType]],  # (1)

1. See List[VerifiedAttributeTypeType]

UserAttributeUpdateSettingsTypeTypeDef

# UserAttributeUpdateSettingsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserAttributeUpdateSettingsTypeTypeDef


def get_value() -> UserAttributeUpdateSettingsTypeTypeDef:
    return {
        "AttributesRequireVerificationBeforeUpdate": ...,
    }


# UserAttributeUpdateSettingsTypeTypeDef definition

class UserAttributeUpdateSettingsTypeTypeDef(TypedDict):
    AttributesRequireVerificationBeforeUpdate: NotRequired[Sequence[VerifiedAttributeTypeType]],  # (1)

1. See Sequence[VerifiedAttributeTypeType]

VerifySoftwareTokenRequestTypeDef

# VerifySoftwareTokenRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import VerifySoftwareTokenRequestTypeDef


def get_value() -> VerifySoftwareTokenRequestTypeDef:
    return {
        "UserCode": ...,
    }


# VerifySoftwareTokenRequestTypeDef definition

class VerifySoftwareTokenRequestTypeDef(TypedDict):
    UserCode: str,
    AccessToken: NotRequired[str],
    Session: NotRequired[str],
    FriendlyDeviceName: NotRequired[str],

VerifyUserAttributeRequestTypeDef

# VerifyUserAttributeRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import VerifyUserAttributeRequestTypeDef


def get_value() -> VerifyUserAttributeRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# VerifyUserAttributeRequestTypeDef definition

class VerifyUserAttributeRequestTypeDef(TypedDict):
    AccessToken: str,
    AttributeName: str,
    Code: str,

AccountRecoverySettingTypeOutputTypeDef

# AccountRecoverySettingTypeOutputTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AccountRecoverySettingTypeOutputTypeDef


def get_value() -> AccountRecoverySettingTypeOutputTypeDef:
    return {
        "RecoveryMechanisms": ...,
    }


# AccountRecoverySettingTypeOutputTypeDef definition

class AccountRecoverySettingTypeOutputTypeDef(TypedDict):
    RecoveryMechanisms: NotRequired[List[RecoveryOptionTypeTypeDef]],  # (1)

1. See List[RecoveryOptionTypeTypeDef]

AccountRecoverySettingTypeTypeDef

# AccountRecoverySettingTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AccountRecoverySettingTypeTypeDef


def get_value() -> AccountRecoverySettingTypeTypeDef:
    return {
        "RecoveryMechanisms": ...,
    }


# AccountRecoverySettingTypeTypeDef definition

class AccountRecoverySettingTypeTypeDef(TypedDict):
    RecoveryMechanisms: NotRequired[Sequence[RecoveryOptionTypeTypeDef]],  # (1)

1. See Sequence[RecoveryOptionTypeTypeDef]

AccountTakeoverActionsTypeTypeDef

# AccountTakeoverActionsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AccountTakeoverActionsTypeTypeDef


def get_value() -> AccountTakeoverActionsTypeTypeDef:
    return {
        "LowAction": ...,
    }


# AccountTakeoverActionsTypeTypeDef 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

# AdminCreateUserConfigTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminCreateUserConfigTypeTypeDef


def get_value() -> AdminCreateUserConfigTypeTypeDef:
    return {
        "AllowAdminCreateUserOnly": ...,
    }


# AdminCreateUserConfigTypeTypeDef definition

class AdminCreateUserConfigTypeTypeDef(TypedDict):
    AllowAdminCreateUserOnly: NotRequired[bool],
    UnusedAccountValidityDays: NotRequired[int],
    InviteMessageTemplate: NotRequired[MessageTemplateTypeTypeDef],  # (1)

1. See MessageTemplateTypeTypeDef

AdminCreateUserRequestTypeDef

# AdminCreateUserRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminCreateUserRequestTypeDef


def get_value() -> AdminCreateUserRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminCreateUserRequestTypeDef definition

class AdminCreateUserRequestTypeDef(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 Sequence[AttributeTypeTypeDef]
2. See Sequence[AttributeTypeTypeDef]
3. See MessageActionTypeType
4. See Sequence[DeliveryMediumTypeType]

AdminUpdateUserAttributesRequestTypeDef

# AdminUpdateUserAttributesRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminUpdateUserAttributesRequestTypeDef


def get_value() -> AdminUpdateUserAttributesRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminUpdateUserAttributesRequestTypeDef definition

class AdminUpdateUserAttributesRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    UserAttributes: Sequence[AttributeTypeTypeDef],  # (1)
    ClientMetadata: NotRequired[Mapping[str, str]],

1. See Sequence[AttributeTypeTypeDef]

DeviceTypeTypeDef

# DeviceTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DeviceTypeTypeDef


def get_value() -> DeviceTypeTypeDef:
    return {
        "DeviceKey": ...,
    }


# DeviceTypeTypeDef definition

class DeviceTypeTypeDef(TypedDict):
    DeviceKey: NotRequired[str],
    DeviceAttributes: NotRequired[List[AttributeTypeTypeDef]],  # (1)
    DeviceCreateDate: NotRequired[datetime.datetime],
    DeviceLastModifiedDate: NotRequired[datetime.datetime],
    DeviceLastAuthenticatedDate: NotRequired[datetime.datetime],

1. See List[AttributeTypeTypeDef]

UpdateUserAttributesRequestTypeDef

# UpdateUserAttributesRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserAttributesRequestTypeDef


def get_value() -> UpdateUserAttributesRequestTypeDef:
    return {
        "UserAttributes": ...,
    }


# UpdateUserAttributesRequestTypeDef definition

class UpdateUserAttributesRequestTypeDef(TypedDict):
    UserAttributes: Sequence[AttributeTypeTypeDef],  # (1)
    AccessToken: str,
    ClientMetadata: NotRequired[Mapping[str, str]],

1. See Sequence[AttributeTypeTypeDef]

AssociateSoftwareTokenResponseTypeDef

# AssociateSoftwareTokenResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AssociateSoftwareTokenResponseTypeDef


def get_value() -> AssociateSoftwareTokenResponseTypeDef:
    return {
        "SecretCode": ...,
    }


# AssociateSoftwareTokenResponseTypeDef definition

class AssociateSoftwareTokenResponseTypeDef(TypedDict):
    SecretCode: str,
    Session: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ConfirmDeviceResponseTypeDef

# ConfirmDeviceResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ConfirmDeviceResponseTypeDef


def get_value() -> ConfirmDeviceResponseTypeDef:
    return {
        "UserConfirmationNecessary": ...,
    }


# ConfirmDeviceResponseTypeDef definition

class ConfirmDeviceResponseTypeDef(TypedDict):
    UserConfirmationNecessary: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ConfirmSignUpResponseTypeDef

# ConfirmSignUpResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ConfirmSignUpResponseTypeDef


def get_value() -> ConfirmSignUpResponseTypeDef:
    return {
        "Session": ...,
    }


# ConfirmSignUpResponseTypeDef definition

class ConfirmSignUpResponseTypeDef(TypedDict):
    Session: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

CreateUserPoolDomainResponseTypeDef

# CreateUserPoolDomainResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserPoolDomainResponseTypeDef


def get_value() -> CreateUserPoolDomainResponseTypeDef:
    return {
        "ManagedLoginVersion": ...,
    }


# CreateUserPoolDomainResponseTypeDef definition

class CreateUserPoolDomainResponseTypeDef(TypedDict):
    ManagedLoginVersion: int,
    CloudFrontDomain: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetCSVHeaderResponseTypeDef

# GetCSVHeaderResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetCSVHeaderResponseTypeDef


def get_value() -> GetCSVHeaderResponseTypeDef:
    return {
        "UserPoolId": ...,
    }


# GetCSVHeaderResponseTypeDef definition

class GetCSVHeaderResponseTypeDef(TypedDict):
    UserPoolId: str,
    CSVHeader: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetSigningCertificateResponseTypeDef

# GetSigningCertificateResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetSigningCertificateResponseTypeDef


def get_value() -> GetSigningCertificateResponseTypeDef:
    return {
        "Certificate": ...,
    }


# GetSigningCertificateResponseTypeDef definition

class GetSigningCertificateResponseTypeDef(TypedDict):
    Certificate: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetUserAuthFactorsResponseTypeDef

# GetUserAuthFactorsResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetUserAuthFactorsResponseTypeDef


def get_value() -> GetUserAuthFactorsResponseTypeDef:
    return {
        "Username": ...,
    }


# GetUserAuthFactorsResponseTypeDef definition

class GetUserAuthFactorsResponseTypeDef(TypedDict):
    Username: str,
    PreferredMfaSetting: str,
    UserMFASettingList: List[str],
    ConfiguredUserAuthFactors: List[AuthFactorTypeType],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[AuthFactorTypeType]
2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

StartWebAuthnRegistrationResponseTypeDef

# StartWebAuthnRegistrationResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import StartWebAuthnRegistrationResponseTypeDef


def get_value() -> StartWebAuthnRegistrationResponseTypeDef:
    return {
        "CredentialCreationOptions": ...,
    }


# StartWebAuthnRegistrationResponseTypeDef definition

class StartWebAuthnRegistrationResponseTypeDef(TypedDict):
    CredentialCreationOptions: Dict[str, Any],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

UpdateUserPoolDomainResponseTypeDef

# UpdateUserPoolDomainResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserPoolDomainResponseTypeDef


def get_value() -> UpdateUserPoolDomainResponseTypeDef:
    return {
        "ManagedLoginVersion": ...,
    }


# UpdateUserPoolDomainResponseTypeDef definition

class UpdateUserPoolDomainResponseTypeDef(TypedDict):
    ManagedLoginVersion: int,
    CloudFrontDomain: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

VerifySoftwareTokenResponseTypeDef

# VerifySoftwareTokenResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import VerifySoftwareTokenResponseTypeDef


def get_value() -> VerifySoftwareTokenResponseTypeDef:
    return {
        "Status": ...,
    }


# VerifySoftwareTokenResponseTypeDef definition

class VerifySoftwareTokenResponseTypeDef(TypedDict):
    Status: VerifySoftwareTokenResponseTypeType,  # (1)
    Session: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See VerifySoftwareTokenResponseTypeType
2. See ResponseMetadataTypeDef

AdminDisableProviderForUserRequestTypeDef

# AdminDisableProviderForUserRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminDisableProviderForUserRequestTypeDef


def get_value() -> AdminDisableProviderForUserRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminDisableProviderForUserRequestTypeDef definition

class AdminDisableProviderForUserRequestTypeDef(TypedDict):
    UserPoolId: str,
    User: ProviderUserIdentifierTypeTypeDef,  # (1)

1. See ProviderUserIdentifierTypeTypeDef

AdminLinkProviderForUserRequestTypeDef

# AdminLinkProviderForUserRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminLinkProviderForUserRequestTypeDef


def get_value() -> AdminLinkProviderForUserRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminLinkProviderForUserRequestTypeDef definition

class AdminLinkProviderForUserRequestTypeDef(TypedDict):
    UserPoolId: str,
    DestinationUser: ProviderUserIdentifierTypeTypeDef,  # (1)
    SourceUser: ProviderUserIdentifierTypeTypeDef,  # (1)

1. See ProviderUserIdentifierTypeTypeDef
2. See ProviderUserIdentifierTypeTypeDef

AdminGetUserResponseTypeDef

# AdminGetUserResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminGetUserResponseTypeDef


def get_value() -> AdminGetUserResponseTypeDef:
    return {
        "Username": ...,
    }


# AdminGetUserResponseTypeDef definition

class AdminGetUserResponseTypeDef(TypedDict):
    Username: str,
    UserAttributes: List[AttributeTypeTypeDef],  # (1)
    UserCreateDate: datetime.datetime,
    UserLastModifiedDate: datetime.datetime,
    Enabled: bool,
    UserStatus: UserStatusTypeType,  # (2)
    MFAOptions: List[MFAOptionTypeTypeDef],  # (3)
    PreferredMfaSetting: str,
    UserMFASettingList: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See List[AttributeTypeTypeDef]
2. See UserStatusTypeType
3. See List[MFAOptionTypeTypeDef]
4. See ResponseMetadataTypeDef

AdminSetUserSettingsRequestTypeDef

# AdminSetUserSettingsRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminSetUserSettingsRequestTypeDef


def get_value() -> AdminSetUserSettingsRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminSetUserSettingsRequestTypeDef definition

class AdminSetUserSettingsRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    MFAOptions: Sequence[MFAOptionTypeTypeDef],  # (1)

1. See Sequence[MFAOptionTypeTypeDef]

GetUserResponseTypeDef

# GetUserResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetUserResponseTypeDef


def get_value() -> GetUserResponseTypeDef:
    return {
        "Username": ...,
    }


# GetUserResponseTypeDef definition

class GetUserResponseTypeDef(TypedDict):
    Username: str,
    UserAttributes: List[AttributeTypeTypeDef],  # (1)
    MFAOptions: List[MFAOptionTypeTypeDef],  # (2)
    PreferredMfaSetting: str,
    UserMFASettingList: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See List[AttributeTypeTypeDef]
2. See List[MFAOptionTypeTypeDef]
3. See ResponseMetadataTypeDef

SetUserSettingsRequestTypeDef

# SetUserSettingsRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SetUserSettingsRequestTypeDef


def get_value() -> SetUserSettingsRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# SetUserSettingsRequestTypeDef definition

class SetUserSettingsRequestTypeDef(TypedDict):
    AccessToken: str,
    MFAOptions: Sequence[MFAOptionTypeTypeDef],  # (1)

1. See Sequence[MFAOptionTypeTypeDef]

UserTypeTypeDef

# UserTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserTypeTypeDef


def get_value() -> UserTypeTypeDef:
    return {
        "Username": ...,
    }


# UserTypeTypeDef definition

class UserTypeTypeDef(TypedDict):
    Username: NotRequired[str],
    Attributes: NotRequired[List[AttributeTypeTypeDef]],  # (1)
    UserCreateDate: NotRequired[datetime.datetime],
    UserLastModifiedDate: NotRequired[datetime.datetime],
    Enabled: NotRequired[bool],
    UserStatus: NotRequired[UserStatusTypeType],  # (2)
    MFAOptions: NotRequired[List[MFAOptionTypeTypeDef]],  # (3)

1. See List[AttributeTypeTypeDef]
2. See UserStatusTypeType
3. See List[MFAOptionTypeTypeDef]

AdminListGroupsForUserRequestPaginateTypeDef

# AdminListGroupsForUserRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminListGroupsForUserRequestPaginateTypeDef


def get_value() -> AdminListGroupsForUserRequestPaginateTypeDef:
    return {
        "Username": ...,
    }


# AdminListGroupsForUserRequestPaginateTypeDef definition

class AdminListGroupsForUserRequestPaginateTypeDef(TypedDict):
    Username: str,
    UserPoolId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

AdminListUserAuthEventsRequestPaginateTypeDef

# AdminListUserAuthEventsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminListUserAuthEventsRequestPaginateTypeDef


def get_value() -> AdminListUserAuthEventsRequestPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminListUserAuthEventsRequestPaginateTypeDef definition

class AdminListUserAuthEventsRequestPaginateTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListGroupsRequestPaginateTypeDef

# ListGroupsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListGroupsRequestPaginateTypeDef


def get_value() -> ListGroupsRequestPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListGroupsRequestPaginateTypeDef definition

class ListGroupsRequestPaginateTypeDef(TypedDict):
    UserPoolId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListIdentityProvidersRequestPaginateTypeDef

# ListIdentityProvidersRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListIdentityProvidersRequestPaginateTypeDef


def get_value() -> ListIdentityProvidersRequestPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListIdentityProvidersRequestPaginateTypeDef definition

class ListIdentityProvidersRequestPaginateTypeDef(TypedDict):
    UserPoolId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListResourceServersRequestPaginateTypeDef

# ListResourceServersRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListResourceServersRequestPaginateTypeDef


def get_value() -> ListResourceServersRequestPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListResourceServersRequestPaginateTypeDef definition

class ListResourceServersRequestPaginateTypeDef(TypedDict):
    UserPoolId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListUserPoolClientsRequestPaginateTypeDef

# ListUserPoolClientsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUserPoolClientsRequestPaginateTypeDef


def get_value() -> ListUserPoolClientsRequestPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListUserPoolClientsRequestPaginateTypeDef definition

class ListUserPoolClientsRequestPaginateTypeDef(TypedDict):
    UserPoolId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListUserPoolsRequestPaginateTypeDef

# ListUserPoolsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUserPoolsRequestPaginateTypeDef


def get_value() -> ListUserPoolsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListUserPoolsRequestPaginateTypeDef definition

class ListUserPoolsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListUsersInGroupRequestPaginateTypeDef

# ListUsersInGroupRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersInGroupRequestPaginateTypeDef


def get_value() -> ListUsersInGroupRequestPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListUsersInGroupRequestPaginateTypeDef definition

class ListUsersInGroupRequestPaginateTypeDef(TypedDict):
    UserPoolId: str,
    GroupName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListUsersRequestPaginateTypeDef

# ListUsersRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersRequestPaginateTypeDef


def get_value() -> ListUsersRequestPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }


# ListUsersRequestPaginateTypeDef definition

class ListUsersRequestPaginateTypeDef(TypedDict):
    UserPoolId: str,
    AttributesToGet: NotRequired[Sequence[str]],
    Filter: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

AdminListGroupsForUserResponseTypeDef

# AdminListGroupsForUserResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminListGroupsForUserResponseTypeDef


def get_value() -> AdminListGroupsForUserResponseTypeDef:
    return {
        "Groups": ...,
    }


# AdminListGroupsForUserResponseTypeDef definition

class AdminListGroupsForUserResponseTypeDef(TypedDict):
    Groups: List[GroupTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[GroupTypeTypeDef]
2. See ResponseMetadataTypeDef

CreateGroupResponseTypeDef

# CreateGroupResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateGroupResponseTypeDef


def get_value() -> CreateGroupResponseTypeDef:
    return {
        "Group": ...,
    }


# CreateGroupResponseTypeDef definition

class CreateGroupResponseTypeDef(TypedDict):
    Group: GroupTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See GroupTypeTypeDef
2. See ResponseMetadataTypeDef

GetGroupResponseTypeDef

# GetGroupResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetGroupResponseTypeDef


def get_value() -> GetGroupResponseTypeDef:
    return {
        "Group": ...,
    }


# GetGroupResponseTypeDef definition

class GetGroupResponseTypeDef(TypedDict):
    Group: GroupTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See GroupTypeTypeDef
2. See ResponseMetadataTypeDef

ListGroupsResponseTypeDef

# ListGroupsResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListGroupsResponseTypeDef


def get_value() -> ListGroupsResponseTypeDef:
    return {
        "Groups": ...,
    }


# ListGroupsResponseTypeDef definition

class ListGroupsResponseTypeDef(TypedDict):
    Groups: List[GroupTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[GroupTypeTypeDef]
2. See ResponseMetadataTypeDef

UpdateGroupResponseTypeDef

# UpdateGroupResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateGroupResponseTypeDef


def get_value() -> UpdateGroupResponseTypeDef:
    return {
        "Group": ...,
    }


# UpdateGroupResponseTypeDef definition

class UpdateGroupResponseTypeDef(TypedDict):
    Group: GroupTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See GroupTypeTypeDef
2. See ResponseMetadataTypeDef

AdminSetUserMFAPreferenceRequestTypeDef

# AdminSetUserMFAPreferenceRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminSetUserMFAPreferenceRequestTypeDef


def get_value() -> AdminSetUserMFAPreferenceRequestTypeDef:
    return {
        "Username": ...,
    }


# AdminSetUserMFAPreferenceRequestTypeDef definition

class AdminSetUserMFAPreferenceRequestTypeDef(TypedDict):
    Username: str,
    UserPoolId: str,
    SMSMfaSettings: NotRequired[SMSMfaSettingsTypeTypeDef],  # (1)
    SoftwareTokenMfaSettings: NotRequired[SoftwareTokenMfaSettingsTypeTypeDef],  # (2)
    EmailMfaSettings: NotRequired[EmailMfaSettingsTypeTypeDef],  # (3)

1. See SMSMfaSettingsTypeTypeDef
2. See SoftwareTokenMfaSettingsTypeTypeDef
3. See EmailMfaSettingsTypeTypeDef

SetUserMFAPreferenceRequestTypeDef

# SetUserMFAPreferenceRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SetUserMFAPreferenceRequestTypeDef


def get_value() -> SetUserMFAPreferenceRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# SetUserMFAPreferenceRequestTypeDef definition

class SetUserMFAPreferenceRequestTypeDef(TypedDict):
    AccessToken: str,
    SMSMfaSettings: NotRequired[SMSMfaSettingsTypeTypeDef],  # (1)
    SoftwareTokenMfaSettings: NotRequired[SoftwareTokenMfaSettingsTypeTypeDef],  # (2)
    EmailMfaSettings: NotRequired[EmailMfaSettingsTypeTypeDef],  # (3)

1. See SMSMfaSettingsTypeTypeDef
2. See SoftwareTokenMfaSettingsTypeTypeDef
3. See EmailMfaSettingsTypeTypeDef

UserPoolAddOnsTypeTypeDef

# UserPoolAddOnsTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserPoolAddOnsTypeTypeDef


def get_value() -> UserPoolAddOnsTypeTypeDef:
    return {
        "AdvancedSecurityMode": ...,
    }


# UserPoolAddOnsTypeTypeDef definition

class UserPoolAddOnsTypeTypeDef(TypedDict):
    AdvancedSecurityMode: AdvancedSecurityModeTypeType,  # (1)
    AdvancedSecurityAdditionalFlows: NotRequired[AdvancedSecurityAdditionalFlowsTypeTypeDef],  # (2)

1. See AdvancedSecurityModeTypeType
2. See AdvancedSecurityAdditionalFlowsTypeTypeDef

ManagedLoginBrandingTypeTypeDef

# ManagedLoginBrandingTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ManagedLoginBrandingTypeTypeDef


def get_value() -> ManagedLoginBrandingTypeTypeDef:
    return {
        "ManagedLoginBrandingId": ...,
    }


# ManagedLoginBrandingTypeTypeDef definition

class ManagedLoginBrandingTypeTypeDef(TypedDict):
    ManagedLoginBrandingId: NotRequired[str],
    UserPoolId: NotRequired[str],
    UseCognitoProvidedValues: NotRequired[bool],
    Settings: NotRequired[Dict[str, Any]],
    Assets: NotRequired[List[AssetTypeOutputTypeDef]],  # (1)
    CreationDate: NotRequired[datetime.datetime],
    LastModifiedDate: NotRequired[datetime.datetime],

1. See List[AssetTypeOutputTypeDef]

AssetTypeTypeDef

# AssetTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AssetTypeTypeDef


def get_value() -> AssetTypeTypeDef:
    return {
        "Category": ...,
    }


# AssetTypeTypeDef definition

class AssetTypeTypeDef(TypedDict):
    Category: AssetCategoryTypeType,  # (1)
    ColorMode: ColorSchemeModeTypeType,  # (2)
    Extension: AssetExtensionTypeType,  # (3)
    Bytes: NotRequired[BlobTypeDef],
    ResourceId: NotRequired[str],

1. See AssetCategoryTypeType
2. See ColorSchemeModeTypeType
3. See AssetExtensionTypeType

SetUICustomizationRequestTypeDef

# SetUICustomizationRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SetUICustomizationRequestTypeDef


def get_value() -> SetUICustomizationRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# SetUICustomizationRequestTypeDef definition

class SetUICustomizationRequestTypeDef(TypedDict):
    UserPoolId: str,
    ClientId: NotRequired[str],
    CSS: NotRequired[str],
    ImageFile: NotRequired[BlobTypeDef],

AuthEventTypeTypeDef

# AuthEventTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AuthEventTypeTypeDef


def get_value() -> AuthEventTypeTypeDef:
    return {
        "EventId": ...,
    }


# AuthEventTypeTypeDef definition

class AuthEventTypeTypeDef(TypedDict):
    EventId: NotRequired[str],
    EventType: NotRequired[EventTypeType],  # (1)
    CreationDate: NotRequired[datetime.datetime],
    EventResponse: NotRequired[EventResponseTypeType],  # (2)
    EventRisk: NotRequired[EventRiskTypeTypeDef],  # (3)
    ChallengeResponses: NotRequired[List[ChallengeResponseTypeTypeDef]],  # (4)
    EventContextData: NotRequired[EventContextDataTypeTypeDef],  # (5)
    EventFeedback: NotRequired[EventFeedbackTypeTypeDef],  # (6)

1. See EventTypeType
2. See EventResponseTypeType
3. See EventRiskTypeTypeDef
4. See List[ChallengeResponseTypeTypeDef]
5. See EventContextDataTypeTypeDef
6. See EventFeedbackTypeTypeDef

AuthenticationResultTypeTypeDef

# AuthenticationResultTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AuthenticationResultTypeTypeDef


def get_value() -> AuthenticationResultTypeTypeDef:
    return {
        "AccessToken": ...,
    }


# AuthenticationResultTypeTypeDef definition

class AuthenticationResultTypeTypeDef(TypedDict):
    AccessToken: NotRequired[str],
    ExpiresIn: NotRequired[int],
    TokenType: NotRequired[str],
    RefreshToken: NotRequired[str],
    IdToken: NotRequired[str],
    NewDeviceMetadata: NotRequired[NewDeviceMetadataTypeTypeDef],  # (1)

1. See NewDeviceMetadataTypeTypeDef

ForgotPasswordResponseTypeDef

# ForgotPasswordResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ForgotPasswordResponseTypeDef


def get_value() -> ForgotPasswordResponseTypeDef:
    return {
        "CodeDeliveryDetails": ...,
    }


# ForgotPasswordResponseTypeDef definition

class ForgotPasswordResponseTypeDef(TypedDict):
    CodeDeliveryDetails: CodeDeliveryDetailsTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CodeDeliveryDetailsTypeTypeDef
2. See ResponseMetadataTypeDef

GetUserAttributeVerificationCodeResponseTypeDef

# GetUserAttributeVerificationCodeResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetUserAttributeVerificationCodeResponseTypeDef


def get_value() -> GetUserAttributeVerificationCodeResponseTypeDef:
    return {
        "CodeDeliveryDetails": ...,
    }


# GetUserAttributeVerificationCodeResponseTypeDef definition

class GetUserAttributeVerificationCodeResponseTypeDef(TypedDict):
    CodeDeliveryDetails: CodeDeliveryDetailsTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CodeDeliveryDetailsTypeTypeDef
2. See ResponseMetadataTypeDef

ResendConfirmationCodeResponseTypeDef

# ResendConfirmationCodeResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ResendConfirmationCodeResponseTypeDef


def get_value() -> ResendConfirmationCodeResponseTypeDef:
    return {
        "CodeDeliveryDetails": ...,
    }


# ResendConfirmationCodeResponseTypeDef definition

class ResendConfirmationCodeResponseTypeDef(TypedDict):
    CodeDeliveryDetails: CodeDeliveryDetailsTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CodeDeliveryDetailsTypeTypeDef
2. See ResponseMetadataTypeDef

SignUpResponseTypeDef

# SignUpResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SignUpResponseTypeDef


def get_value() -> SignUpResponseTypeDef:
    return {
        "UserConfirmed": ...,
    }


# SignUpResponseTypeDef definition

class SignUpResponseTypeDef(TypedDict):
    UserConfirmed: bool,
    CodeDeliveryDetails: CodeDeliveryDetailsTypeTypeDef,  # (1)
    UserSub: str,
    Session: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CodeDeliveryDetailsTypeTypeDef
2. See ResponseMetadataTypeDef

UpdateUserAttributesResponseTypeDef

# UpdateUserAttributesResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserAttributesResponseTypeDef


def get_value() -> UpdateUserAttributesResponseTypeDef:
    return {
        "CodeDeliveryDetailsList": ...,
    }


# UpdateUserAttributesResponseTypeDef definition

class UpdateUserAttributesResponseTypeDef(TypedDict):
    CodeDeliveryDetailsList: List[CodeDeliveryDetailsTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[CodeDeliveryDetailsTypeTypeDef]
2. See ResponseMetadataTypeDef

CompromisedCredentialsRiskConfigurationTypeOutputTypeDef

# CompromisedCredentialsRiskConfigurationTypeOutputTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CompromisedCredentialsRiskConfigurationTypeOutputTypeDef


def get_value() -> CompromisedCredentialsRiskConfigurationTypeOutputTypeDef:
    return {
        "EventFilter": ...,
    }


# CompromisedCredentialsRiskConfigurationTypeOutputTypeDef definition

class CompromisedCredentialsRiskConfigurationTypeOutputTypeDef(TypedDict):
    Actions: CompromisedCredentialsActionsTypeTypeDef,  # (2)
    EventFilter: NotRequired[List[EventFilterTypeType]],  # (1)

1. See List[EventFilterTypeType]
2. See CompromisedCredentialsActionsTypeTypeDef

CompromisedCredentialsRiskConfigurationTypeTypeDef

# CompromisedCredentialsRiskConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CompromisedCredentialsRiskConfigurationTypeTypeDef


def get_value() -> CompromisedCredentialsRiskConfigurationTypeTypeDef:
    return {
        "EventFilter": ...,
    }


# CompromisedCredentialsRiskConfigurationTypeTypeDef definition

class CompromisedCredentialsRiskConfigurationTypeTypeDef(TypedDict):
    Actions: CompromisedCredentialsActionsTypeTypeDef,  # (2)
    EventFilter: NotRequired[Sequence[EventFilterTypeType]],  # (1)

1. See Sequence[EventFilterTypeType]
2. See CompromisedCredentialsActionsTypeTypeDef

ConfirmDeviceRequestTypeDef

# ConfirmDeviceRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ConfirmDeviceRequestTypeDef


def get_value() -> ConfirmDeviceRequestTypeDef:
    return {
        "AccessToken": ...,
    }


# ConfirmDeviceRequestTypeDef definition

class ConfirmDeviceRequestTypeDef(TypedDict):
    AccessToken: str,
    DeviceKey: str,
    DeviceSecretVerifierConfig: NotRequired[DeviceSecretVerifierConfigTypeTypeDef],  # (1)
    DeviceName: NotRequired[str],

1. See DeviceSecretVerifierConfigTypeTypeDef

ConfirmForgotPasswordRequestTypeDef

# ConfirmForgotPasswordRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ConfirmForgotPasswordRequestTypeDef


def get_value() -> ConfirmForgotPasswordRequestTypeDef:
    return {
        "ClientId": ...,
    }


# ConfirmForgotPasswordRequestTypeDef definition

class ConfirmForgotPasswordRequestTypeDef(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]],

1. See AnalyticsMetadataTypeTypeDef
2. See UserContextDataTypeTypeDef

ConfirmSignUpRequestTypeDef

# ConfirmSignUpRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ConfirmSignUpRequestTypeDef


def get_value() -> ConfirmSignUpRequestTypeDef:
    return {
        "ClientId": ...,
    }


# ConfirmSignUpRequestTypeDef definition

class ConfirmSignUpRequestTypeDef(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]],
    Session: NotRequired[str],

1. See AnalyticsMetadataTypeTypeDef
2. See UserContextDataTypeTypeDef

ForgotPasswordRequestTypeDef

# ForgotPasswordRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ForgotPasswordRequestTypeDef


def get_value() -> ForgotPasswordRequestTypeDef:
    return {
        "ClientId": ...,
    }


# ForgotPasswordRequestTypeDef definition

class ForgotPasswordRequestTypeDef(TypedDict):
    ClientId: str,
    Username: str,
    SecretHash: NotRequired[str],
    UserContextData: NotRequired[UserContextDataTypeTypeDef],  # (1)
    AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef],  # (2)
    ClientMetadata: NotRequired[Mapping[str, str]],

1. See UserContextDataTypeTypeDef
2. See AnalyticsMetadataTypeTypeDef

InitiateAuthRequestTypeDef

# InitiateAuthRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import InitiateAuthRequestTypeDef


def get_value() -> InitiateAuthRequestTypeDef:
    return {
        "AuthFlow": ...,
    }


# InitiateAuthRequestTypeDef definition

class InitiateAuthRequestTypeDef(TypedDict):
    AuthFlow: AuthFlowTypeType,  # (1)
    ClientId: str,
    AuthParameters: NotRequired[Mapping[str, str]],
    ClientMetadata: NotRequired[Mapping[str, str]],
    AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef],  # (2)
    UserContextData: NotRequired[UserContextDataTypeTypeDef],  # (3)
    Session: NotRequired[str],

1. See AuthFlowTypeType
2. See AnalyticsMetadataTypeTypeDef
3. See UserContextDataTypeTypeDef

ResendConfirmationCodeRequestTypeDef

# ResendConfirmationCodeRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ResendConfirmationCodeRequestTypeDef


def get_value() -> ResendConfirmationCodeRequestTypeDef:
    return {
        "ClientId": ...,
    }


# ResendConfirmationCodeRequestTypeDef definition

class ResendConfirmationCodeRequestTypeDef(TypedDict):
    ClientId: str,
    Username: str,
    SecretHash: NotRequired[str],
    UserContextData: NotRequired[UserContextDataTypeTypeDef],  # (1)
    AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef],  # (2)
    ClientMetadata: NotRequired[Mapping[str, str]],

1. See UserContextDataTypeTypeDef
2. See AnalyticsMetadataTypeTypeDef

RespondToAuthChallengeRequestTypeDef

# RespondToAuthChallengeRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import RespondToAuthChallengeRequestTypeDef


def get_value() -> RespondToAuthChallengeRequestTypeDef:
    return {
        "ClientId": ...,
    }


# RespondToAuthChallengeRequestTypeDef definition

class RespondToAuthChallengeRequestTypeDef(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]],

1. See ChallengeNameTypeType
2. See AnalyticsMetadataTypeTypeDef
3. See UserContextDataTypeTypeDef

SignUpRequestTypeDef

# SignUpRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SignUpRequestTypeDef


def get_value() -> SignUpRequestTypeDef:
    return {
        "ClientId": ...,
    }


# SignUpRequestTypeDef definition

class SignUpRequestTypeDef(TypedDict):
    ClientId: str,
    Username: str,
    SecretHash: NotRequired[str],
    Password: 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]],

1. See Sequence[AttributeTypeTypeDef]
2. See Sequence[AttributeTypeTypeDef]
3. See AnalyticsMetadataTypeTypeDef
4. See UserContextDataTypeTypeDef

ContextDataTypeTypeDef

# ContextDataTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ContextDataTypeTypeDef


def get_value() -> ContextDataTypeTypeDef:
    return {
        "IpAddress": ...,
    }


# ContextDataTypeTypeDef definition

class ContextDataTypeTypeDef(TypedDict):
    IpAddress: str,
    ServerName: str,
    ServerPath: str,
    HttpHeaders: Sequence[HttpHeaderTypeDef],  # (1)
    EncodedData: NotRequired[str],

1. See Sequence[HttpHeaderTypeDef]

CreateIdentityProviderResponseTypeDef

# CreateIdentityProviderResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateIdentityProviderResponseTypeDef


def get_value() -> CreateIdentityProviderResponseTypeDef:
    return {
        "IdentityProvider": ...,
    }


# CreateIdentityProviderResponseTypeDef definition

class CreateIdentityProviderResponseTypeDef(TypedDict):
    IdentityProvider: IdentityProviderTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IdentityProviderTypeTypeDef
2. See ResponseMetadataTypeDef

DescribeIdentityProviderResponseTypeDef

# DescribeIdentityProviderResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeIdentityProviderResponseTypeDef


def get_value() -> DescribeIdentityProviderResponseTypeDef:
    return {
        "IdentityProvider": ...,
    }


# DescribeIdentityProviderResponseTypeDef definition

class DescribeIdentityProviderResponseTypeDef(TypedDict):
    IdentityProvider: IdentityProviderTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IdentityProviderTypeTypeDef
2. See ResponseMetadataTypeDef

GetIdentityProviderByIdentifierResponseTypeDef

# GetIdentityProviderByIdentifierResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetIdentityProviderByIdentifierResponseTypeDef


def get_value() -> GetIdentityProviderByIdentifierResponseTypeDef:
    return {
        "IdentityProvider": ...,
    }


# GetIdentityProviderByIdentifierResponseTypeDef definition

class GetIdentityProviderByIdentifierResponseTypeDef(TypedDict):
    IdentityProvider: IdentityProviderTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IdentityProviderTypeTypeDef
2. See ResponseMetadataTypeDef

UpdateIdentityProviderResponseTypeDef

# UpdateIdentityProviderResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateIdentityProviderResponseTypeDef


def get_value() -> UpdateIdentityProviderResponseTypeDef:
    return {
        "IdentityProvider": ...,
    }


# UpdateIdentityProviderResponseTypeDef definition

class UpdateIdentityProviderResponseTypeDef(TypedDict):
    IdentityProvider: IdentityProviderTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IdentityProviderTypeTypeDef
2. See ResponseMetadataTypeDef

CreateResourceServerRequestTypeDef

# CreateResourceServerRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateResourceServerRequestTypeDef


def get_value() -> CreateResourceServerRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# CreateResourceServerRequestTypeDef definition

class CreateResourceServerRequestTypeDef(TypedDict):
    UserPoolId: str,
    Identifier: str,
    Name: str,
    Scopes: NotRequired[Sequence[ResourceServerScopeTypeTypeDef]],  # (1)

1. See Sequence[ResourceServerScopeTypeTypeDef]

ResourceServerTypeTypeDef

# ResourceServerTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ResourceServerTypeTypeDef


def get_value() -> ResourceServerTypeTypeDef:
    return {
        "UserPoolId": ...,
    }


# ResourceServerTypeTypeDef definition

class ResourceServerTypeTypeDef(TypedDict):
    UserPoolId: NotRequired[str],
    Identifier: NotRequired[str],
    Name: NotRequired[str],
    Scopes: NotRequired[List[ResourceServerScopeTypeTypeDef]],  # (1)

1. See List[ResourceServerScopeTypeTypeDef]

UpdateResourceServerRequestTypeDef

# UpdateResourceServerRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateResourceServerRequestTypeDef


def get_value() -> UpdateResourceServerRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# UpdateResourceServerRequestTypeDef definition

class UpdateResourceServerRequestTypeDef(TypedDict):
    UserPoolId: str,
    Identifier: str,
    Name: str,
    Scopes: NotRequired[Sequence[ResourceServerScopeTypeTypeDef]],  # (1)

1. See Sequence[ResourceServerScopeTypeTypeDef]

CreateUserImportJobResponseTypeDef

# CreateUserImportJobResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserImportJobResponseTypeDef


def get_value() -> CreateUserImportJobResponseTypeDef:
    return {
        "UserImportJob": ...,
    }


# CreateUserImportJobResponseTypeDef definition

class CreateUserImportJobResponseTypeDef(TypedDict):
    UserImportJob: UserImportJobTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserImportJobTypeTypeDef
2. See ResponseMetadataTypeDef

DescribeUserImportJobResponseTypeDef

# DescribeUserImportJobResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserImportJobResponseTypeDef


def get_value() -> DescribeUserImportJobResponseTypeDef:
    return {
        "UserImportJob": ...,
    }


# DescribeUserImportJobResponseTypeDef definition

class DescribeUserImportJobResponseTypeDef(TypedDict):
    UserImportJob: UserImportJobTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserImportJobTypeTypeDef
2. See ResponseMetadataTypeDef

ListUserImportJobsResponseTypeDef

# ListUserImportJobsResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUserImportJobsResponseTypeDef


def get_value() -> ListUserImportJobsResponseTypeDef:
    return {
        "UserImportJobs": ...,
    }


# ListUserImportJobsResponseTypeDef definition

class ListUserImportJobsResponseTypeDef(TypedDict):
    UserImportJobs: List[UserImportJobTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    PaginationToken: NotRequired[str],

1. See List[UserImportJobTypeTypeDef]
2. See ResponseMetadataTypeDef

StartUserImportJobResponseTypeDef

# StartUserImportJobResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import StartUserImportJobResponseTypeDef


def get_value() -> StartUserImportJobResponseTypeDef:
    return {
        "UserImportJob": ...,
    }


# StartUserImportJobResponseTypeDef definition

class StartUserImportJobResponseTypeDef(TypedDict):
    UserImportJob: UserImportJobTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserImportJobTypeTypeDef
2. See ResponseMetadataTypeDef

StopUserImportJobResponseTypeDef

# StopUserImportJobResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import StopUserImportJobResponseTypeDef


def get_value() -> StopUserImportJobResponseTypeDef:
    return {
        "UserImportJob": ...,
    }


# StopUserImportJobResponseTypeDef definition

class StopUserImportJobResponseTypeDef(TypedDict):
    UserImportJob: UserImportJobTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserImportJobTypeTypeDef
2. See ResponseMetadataTypeDef

CreateUserPoolClientRequestTypeDef

# CreateUserPoolClientRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserPoolClientRequestTypeDef


def get_value() -> CreateUserPoolClientRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# CreateUserPoolClientRequestTypeDef definition

class CreateUserPoolClientRequestTypeDef(TypedDict):
    UserPoolId: str,
    ClientName: str,
    GenerateSecret: NotRequired[bool],
    RefreshTokenValidity: NotRequired[int],
    AccessTokenValidity: NotRequired[int],
    IdTokenValidity: NotRequired[int],
    TokenValidityUnits: NotRequired[TokenValidityUnitsTypeTypeDef],  # (1)
    ReadAttributes: NotRequired[Sequence[str]],
    WriteAttributes: NotRequired[Sequence[str]],
    ExplicitAuthFlows: NotRequired[Sequence[ExplicitAuthFlowsTypeType]],  # (2)
    SupportedIdentityProviders: NotRequired[Sequence[str]],
    CallbackURLs: NotRequired[Sequence[str]],
    LogoutURLs: NotRequired[Sequence[str]],
    DefaultRedirectURI: NotRequired[str],
    AllowedOAuthFlows: NotRequired[Sequence[OAuthFlowTypeType]],  # (3)
    AllowedOAuthScopes: NotRequired[Sequence[str]],
    AllowedOAuthFlowsUserPoolClient: NotRequired[bool],
    AnalyticsConfiguration: NotRequired[AnalyticsConfigurationTypeTypeDef],  # (4)
    PreventUserExistenceErrors: NotRequired[PreventUserExistenceErrorTypesType],  # (5)
    EnableTokenRevocation: NotRequired[bool],
    EnablePropagateAdditionalUserContextData: NotRequired[bool],
    AuthSessionValidity: NotRequired[int],
    RefreshTokenRotation: NotRequired[RefreshTokenRotationTypeTypeDef],  # (6)

1. See TokenValidityUnitsTypeTypeDef
2. See Sequence[ExplicitAuthFlowsTypeType]
3. See Sequence[OAuthFlowTypeType]
4. See AnalyticsConfigurationTypeTypeDef
5. See PreventUserExistenceErrorTypesType
6. See RefreshTokenRotationTypeTypeDef

UpdateUserPoolClientRequestTypeDef

# UpdateUserPoolClientRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserPoolClientRequestTypeDef


def get_value() -> UpdateUserPoolClientRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# UpdateUserPoolClientRequestTypeDef definition

class UpdateUserPoolClientRequestTypeDef(TypedDict):
    UserPoolId: str,
    ClientId: str,
    ClientName: NotRequired[str],
    RefreshTokenValidity: NotRequired[int],
    AccessTokenValidity: NotRequired[int],
    IdTokenValidity: NotRequired[int],
    TokenValidityUnits: NotRequired[TokenValidityUnitsTypeTypeDef],  # (1)
    ReadAttributes: NotRequired[Sequence[str]],
    WriteAttributes: NotRequired[Sequence[str]],
    ExplicitAuthFlows: NotRequired[Sequence[ExplicitAuthFlowsTypeType]],  # (2)
    SupportedIdentityProviders: NotRequired[Sequence[str]],
    CallbackURLs: NotRequired[Sequence[str]],
    LogoutURLs: NotRequired[Sequence[str]],
    DefaultRedirectURI: NotRequired[str],
    AllowedOAuthFlows: NotRequired[Sequence[OAuthFlowTypeType]],  # (3)
    AllowedOAuthScopes: NotRequired[Sequence[str]],
    AllowedOAuthFlowsUserPoolClient: NotRequired[bool],
    AnalyticsConfiguration: NotRequired[AnalyticsConfigurationTypeTypeDef],  # (4)
    PreventUserExistenceErrors: NotRequired[PreventUserExistenceErrorTypesType],  # (5)
    EnableTokenRevocation: NotRequired[bool],
    EnablePropagateAdditionalUserContextData: NotRequired[bool],
    AuthSessionValidity: NotRequired[int],
    RefreshTokenRotation: NotRequired[RefreshTokenRotationTypeTypeDef],  # (6)

1. See TokenValidityUnitsTypeTypeDef
2. See Sequence[ExplicitAuthFlowsTypeType]
3. See Sequence[OAuthFlowTypeType]
4. See AnalyticsConfigurationTypeTypeDef
5. See PreventUserExistenceErrorTypesType
6. See RefreshTokenRotationTypeTypeDef

UserPoolClientTypeTypeDef

# UserPoolClientTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserPoolClientTypeTypeDef


def get_value() -> UserPoolClientTypeTypeDef:
    return {
        "UserPoolId": ...,
    }


# UserPoolClientTypeTypeDef definition

class UserPoolClientTypeTypeDef(TypedDict):
    UserPoolId: NotRequired[str],
    ClientName: NotRequired[str],
    ClientId: NotRequired[str],
    ClientSecret: NotRequired[str],
    LastModifiedDate: NotRequired[datetime.datetime],
    CreationDate: NotRequired[datetime.datetime],
    RefreshTokenValidity: NotRequired[int],
    AccessTokenValidity: NotRequired[int],
    IdTokenValidity: NotRequired[int],
    TokenValidityUnits: NotRequired[TokenValidityUnitsTypeTypeDef],  # (1)
    ReadAttributes: NotRequired[List[str]],
    WriteAttributes: NotRequired[List[str]],
    ExplicitAuthFlows: NotRequired[List[ExplicitAuthFlowsTypeType]],  # (2)
    SupportedIdentityProviders: NotRequired[List[str]],
    CallbackURLs: NotRequired[List[str]],
    LogoutURLs: NotRequired[List[str]],
    DefaultRedirectURI: NotRequired[str],
    AllowedOAuthFlows: NotRequired[List[OAuthFlowTypeType]],  # (3)
    AllowedOAuthScopes: NotRequired[List[str]],
    AllowedOAuthFlowsUserPoolClient: NotRequired[bool],
    AnalyticsConfiguration: NotRequired[AnalyticsConfigurationTypeTypeDef],  # (4)
    PreventUserExistenceErrors: NotRequired[PreventUserExistenceErrorTypesType],  # (5)
    EnableTokenRevocation: NotRequired[bool],
    EnablePropagateAdditionalUserContextData: NotRequired[bool],
    AuthSessionValidity: NotRequired[int],
    RefreshTokenRotation: NotRequired[RefreshTokenRotationTypeTypeDef],  # (6)

1. See TokenValidityUnitsTypeTypeDef
2. See List[ExplicitAuthFlowsTypeType]
3. See List[OAuthFlowTypeType]
4. See AnalyticsConfigurationTypeTypeDef
5. See PreventUserExistenceErrorTypesType
6. See RefreshTokenRotationTypeTypeDef

CreateUserPoolDomainRequestTypeDef

# CreateUserPoolDomainRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserPoolDomainRequestTypeDef


def get_value() -> CreateUserPoolDomainRequestTypeDef:
    return {
        "Domain": ...,
    }


# CreateUserPoolDomainRequestTypeDef definition

class CreateUserPoolDomainRequestTypeDef(TypedDict):
    Domain: str,
    UserPoolId: str,
    ManagedLoginVersion: NotRequired[int],
    CustomDomainConfig: NotRequired[CustomDomainConfigTypeTypeDef],  # (1)

1. See CustomDomainConfigTypeTypeDef

DomainDescriptionTypeTypeDef

# DomainDescriptionTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DomainDescriptionTypeTypeDef


def get_value() -> DomainDescriptionTypeTypeDef:
    return {
        "UserPoolId": ...,
    }


# DomainDescriptionTypeTypeDef definition

class DomainDescriptionTypeTypeDef(TypedDict):
    UserPoolId: NotRequired[str],
    AWSAccountId: NotRequired[str],
    Domain: NotRequired[str],
    S3Bucket: NotRequired[str],
    CloudFrontDistribution: NotRequired[str],
    Version: NotRequired[str],
    Status: NotRequired[DomainStatusTypeType],  # (1)
    CustomDomainConfig: NotRequired[CustomDomainConfigTypeTypeDef],  # (2)
    ManagedLoginVersion: NotRequired[int],

1. See DomainStatusTypeType
2. See CustomDomainConfigTypeTypeDef

UpdateUserPoolDomainRequestTypeDef

# UpdateUserPoolDomainRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserPoolDomainRequestTypeDef


def get_value() -> UpdateUserPoolDomainRequestTypeDef:
    return {
        "Domain": ...,
    }


# UpdateUserPoolDomainRequestTypeDef definition

class UpdateUserPoolDomainRequestTypeDef(TypedDict):
    Domain: str,
    UserPoolId: str,
    ManagedLoginVersion: NotRequired[int],
    CustomDomainConfig: NotRequired[CustomDomainConfigTypeTypeDef],  # (1)

1. See CustomDomainConfigTypeTypeDef

SmsMfaConfigTypeTypeDef

# SmsMfaConfigTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SmsMfaConfigTypeTypeDef


def get_value() -> SmsMfaConfigTypeTypeDef:
    return {
        "SmsAuthenticationMessage": ...,
    }


# SmsMfaConfigTypeTypeDef definition

class SmsMfaConfigTypeTypeDef(TypedDict):
    SmsAuthenticationMessage: NotRequired[str],
    SmsConfiguration: NotRequired[SmsConfigurationTypeTypeDef],  # (1)

1. See SmsConfigurationTypeTypeDef

GetUICustomizationResponseTypeDef

# GetUICustomizationResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetUICustomizationResponseTypeDef


def get_value() -> GetUICustomizationResponseTypeDef:
    return {
        "UICustomization": ...,
    }


# GetUICustomizationResponseTypeDef definition

class GetUICustomizationResponseTypeDef(TypedDict):
    UICustomization: UICustomizationTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UICustomizationTypeTypeDef
2. See ResponseMetadataTypeDef

SetUICustomizationResponseTypeDef

# SetUICustomizationResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SetUICustomizationResponseTypeDef


def get_value() -> SetUICustomizationResponseTypeDef:
    return {
        "UICustomization": ...,
    }


# SetUICustomizationResponseTypeDef definition

class SetUICustomizationResponseTypeDef(TypedDict):
    UICustomization: UICustomizationTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UICustomizationTypeTypeDef
2. See ResponseMetadataTypeDef

LambdaConfigTypeTypeDef

# LambdaConfigTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import LambdaConfigTypeTypeDef


def get_value() -> LambdaConfigTypeTypeDef:
    return {
        "PreSignUp": ...,
    }


# LambdaConfigTypeTypeDef definition

class LambdaConfigTypeTypeDef(TypedDict):
    PreSignUp: NotRequired[str],
    CustomMessage: NotRequired[str],
    PostConfirmation: NotRequired[str],
    PreAuthentication: NotRequired[str],
    PostAuthentication: NotRequired[str],
    DefineAuthChallenge: NotRequired[str],
    CreateAuthChallenge: NotRequired[str],
    VerifyAuthChallengeResponse: NotRequired[str],
    PreTokenGeneration: NotRequired[str],
    UserMigration: NotRequired[str],
    PreTokenGenerationConfig: NotRequired[PreTokenGenerationVersionConfigTypeTypeDef],  # (1)
    CustomSMSSender: NotRequired[CustomSMSLambdaVersionConfigTypeTypeDef],  # (2)
    CustomEmailSender: NotRequired[CustomEmailLambdaVersionConfigTypeTypeDef],  # (3)
    KMSKeyID: NotRequired[str],

1. See PreTokenGenerationVersionConfigTypeTypeDef
2. See CustomSMSLambdaVersionConfigTypeTypeDef
3. See CustomEmailLambdaVersionConfigTypeTypeDef

ListIdentityProvidersResponseTypeDef

# ListIdentityProvidersResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListIdentityProvidersResponseTypeDef


def get_value() -> ListIdentityProvidersResponseTypeDef:
    return {
        "Providers": ...,
    }


# ListIdentityProvidersResponseTypeDef definition

class ListIdentityProvidersResponseTypeDef(TypedDict):
    Providers: List[ProviderDescriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[ProviderDescriptionTypeDef]
2. See ResponseMetadataTypeDef

ListUserPoolClientsResponseTypeDef

# ListUserPoolClientsResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUserPoolClientsResponseTypeDef


def get_value() -> ListUserPoolClientsResponseTypeDef:
    return {
        "UserPoolClients": ...,
    }


# ListUserPoolClientsResponseTypeDef definition

class ListUserPoolClientsResponseTypeDef(TypedDict):
    UserPoolClients: List[UserPoolClientDescriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[UserPoolClientDescriptionTypeDef]
2. See ResponseMetadataTypeDef

ListWebAuthnCredentialsResponseTypeDef

# ListWebAuthnCredentialsResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListWebAuthnCredentialsResponseTypeDef


def get_value() -> ListWebAuthnCredentialsResponseTypeDef:
    return {
        "Credentials": ...,
    }


# ListWebAuthnCredentialsResponseTypeDef definition

class ListWebAuthnCredentialsResponseTypeDef(TypedDict):
    Credentials: List[WebAuthnCredentialDescriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[WebAuthnCredentialDescriptionTypeDef]
2. See ResponseMetadataTypeDef

LogConfigurationTypeTypeDef

# LogConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import LogConfigurationTypeTypeDef


def get_value() -> LogConfigurationTypeTypeDef:
    return {
        "LogLevel": ...,
    }


# LogConfigurationTypeTypeDef definition

class LogConfigurationTypeTypeDef(TypedDict):
    LogLevel: LogLevelType,  # (1)
    EventSource: EventSourceNameType,  # (2)
    CloudWatchLogsConfiguration: NotRequired[CloudWatchLogsConfigurationTypeTypeDef],  # (3)
    S3Configuration: NotRequired[S3ConfigurationTypeTypeDef],  # (4)
    FirehoseConfiguration: NotRequired[FirehoseConfigurationTypeTypeDef],  # (5)

1. See LogLevelType
2. See EventSourceNameType
3. See CloudWatchLogsConfigurationTypeTypeDef
4. See S3ConfigurationTypeTypeDef
5. See FirehoseConfigurationTypeTypeDef

NotifyConfigurationTypeTypeDef

# NotifyConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import NotifyConfigurationTypeTypeDef


def get_value() -> NotifyConfigurationTypeTypeDef:
    return {
        "From": ...,
    }


# NotifyConfigurationTypeTypeDef definition

class NotifyConfigurationTypeTypeDef(TypedDict):
    SourceArn: str,
    From: NotRequired[str],
    ReplyTo: NotRequired[str],
    BlockEmail: NotRequired[NotifyEmailTypeTypeDef],  # (1)
    NoActionEmail: NotRequired[NotifyEmailTypeTypeDef],  # (1)
    MfaEmail: NotRequired[NotifyEmailTypeTypeDef],  # (1)

1. See NotifyEmailTypeTypeDef
2. See NotifyEmailTypeTypeDef
3. See NotifyEmailTypeTypeDef

SchemaAttributeTypeTypeDef

# SchemaAttributeTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SchemaAttributeTypeTypeDef


def get_value() -> SchemaAttributeTypeTypeDef:
    return {
        "Name": ...,
    }


# SchemaAttributeTypeTypeDef definition

class SchemaAttributeTypeTypeDef(TypedDict):
    Name: NotRequired[str],
    AttributeDataType: NotRequired[AttributeDataTypeType],  # (1)
    DeveloperOnlyAttribute: NotRequired[bool],
    Mutable: NotRequired[bool],
    Required: NotRequired[bool],
    NumberAttributeConstraints: NotRequired[NumberAttributeConstraintsTypeTypeDef],  # (2)
    StringAttributeConstraints: NotRequired[StringAttributeConstraintsTypeTypeDef],  # (3)

1. See AttributeDataTypeType
2. See NumberAttributeConstraintsTypeTypeDef
3. See StringAttributeConstraintsTypeTypeDef

UserPoolPolicyTypeOutputTypeDef

# UserPoolPolicyTypeOutputTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserPoolPolicyTypeOutputTypeDef


def get_value() -> UserPoolPolicyTypeOutputTypeDef:
    return {
        "PasswordPolicy": ...,
    }


# UserPoolPolicyTypeOutputTypeDef definition

class UserPoolPolicyTypeOutputTypeDef(TypedDict):
    PasswordPolicy: NotRequired[PasswordPolicyTypeTypeDef],  # (1)
    SignInPolicy: NotRequired[SignInPolicyTypeOutputTypeDef],  # (2)

1. See PasswordPolicyTypeTypeDef
2. See SignInPolicyTypeOutputTypeDef

UserPoolPolicyTypeTypeDef

# UserPoolPolicyTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserPoolPolicyTypeTypeDef


def get_value() -> UserPoolPolicyTypeTypeDef:
    return {
        "PasswordPolicy": ...,
    }


# UserPoolPolicyTypeTypeDef definition

class UserPoolPolicyTypeTypeDef(TypedDict):
    PasswordPolicy: NotRequired[PasswordPolicyTypeTypeDef],  # (1)
    SignInPolicy: NotRequired[SignInPolicyTypeTypeDef],  # (2)

1. See PasswordPolicyTypeTypeDef
2. See SignInPolicyTypeTypeDef

AdminGetDeviceResponseTypeDef

# AdminGetDeviceResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminGetDeviceResponseTypeDef


def get_value() -> AdminGetDeviceResponseTypeDef:
    return {
        "Device": ...,
    }


# AdminGetDeviceResponseTypeDef definition

class AdminGetDeviceResponseTypeDef(TypedDict):
    Device: DeviceTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DeviceTypeTypeDef
2. See ResponseMetadataTypeDef

AdminListDevicesResponseTypeDef

# AdminListDevicesResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminListDevicesResponseTypeDef


def get_value() -> AdminListDevicesResponseTypeDef:
    return {
        "Devices": ...,
    }


# AdminListDevicesResponseTypeDef definition

class AdminListDevicesResponseTypeDef(TypedDict):
    Devices: List[DeviceTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    PaginationToken: NotRequired[str],

1. See List[DeviceTypeTypeDef]
2. See ResponseMetadataTypeDef

GetDeviceResponseTypeDef

# GetDeviceResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetDeviceResponseTypeDef


def get_value() -> GetDeviceResponseTypeDef:
    return {
        "Device": ...,
    }


# GetDeviceResponseTypeDef definition

class GetDeviceResponseTypeDef(TypedDict):
    Device: DeviceTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DeviceTypeTypeDef
2. See ResponseMetadataTypeDef

ListDevicesResponseTypeDef

# ListDevicesResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListDevicesResponseTypeDef


def get_value() -> ListDevicesResponseTypeDef:
    return {
        "Devices": ...,
    }


# ListDevicesResponseTypeDef definition

class ListDevicesResponseTypeDef(TypedDict):
    Devices: List[DeviceTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    PaginationToken: NotRequired[str],

1. See List[DeviceTypeTypeDef]
2. See ResponseMetadataTypeDef

AdminCreateUserResponseTypeDef

# AdminCreateUserResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminCreateUserResponseTypeDef


def get_value() -> AdminCreateUserResponseTypeDef:
    return {
        "User": ...,
    }


# AdminCreateUserResponseTypeDef definition

class AdminCreateUserResponseTypeDef(TypedDict):
    User: UserTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserTypeTypeDef
2. See ResponseMetadataTypeDef

ListUsersInGroupResponseTypeDef

# ListUsersInGroupResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersInGroupResponseTypeDef


def get_value() -> ListUsersInGroupResponseTypeDef:
    return {
        "Users": ...,
    }


# ListUsersInGroupResponseTypeDef definition

class ListUsersInGroupResponseTypeDef(TypedDict):
    Users: List[UserTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[UserTypeTypeDef]
2. See ResponseMetadataTypeDef

ListUsersResponseTypeDef

# ListUsersResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersResponseTypeDef


def get_value() -> ListUsersResponseTypeDef:
    return {
        "Users": ...,
    }


# ListUsersResponseTypeDef definition

class ListUsersResponseTypeDef(TypedDict):
    Users: List[UserTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    PaginationToken: NotRequired[str],

1. See List[UserTypeTypeDef]
2. See ResponseMetadataTypeDef

CreateManagedLoginBrandingResponseTypeDef

# CreateManagedLoginBrandingResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateManagedLoginBrandingResponseTypeDef


def get_value() -> CreateManagedLoginBrandingResponseTypeDef:
    return {
        "ManagedLoginBranding": ...,
    }


# CreateManagedLoginBrandingResponseTypeDef definition

class CreateManagedLoginBrandingResponseTypeDef(TypedDict):
    ManagedLoginBranding: ManagedLoginBrandingTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ManagedLoginBrandingTypeTypeDef
2. See ResponseMetadataTypeDef

DescribeManagedLoginBrandingByClientResponseTypeDef

# DescribeManagedLoginBrandingByClientResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeManagedLoginBrandingByClientResponseTypeDef


def get_value() -> DescribeManagedLoginBrandingByClientResponseTypeDef:
    return {
        "ManagedLoginBranding": ...,
    }


# DescribeManagedLoginBrandingByClientResponseTypeDef definition

class DescribeManagedLoginBrandingByClientResponseTypeDef(TypedDict):
    ManagedLoginBranding: ManagedLoginBrandingTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ManagedLoginBrandingTypeTypeDef
2. See ResponseMetadataTypeDef

DescribeManagedLoginBrandingResponseTypeDef

# DescribeManagedLoginBrandingResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeManagedLoginBrandingResponseTypeDef


def get_value() -> DescribeManagedLoginBrandingResponseTypeDef:
    return {
        "ManagedLoginBranding": ...,
    }


# DescribeManagedLoginBrandingResponseTypeDef definition

class DescribeManagedLoginBrandingResponseTypeDef(TypedDict):
    ManagedLoginBranding: ManagedLoginBrandingTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ManagedLoginBrandingTypeTypeDef
2. See ResponseMetadataTypeDef

UpdateManagedLoginBrandingResponseTypeDef

# UpdateManagedLoginBrandingResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateManagedLoginBrandingResponseTypeDef


def get_value() -> UpdateManagedLoginBrandingResponseTypeDef:
    return {
        "ManagedLoginBranding": ...,
    }


# UpdateManagedLoginBrandingResponseTypeDef definition

class UpdateManagedLoginBrandingResponseTypeDef(TypedDict):
    ManagedLoginBranding: ManagedLoginBrandingTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ManagedLoginBrandingTypeTypeDef
2. See ResponseMetadataTypeDef

AdminListUserAuthEventsResponseTypeDef

# AdminListUserAuthEventsResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminListUserAuthEventsResponseTypeDef


def get_value() -> AdminListUserAuthEventsResponseTypeDef:
    return {
        "AuthEvents": ...,
    }


# AdminListUserAuthEventsResponseTypeDef definition

class AdminListUserAuthEventsResponseTypeDef(TypedDict):
    AuthEvents: List[AuthEventTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[AuthEventTypeTypeDef]
2. See ResponseMetadataTypeDef

AdminInitiateAuthResponseTypeDef

# AdminInitiateAuthResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminInitiateAuthResponseTypeDef


def get_value() -> AdminInitiateAuthResponseTypeDef:
    return {
        "ChallengeName": ...,
    }


# AdminInitiateAuthResponseTypeDef definition

class AdminInitiateAuthResponseTypeDef(TypedDict):
    ChallengeName: ChallengeNameTypeType,  # (1)
    Session: str,
    ChallengeParameters: Dict[str, str],
    AuthenticationResult: AuthenticationResultTypeTypeDef,  # (2)
    AvailableChallenges: List[ChallengeNameTypeType],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See ChallengeNameTypeType
2. See AuthenticationResultTypeTypeDef
3. See List[ChallengeNameTypeType]
4. See ResponseMetadataTypeDef

AdminRespondToAuthChallengeResponseTypeDef

# AdminRespondToAuthChallengeResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminRespondToAuthChallengeResponseTypeDef


def get_value() -> AdminRespondToAuthChallengeResponseTypeDef:
    return {
        "ChallengeName": ...,
    }


# AdminRespondToAuthChallengeResponseTypeDef definition

class AdminRespondToAuthChallengeResponseTypeDef(TypedDict):
    ChallengeName: ChallengeNameTypeType,  # (1)
    Session: str,
    ChallengeParameters: Dict[str, str],
    AuthenticationResult: AuthenticationResultTypeTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See ChallengeNameTypeType
2. See AuthenticationResultTypeTypeDef
3. See ResponseMetadataTypeDef

GetTokensFromRefreshTokenResponseTypeDef

# GetTokensFromRefreshTokenResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetTokensFromRefreshTokenResponseTypeDef


def get_value() -> GetTokensFromRefreshTokenResponseTypeDef:
    return {
        "AuthenticationResult": ...,
    }


# GetTokensFromRefreshTokenResponseTypeDef definition

class GetTokensFromRefreshTokenResponseTypeDef(TypedDict):
    AuthenticationResult: AuthenticationResultTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See AuthenticationResultTypeTypeDef
2. See ResponseMetadataTypeDef

InitiateAuthResponseTypeDef

# InitiateAuthResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import InitiateAuthResponseTypeDef


def get_value() -> InitiateAuthResponseTypeDef:
    return {
        "ChallengeName": ...,
    }


# InitiateAuthResponseTypeDef definition

class InitiateAuthResponseTypeDef(TypedDict):
    ChallengeName: ChallengeNameTypeType,  # (1)
    Session: str,
    ChallengeParameters: Dict[str, str],
    AuthenticationResult: AuthenticationResultTypeTypeDef,  # (2)
    AvailableChallenges: List[ChallengeNameTypeType],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See ChallengeNameTypeType
2. See AuthenticationResultTypeTypeDef
3. See List[ChallengeNameTypeType]
4. See ResponseMetadataTypeDef

RespondToAuthChallengeResponseTypeDef

# RespondToAuthChallengeResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import RespondToAuthChallengeResponseTypeDef


def get_value() -> RespondToAuthChallengeResponseTypeDef:
    return {
        "ChallengeName": ...,
    }


# RespondToAuthChallengeResponseTypeDef definition

class RespondToAuthChallengeResponseTypeDef(TypedDict):
    ChallengeName: ChallengeNameTypeType,  # (1)
    Session: str,
    ChallengeParameters: Dict[str, str],
    AuthenticationResult: AuthenticationResultTypeTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See ChallengeNameTypeType
2. See AuthenticationResultTypeTypeDef
3. See ResponseMetadataTypeDef

AdminInitiateAuthRequestTypeDef

# AdminInitiateAuthRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminInitiateAuthRequestTypeDef


def get_value() -> AdminInitiateAuthRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminInitiateAuthRequestTypeDef definition

class AdminInitiateAuthRequestTypeDef(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)
    Session: NotRequired[str],

1. See AuthFlowTypeType
2. See AnalyticsMetadataTypeTypeDef
3. See ContextDataTypeTypeDef

AdminRespondToAuthChallengeRequestTypeDef

# AdminRespondToAuthChallengeRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AdminRespondToAuthChallengeRequestTypeDef


def get_value() -> AdminRespondToAuthChallengeRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AdminRespondToAuthChallengeRequestTypeDef definition

class AdminRespondToAuthChallengeRequestTypeDef(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]],

1. See ChallengeNameTypeType
2. See AnalyticsMetadataTypeTypeDef
3. See ContextDataTypeTypeDef

CreateResourceServerResponseTypeDef

# CreateResourceServerResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateResourceServerResponseTypeDef


def get_value() -> CreateResourceServerResponseTypeDef:
    return {
        "ResourceServer": ...,
    }


# CreateResourceServerResponseTypeDef definition

class CreateResourceServerResponseTypeDef(TypedDict):
    ResourceServer: ResourceServerTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ResourceServerTypeTypeDef
2. See ResponseMetadataTypeDef

DescribeResourceServerResponseTypeDef

# DescribeResourceServerResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeResourceServerResponseTypeDef


def get_value() -> DescribeResourceServerResponseTypeDef:
    return {
        "ResourceServer": ...,
    }


# DescribeResourceServerResponseTypeDef definition

class DescribeResourceServerResponseTypeDef(TypedDict):
    ResourceServer: ResourceServerTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ResourceServerTypeTypeDef
2. See ResponseMetadataTypeDef

ListResourceServersResponseTypeDef

# ListResourceServersResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListResourceServersResponseTypeDef


def get_value() -> ListResourceServersResponseTypeDef:
    return {
        "ResourceServers": ...,
    }


# ListResourceServersResponseTypeDef definition

class ListResourceServersResponseTypeDef(TypedDict):
    ResourceServers: List[ResourceServerTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[ResourceServerTypeTypeDef]
2. See ResponseMetadataTypeDef

UpdateResourceServerResponseTypeDef

# UpdateResourceServerResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateResourceServerResponseTypeDef


def get_value() -> UpdateResourceServerResponseTypeDef:
    return {
        "ResourceServer": ...,
    }


# UpdateResourceServerResponseTypeDef definition

class UpdateResourceServerResponseTypeDef(TypedDict):
    ResourceServer: ResourceServerTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ResourceServerTypeTypeDef
2. See ResponseMetadataTypeDef

CreateUserPoolClientResponseTypeDef

# CreateUserPoolClientResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserPoolClientResponseTypeDef


def get_value() -> CreateUserPoolClientResponseTypeDef:
    return {
        "UserPoolClient": ...,
    }


# CreateUserPoolClientResponseTypeDef definition

class CreateUserPoolClientResponseTypeDef(TypedDict):
    UserPoolClient: UserPoolClientTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserPoolClientTypeTypeDef
2. See ResponseMetadataTypeDef

DescribeUserPoolClientResponseTypeDef

# DescribeUserPoolClientResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserPoolClientResponseTypeDef


def get_value() -> DescribeUserPoolClientResponseTypeDef:
    return {
        "UserPoolClient": ...,
    }


# DescribeUserPoolClientResponseTypeDef definition

class DescribeUserPoolClientResponseTypeDef(TypedDict):
    UserPoolClient: UserPoolClientTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserPoolClientTypeTypeDef
2. See ResponseMetadataTypeDef

UpdateUserPoolClientResponseTypeDef

# UpdateUserPoolClientResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserPoolClientResponseTypeDef


def get_value() -> UpdateUserPoolClientResponseTypeDef:
    return {
        "UserPoolClient": ...,
    }


# UpdateUserPoolClientResponseTypeDef definition

class UpdateUserPoolClientResponseTypeDef(TypedDict):
    UserPoolClient: UserPoolClientTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserPoolClientTypeTypeDef
2. See ResponseMetadataTypeDef

DescribeUserPoolDomainResponseTypeDef

# DescribeUserPoolDomainResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserPoolDomainResponseTypeDef


def get_value() -> DescribeUserPoolDomainResponseTypeDef:
    return {
        "DomainDescription": ...,
    }


# DescribeUserPoolDomainResponseTypeDef definition

class DescribeUserPoolDomainResponseTypeDef(TypedDict):
    DomainDescription: DomainDescriptionTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DomainDescriptionTypeTypeDef
2. See ResponseMetadataTypeDef

GetUserPoolMfaConfigResponseTypeDef

# GetUserPoolMfaConfigResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetUserPoolMfaConfigResponseTypeDef


def get_value() -> GetUserPoolMfaConfigResponseTypeDef:
    return {
        "SmsMfaConfiguration": ...,
    }


# GetUserPoolMfaConfigResponseTypeDef definition

class GetUserPoolMfaConfigResponseTypeDef(TypedDict):
    SmsMfaConfiguration: SmsMfaConfigTypeTypeDef,  # (1)
    SoftwareTokenMfaConfiguration: SoftwareTokenMfaConfigTypeTypeDef,  # (2)
    EmailMfaConfiguration: EmailMfaConfigTypeTypeDef,  # (3)
    MfaConfiguration: UserPoolMfaTypeType,  # (4)
    WebAuthnConfiguration: WebAuthnConfigurationTypeTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

1. See SmsMfaConfigTypeTypeDef
2. See SoftwareTokenMfaConfigTypeTypeDef
3. See EmailMfaConfigTypeTypeDef
4. See UserPoolMfaTypeType
5. See WebAuthnConfigurationTypeTypeDef
6. See ResponseMetadataTypeDef

SetUserPoolMfaConfigRequestTypeDef

# SetUserPoolMfaConfigRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SetUserPoolMfaConfigRequestTypeDef


def get_value() -> SetUserPoolMfaConfigRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# SetUserPoolMfaConfigRequestTypeDef definition

class SetUserPoolMfaConfigRequestTypeDef(TypedDict):
    UserPoolId: str,
    SmsMfaConfiguration: NotRequired[SmsMfaConfigTypeTypeDef],  # (1)
    SoftwareTokenMfaConfiguration: NotRequired[SoftwareTokenMfaConfigTypeTypeDef],  # (2)
    EmailMfaConfiguration: NotRequired[EmailMfaConfigTypeTypeDef],  # (3)
    MfaConfiguration: NotRequired[UserPoolMfaTypeType],  # (4)
    WebAuthnConfiguration: NotRequired[WebAuthnConfigurationTypeTypeDef],  # (5)

1. See SmsMfaConfigTypeTypeDef
2. See SoftwareTokenMfaConfigTypeTypeDef
3. See EmailMfaConfigTypeTypeDef
4. See UserPoolMfaTypeType
5. See WebAuthnConfigurationTypeTypeDef

SetUserPoolMfaConfigResponseTypeDef

# SetUserPoolMfaConfigResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SetUserPoolMfaConfigResponseTypeDef


def get_value() -> SetUserPoolMfaConfigResponseTypeDef:
    return {
        "SmsMfaConfiguration": ...,
    }


# SetUserPoolMfaConfigResponseTypeDef definition

class SetUserPoolMfaConfigResponseTypeDef(TypedDict):
    SmsMfaConfiguration: SmsMfaConfigTypeTypeDef,  # (1)
    SoftwareTokenMfaConfiguration: SoftwareTokenMfaConfigTypeTypeDef,  # (2)
    EmailMfaConfiguration: EmailMfaConfigTypeTypeDef,  # (3)
    MfaConfiguration: UserPoolMfaTypeType,  # (4)
    WebAuthnConfiguration: WebAuthnConfigurationTypeTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

1. See SmsMfaConfigTypeTypeDef
2. See SoftwareTokenMfaConfigTypeTypeDef
3. See EmailMfaConfigTypeTypeDef
4. See UserPoolMfaTypeType
5. See WebAuthnConfigurationTypeTypeDef
6. See ResponseMetadataTypeDef

UserPoolDescriptionTypeTypeDef

# UserPoolDescriptionTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserPoolDescriptionTypeTypeDef


def get_value() -> UserPoolDescriptionTypeTypeDef:
    return {
        "Id": ...,
    }


# UserPoolDescriptionTypeTypeDef definition

class UserPoolDescriptionTypeTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    LambdaConfig: NotRequired[LambdaConfigTypeTypeDef],  # (1)
    Status: NotRequired[StatusTypeType],  # (2)
    LastModifiedDate: NotRequired[datetime.datetime],
    CreationDate: NotRequired[datetime.datetime],

1. See LambdaConfigTypeTypeDef
2. See StatusTypeType

LogDeliveryConfigurationTypeTypeDef

# LogDeliveryConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import LogDeliveryConfigurationTypeTypeDef


def get_value() -> LogDeliveryConfigurationTypeTypeDef:
    return {
        "UserPoolId": ...,
    }


# LogDeliveryConfigurationTypeTypeDef definition

class LogDeliveryConfigurationTypeTypeDef(TypedDict):
    UserPoolId: str,
    LogConfigurations: List[LogConfigurationTypeTypeDef],  # (1)

1. See List[LogConfigurationTypeTypeDef]

SetLogDeliveryConfigurationRequestTypeDef

# SetLogDeliveryConfigurationRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SetLogDeliveryConfigurationRequestTypeDef


def get_value() -> SetLogDeliveryConfigurationRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# SetLogDeliveryConfigurationRequestTypeDef definition

class SetLogDeliveryConfigurationRequestTypeDef(TypedDict):
    UserPoolId: str,
    LogConfigurations: Sequence[LogConfigurationTypeTypeDef],  # (1)

1. See Sequence[LogConfigurationTypeTypeDef]

AccountTakeoverRiskConfigurationTypeTypeDef

# AccountTakeoverRiskConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AccountTakeoverRiskConfigurationTypeTypeDef


def get_value() -> AccountTakeoverRiskConfigurationTypeTypeDef:
    return {
        "NotifyConfiguration": ...,
    }


# AccountTakeoverRiskConfigurationTypeTypeDef definition

class AccountTakeoverRiskConfigurationTypeTypeDef(TypedDict):
    Actions: AccountTakeoverActionsTypeTypeDef,  # (2)
    NotifyConfiguration: NotRequired[NotifyConfigurationTypeTypeDef],  # (1)

1. See NotifyConfigurationTypeTypeDef
2. See AccountTakeoverActionsTypeTypeDef

AddCustomAttributesRequestTypeDef

# AddCustomAttributesRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import AddCustomAttributesRequestTypeDef


def get_value() -> AddCustomAttributesRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# AddCustomAttributesRequestTypeDef definition

class AddCustomAttributesRequestTypeDef(TypedDict):
    UserPoolId: str,
    CustomAttributes: Sequence[SchemaAttributeTypeTypeDef],  # (1)

1. See Sequence[SchemaAttributeTypeTypeDef]

UserPoolTypeTypeDef

# UserPoolTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UserPoolTypeTypeDef


def get_value() -> UserPoolTypeTypeDef:
    return {
        "Id": ...,
    }


# UserPoolTypeTypeDef definition

class UserPoolTypeTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    Policies: NotRequired[UserPoolPolicyTypeOutputTypeDef],  # (1)
    DeletionProtection: NotRequired[DeletionProtectionTypeType],  # (2)
    LambdaConfig: NotRequired[LambdaConfigTypeTypeDef],  # (3)
    Status: NotRequired[StatusTypeType],  # (4)
    LastModifiedDate: NotRequired[datetime.datetime],
    CreationDate: NotRequired[datetime.datetime],
    SchemaAttributes: NotRequired[List[SchemaAttributeTypeTypeDef]],  # (5)
    AutoVerifiedAttributes: NotRequired[List[VerifiedAttributeTypeType]],  # (6)
    AliasAttributes: NotRequired[List[AliasAttributeTypeType]],  # (7)
    UsernameAttributes: NotRequired[List[UsernameAttributeTypeType]],  # (8)
    SmsVerificationMessage: NotRequired[str],
    EmailVerificationMessage: NotRequired[str],
    EmailVerificationSubject: NotRequired[str],
    VerificationMessageTemplate: NotRequired[VerificationMessageTemplateTypeTypeDef],  # (9)
    SmsAuthenticationMessage: NotRequired[str],
    UserAttributeUpdateSettings: NotRequired[UserAttributeUpdateSettingsTypeOutputTypeDef],  # (10)
    MfaConfiguration: NotRequired[UserPoolMfaTypeType],  # (11)
    DeviceConfiguration: NotRequired[DeviceConfigurationTypeTypeDef],  # (12)
    EstimatedNumberOfUsers: NotRequired[int],
    EmailConfiguration: NotRequired[EmailConfigurationTypeTypeDef],  # (13)
    SmsConfiguration: NotRequired[SmsConfigurationTypeTypeDef],  # (14)
    UserPoolTags: NotRequired[Dict[str, str]],
    SmsConfigurationFailure: NotRequired[str],
    EmailConfigurationFailure: NotRequired[str],
    Domain: NotRequired[str],
    CustomDomain: NotRequired[str],
    AdminCreateUserConfig: NotRequired[AdminCreateUserConfigTypeTypeDef],  # (15)
    UserPoolAddOns: NotRequired[UserPoolAddOnsTypeTypeDef],  # (16)
    UsernameConfiguration: NotRequired[UsernameConfigurationTypeTypeDef],  # (17)
    Arn: NotRequired[str],
    AccountRecoverySetting: NotRequired[AccountRecoverySettingTypeOutputTypeDef],  # (18)
    UserPoolTier: NotRequired[UserPoolTierTypeType],  # (19)

1. See UserPoolPolicyTypeOutputTypeDef
2. See DeletionProtectionTypeType
3. See LambdaConfigTypeTypeDef
4. See StatusTypeType
5. See List[SchemaAttributeTypeTypeDef]
6. See List[VerifiedAttributeTypeType]
7. See List[AliasAttributeTypeType]
8. See List[UsernameAttributeTypeType]
9. See VerificationMessageTemplateTypeTypeDef
10. See UserAttributeUpdateSettingsTypeOutputTypeDef
11. See UserPoolMfaTypeType
12. See DeviceConfigurationTypeTypeDef
13. See EmailConfigurationTypeTypeDef
14. See SmsConfigurationTypeTypeDef
15. See AdminCreateUserConfigTypeTypeDef
16. See UserPoolAddOnsTypeTypeDef
17. See UsernameConfigurationTypeTypeDef
18. See AccountRecoverySettingTypeOutputTypeDef
19. See UserPoolTierTypeType

CreateManagedLoginBrandingRequestTypeDef

# CreateManagedLoginBrandingRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateManagedLoginBrandingRequestTypeDef


def get_value() -> CreateManagedLoginBrandingRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# CreateManagedLoginBrandingRequestTypeDef definition

class CreateManagedLoginBrandingRequestTypeDef(TypedDict):
    UserPoolId: str,
    ClientId: str,
    UseCognitoProvidedValues: NotRequired[bool],
    Settings: NotRequired[Mapping[str, Any]],
    Assets: NotRequired[Sequence[AssetTypeUnionTypeDef]],  # (1)

1. See Sequence[AssetTypeUnionTypeDef]

UpdateManagedLoginBrandingRequestTypeDef

# UpdateManagedLoginBrandingRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateManagedLoginBrandingRequestTypeDef


def get_value() -> UpdateManagedLoginBrandingRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# UpdateManagedLoginBrandingRequestTypeDef definition

class UpdateManagedLoginBrandingRequestTypeDef(TypedDict):
    UserPoolId: NotRequired[str],
    ManagedLoginBrandingId: NotRequired[str],
    UseCognitoProvidedValues: NotRequired[bool],
    Settings: NotRequired[Mapping[str, Any]],
    Assets: NotRequired[Sequence[AssetTypeUnionTypeDef]],  # (1)

1. See Sequence[AssetTypeUnionTypeDef]

ListUserPoolsResponseTypeDef

# ListUserPoolsResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import ListUserPoolsResponseTypeDef


def get_value() -> ListUserPoolsResponseTypeDef:
    return {
        "UserPools": ...,
    }


# ListUserPoolsResponseTypeDef definition

class ListUserPoolsResponseTypeDef(TypedDict):
    UserPools: List[UserPoolDescriptionTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[UserPoolDescriptionTypeTypeDef]
2. See ResponseMetadataTypeDef

GetLogDeliveryConfigurationResponseTypeDef

# GetLogDeliveryConfigurationResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import GetLogDeliveryConfigurationResponseTypeDef


def get_value() -> GetLogDeliveryConfigurationResponseTypeDef:
    return {
        "LogDeliveryConfiguration": ...,
    }


# GetLogDeliveryConfigurationResponseTypeDef definition

class GetLogDeliveryConfigurationResponseTypeDef(TypedDict):
    LogDeliveryConfiguration: LogDeliveryConfigurationTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LogDeliveryConfigurationTypeTypeDef
2. See ResponseMetadataTypeDef

SetLogDeliveryConfigurationResponseTypeDef

# SetLogDeliveryConfigurationResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SetLogDeliveryConfigurationResponseTypeDef


def get_value() -> SetLogDeliveryConfigurationResponseTypeDef:
    return {
        "LogDeliveryConfiguration": ...,
    }


# SetLogDeliveryConfigurationResponseTypeDef definition

class SetLogDeliveryConfigurationResponseTypeDef(TypedDict):
    LogDeliveryConfiguration: LogDeliveryConfigurationTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LogDeliveryConfigurationTypeTypeDef
2. See ResponseMetadataTypeDef

RiskConfigurationTypeTypeDef

# RiskConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import RiskConfigurationTypeTypeDef


def get_value() -> RiskConfigurationTypeTypeDef:
    return {
        "UserPoolId": ...,
    }


# RiskConfigurationTypeTypeDef definition

class RiskConfigurationTypeTypeDef(TypedDict):
    UserPoolId: NotRequired[str],
    ClientId: NotRequired[str],
    CompromisedCredentialsRiskConfiguration: NotRequired[CompromisedCredentialsRiskConfigurationTypeOutputTypeDef],  # (1)
    AccountTakeoverRiskConfiguration: NotRequired[AccountTakeoverRiskConfigurationTypeTypeDef],  # (2)
    RiskExceptionConfiguration: NotRequired[RiskExceptionConfigurationTypeOutputTypeDef],  # (3)
    LastModifiedDate: NotRequired[datetime.datetime],

1. See CompromisedCredentialsRiskConfigurationTypeOutputTypeDef
2. See AccountTakeoverRiskConfigurationTypeTypeDef
3. See RiskExceptionConfigurationTypeOutputTypeDef

SetRiskConfigurationRequestTypeDef

# SetRiskConfigurationRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SetRiskConfigurationRequestTypeDef


def get_value() -> SetRiskConfigurationRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# SetRiskConfigurationRequestTypeDef definition

class SetRiskConfigurationRequestTypeDef(TypedDict):
    UserPoolId: str,
    ClientId: NotRequired[str],
    CompromisedCredentialsRiskConfiguration: NotRequired[CompromisedCredentialsRiskConfigurationTypeUnionTypeDef],  # (1)
    AccountTakeoverRiskConfiguration: NotRequired[AccountTakeoverRiskConfigurationTypeTypeDef],  # (2)
    RiskExceptionConfiguration: NotRequired[RiskExceptionConfigurationTypeUnionTypeDef],  # (3)

1. See CompromisedCredentialsRiskConfigurationTypeUnionTypeDef
2. See AccountTakeoverRiskConfigurationTypeTypeDef
3. See RiskExceptionConfigurationTypeUnionTypeDef

CreateUserPoolResponseTypeDef

# CreateUserPoolResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserPoolResponseTypeDef


def get_value() -> CreateUserPoolResponseTypeDef:
    return {
        "UserPool": ...,
    }


# CreateUserPoolResponseTypeDef definition

class CreateUserPoolResponseTypeDef(TypedDict):
    UserPool: UserPoolTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserPoolTypeTypeDef
2. See ResponseMetadataTypeDef

DescribeUserPoolResponseTypeDef

# DescribeUserPoolResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserPoolResponseTypeDef


def get_value() -> DescribeUserPoolResponseTypeDef:
    return {
        "UserPool": ...,
    }


# DescribeUserPoolResponseTypeDef definition

class DescribeUserPoolResponseTypeDef(TypedDict):
    UserPool: UserPoolTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserPoolTypeTypeDef
2. See ResponseMetadataTypeDef

CreateUserPoolRequestTypeDef

# CreateUserPoolRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserPoolRequestTypeDef


def get_value() -> CreateUserPoolRequestTypeDef:
    return {
        "PoolName": ...,
    }


# CreateUserPoolRequestTypeDef definition

class CreateUserPoolRequestTypeDef(TypedDict):
    PoolName: str,
    Policies: NotRequired[UserPoolPolicyTypeUnionTypeDef],  # (1)
    DeletionProtection: NotRequired[DeletionProtectionTypeType],  # (2)
    LambdaConfig: NotRequired[LambdaConfigTypeTypeDef],  # (3)
    AutoVerifiedAttributes: NotRequired[Sequence[VerifiedAttributeTypeType]],  # (4)
    AliasAttributes: NotRequired[Sequence[AliasAttributeTypeType]],  # (5)
    UsernameAttributes: NotRequired[Sequence[UsernameAttributeTypeType]],  # (6)
    SmsVerificationMessage: NotRequired[str],
    EmailVerificationMessage: NotRequired[str],
    EmailVerificationSubject: NotRequired[str],
    VerificationMessageTemplate: NotRequired[VerificationMessageTemplateTypeTypeDef],  # (7)
    SmsAuthenticationMessage: NotRequired[str],
    MfaConfiguration: NotRequired[UserPoolMfaTypeType],  # (8)
    UserAttributeUpdateSettings: NotRequired[UserAttributeUpdateSettingsTypeUnionTypeDef],  # (9)
    DeviceConfiguration: NotRequired[DeviceConfigurationTypeTypeDef],  # (10)
    EmailConfiguration: NotRequired[EmailConfigurationTypeTypeDef],  # (11)
    SmsConfiguration: NotRequired[SmsConfigurationTypeTypeDef],  # (12)
    UserPoolTags: NotRequired[Mapping[str, str]],
    AdminCreateUserConfig: NotRequired[AdminCreateUserConfigTypeTypeDef],  # (13)
    Schema: NotRequired[Sequence[SchemaAttributeTypeTypeDef]],  # (14)
    UserPoolAddOns: NotRequired[UserPoolAddOnsTypeTypeDef],  # (15)
    UsernameConfiguration: NotRequired[UsernameConfigurationTypeTypeDef],  # (16)
    AccountRecoverySetting: NotRequired[AccountRecoverySettingTypeUnionTypeDef],  # (17)
    UserPoolTier: NotRequired[UserPoolTierTypeType],  # (18)

1. See UserPoolPolicyTypeUnionTypeDef
2. See DeletionProtectionTypeType
3. See LambdaConfigTypeTypeDef
4. See Sequence[VerifiedAttributeTypeType]
5. See Sequence[AliasAttributeTypeType]
6. See Sequence[UsernameAttributeTypeType]
7. See VerificationMessageTemplateTypeTypeDef
8. See UserPoolMfaTypeType
9. See UserAttributeUpdateSettingsTypeUnionTypeDef
10. See DeviceConfigurationTypeTypeDef
11. See EmailConfigurationTypeTypeDef
12. See SmsConfigurationTypeTypeDef
13. See AdminCreateUserConfigTypeTypeDef
14. See Sequence[SchemaAttributeTypeTypeDef]
15. See UserPoolAddOnsTypeTypeDef
16. See UsernameConfigurationTypeTypeDef
17. See AccountRecoverySettingTypeUnionTypeDef
18. See UserPoolTierTypeType

UpdateUserPoolRequestTypeDef

# UpdateUserPoolRequestTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserPoolRequestTypeDef


def get_value() -> UpdateUserPoolRequestTypeDef:
    return {
        "UserPoolId": ...,
    }


# UpdateUserPoolRequestTypeDef definition

class UpdateUserPoolRequestTypeDef(TypedDict):
    UserPoolId: str,
    Policies: NotRequired[UserPoolPolicyTypeUnionTypeDef],  # (1)
    DeletionProtection: NotRequired[DeletionProtectionTypeType],  # (2)
    LambdaConfig: NotRequired[LambdaConfigTypeTypeDef],  # (3)
    AutoVerifiedAttributes: NotRequired[Sequence[VerifiedAttributeTypeType]],  # (4)
    SmsVerificationMessage: NotRequired[str],
    EmailVerificationMessage: NotRequired[str],
    EmailVerificationSubject: NotRequired[str],
    VerificationMessageTemplate: NotRequired[VerificationMessageTemplateTypeTypeDef],  # (5)
    SmsAuthenticationMessage: NotRequired[str],
    UserAttributeUpdateSettings: NotRequired[UserAttributeUpdateSettingsTypeUnionTypeDef],  # (6)
    MfaConfiguration: NotRequired[UserPoolMfaTypeType],  # (7)
    DeviceConfiguration: NotRequired[DeviceConfigurationTypeTypeDef],  # (8)
    EmailConfiguration: NotRequired[EmailConfigurationTypeTypeDef],  # (9)
    SmsConfiguration: NotRequired[SmsConfigurationTypeTypeDef],  # (10)
    UserPoolTags: NotRequired[Mapping[str, str]],
    AdminCreateUserConfig: NotRequired[AdminCreateUserConfigTypeTypeDef],  # (11)
    UserPoolAddOns: NotRequired[UserPoolAddOnsTypeTypeDef],  # (12)
    AccountRecoverySetting: NotRequired[AccountRecoverySettingTypeUnionTypeDef],  # (13)
    PoolName: NotRequired[str],
    UserPoolTier: NotRequired[UserPoolTierTypeType],  # (14)

1. See UserPoolPolicyTypeUnionTypeDef
2. See DeletionProtectionTypeType
3. See LambdaConfigTypeTypeDef
4. See Sequence[VerifiedAttributeTypeType]
5. See VerificationMessageTemplateTypeTypeDef
6. See UserAttributeUpdateSettingsTypeUnionTypeDef
7. See UserPoolMfaTypeType
8. See DeviceConfigurationTypeTypeDef
9. See EmailConfigurationTypeTypeDef
10. See SmsConfigurationTypeTypeDef
11. See AdminCreateUserConfigTypeTypeDef
12. See UserPoolAddOnsTypeTypeDef
13. See AccountRecoverySettingTypeUnionTypeDef
14. See UserPoolTierTypeType

DescribeRiskConfigurationResponseTypeDef

# DescribeRiskConfigurationResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import DescribeRiskConfigurationResponseTypeDef


def get_value() -> DescribeRiskConfigurationResponseTypeDef:
    return {
        "RiskConfiguration": ...,
    }


# DescribeRiskConfigurationResponseTypeDef definition

class DescribeRiskConfigurationResponseTypeDef(TypedDict):
    RiskConfiguration: RiskConfigurationTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RiskConfigurationTypeTypeDef
2. See ResponseMetadataTypeDef

SetRiskConfigurationResponseTypeDef

# SetRiskConfigurationResponseTypeDef TypedDict usage example

from mypy_boto3_cognito_idp.type_defs import SetRiskConfigurationResponseTypeDef


def get_value() -> SetRiskConfigurationResponseTypeDef:
    return {
        "RiskConfiguration": ...,
    }


# SetRiskConfigurationResponseTypeDef definition

class SetRiskConfigurationResponseTypeDef(TypedDict):
    RiskConfiguration: RiskConfigurationTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RiskConfigurationTypeTypeDef
2. See ResponseMetadataTypeDef