Skip to content

Typed dictionaries#

Index > CognitoIdentityProvider > Typed dictionaries

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

RecoveryOptionTypeTypeDef#

# RecoveryOptionTypeTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import RecoveryOptionTypeTypeDef

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

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

AccountTakeoverActionTypeTypeDef#

# AccountTakeoverActionTypeTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AccountTakeoverActionTypeTypeDef

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

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

AdminAddUserToGroupRequestRequestTypeDef#

# AdminAddUserToGroupRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminAddUserToGroupRequestRequestTypeDef

def get_value() -> AdminAddUserToGroupRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
        "GroupName": ...,
    }
# AdminAddUserToGroupRequestRequestTypeDef definition

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

AdminConfirmSignUpRequestRequestTypeDef#

# AdminConfirmSignUpRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminConfirmSignUpRequestRequestTypeDef

def get_value() -> AdminConfirmSignUpRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminConfirmSignUpRequestRequestTypeDef definition

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

MessageTemplateTypeTypeDef#

# MessageTemplateTypeTypeDef 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 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],

AdminDeleteUserAttributesRequestRequestTypeDef#

# AdminDeleteUserAttributesRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminDeleteUserAttributesRequestRequestTypeDef

def get_value() -> AdminDeleteUserAttributesRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
        "UserAttributeNames": ...,
    }
# AdminDeleteUserAttributesRequestRequestTypeDef definition

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

AdminDeleteUserRequestRequestTypeDef#

# AdminDeleteUserRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminDeleteUserRequestRequestTypeDef

def get_value() -> AdminDeleteUserRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminDeleteUserRequestRequestTypeDef definition

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

ProviderUserIdentifierTypeTypeDef#

# ProviderUserIdentifierTypeTypeDef 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],

AdminDisableUserRequestRequestTypeDef#

# AdminDisableUserRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminDisableUserRequestRequestTypeDef

def get_value() -> AdminDisableUserRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminDisableUserRequestRequestTypeDef definition

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

AdminEnableUserRequestRequestTypeDef#

# AdminEnableUserRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminEnableUserRequestRequestTypeDef

def get_value() -> AdminEnableUserRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminEnableUserRequestRequestTypeDef definition

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

AdminForgetDeviceRequestRequestTypeDef#

# AdminForgetDeviceRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminForgetDeviceRequestRequestTypeDef

def get_value() -> AdminForgetDeviceRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
        "DeviceKey": ...,
    }
# AdminForgetDeviceRequestRequestTypeDef definition

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

AdminGetDeviceRequestRequestTypeDef#

# AdminGetDeviceRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminGetDeviceRequestRequestTypeDef

def get_value() -> AdminGetDeviceRequestRequestTypeDef:
    return {
        "DeviceKey": ...,
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminGetDeviceRequestRequestTypeDef definition

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

AdminGetUserRequestRequestTypeDef#

# AdminGetUserRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminGetUserRequestRequestTypeDef

def get_value() -> AdminGetUserRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminGetUserRequestRequestTypeDef definition

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

MFAOptionTypeTypeDef#

# MFAOptionTypeTypeDef 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 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],

AdminListDevicesRequestRequestTypeDef#

# AdminListDevicesRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminListDevicesRequestRequestTypeDef

def get_value() -> AdminListDevicesRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminListDevicesRequestRequestTypeDef definition

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

AdminListGroupsForUserRequestAdminListGroupsForUserPaginateTypeDef#

# AdminListGroupsForUserRequestAdminListGroupsForUserPaginateTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminListGroupsForUserRequestAdminListGroupsForUserPaginateTypeDef

def get_value() -> AdminListGroupsForUserRequestAdminListGroupsForUserPaginateTypeDef:
    return {
        "Username": ...,
        "UserPoolId": ...,
    }
# AdminListGroupsForUserRequestAdminListGroupsForUserPaginateTypeDef definition

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

AdminListGroupsForUserRequestRequestTypeDef#

# AdminListGroupsForUserRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminListGroupsForUserRequestRequestTypeDef

def get_value() -> AdminListGroupsForUserRequestRequestTypeDef:
    return {
        "Username": ...,
        "UserPoolId": ...,
    }
# AdminListGroupsForUserRequestRequestTypeDef definition

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

GroupTypeTypeDef#

# GroupTypeTypeDef 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],
    CreationDate: NotRequired[datetime],

AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateTypeDef#

# AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateTypeDef

def get_value() -> AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateTypeDef definition

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

AdminListUserAuthEventsRequestRequestTypeDef#

# AdminListUserAuthEventsRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminListUserAuthEventsRequestRequestTypeDef

def get_value() -> AdminListUserAuthEventsRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminListUserAuthEventsRequestRequestTypeDef definition

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

AdminRemoveUserFromGroupRequestRequestTypeDef#

# AdminRemoveUserFromGroupRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminRemoveUserFromGroupRequestRequestTypeDef

def get_value() -> AdminRemoveUserFromGroupRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
        "GroupName": ...,
    }
# AdminRemoveUserFromGroupRequestRequestTypeDef definition

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

AdminResetUserPasswordRequestRequestTypeDef#

# AdminResetUserPasswordRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminResetUserPasswordRequestRequestTypeDef

def get_value() -> AdminResetUserPasswordRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminResetUserPasswordRequestRequestTypeDef definition

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

SMSMfaSettingsTypeTypeDef#

# SMSMfaSettingsTypeTypeDef 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 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],

AdminSetUserPasswordRequestRequestTypeDef#

# AdminSetUserPasswordRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminSetUserPasswordRequestRequestTypeDef

def get_value() -> AdminSetUserPasswordRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
        "Password": ...,
    }
# AdminSetUserPasswordRequestRequestTypeDef definition

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

AdminUpdateAuthEventFeedbackRequestRequestTypeDef#

# AdminUpdateAuthEventFeedbackRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminUpdateAuthEventFeedbackRequestRequestTypeDef

def get_value() -> AdminUpdateAuthEventFeedbackRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
        "EventId": ...,
        "FeedbackValue": ...,
    }
# AdminUpdateAuthEventFeedbackRequestRequestTypeDef definition

class AdminUpdateAuthEventFeedbackRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    EventId: str,
    FeedbackValue: FeedbackValueTypeType,  # (1)
  1. See FeedbackValueTypeType

AdminUpdateDeviceStatusRequestRequestTypeDef#

# AdminUpdateDeviceStatusRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminUpdateDeviceStatusRequestRequestTypeDef

def get_value() -> AdminUpdateDeviceStatusRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
        "DeviceKey": ...,
    }
# AdminUpdateDeviceStatusRequestRequestTypeDef definition

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

AdminUserGlobalSignOutRequestRequestTypeDef#

# AdminUserGlobalSignOutRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminUserGlobalSignOutRequestRequestTypeDef

def get_value() -> AdminUserGlobalSignOutRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminUserGlobalSignOutRequestRequestTypeDef definition

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

AnalyticsConfigurationTypeTypeDef#

# AnalyticsConfigurationTypeTypeDef 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],

AssociateSoftwareTokenRequestRequestTypeDef#

# AssociateSoftwareTokenRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AssociateSoftwareTokenRequestRequestTypeDef

def get_value() -> AssociateSoftwareTokenRequestRequestTypeDef:
    return {
        "AccessToken": ...,
    }
# AssociateSoftwareTokenRequestRequestTypeDef definition

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

AssociateSoftwareTokenResponseTypeDef#

# AssociateSoftwareTokenResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AssociateSoftwareTokenResponseTypeDef

def get_value() -> AssociateSoftwareTokenResponseTypeDef:
    return {
        "SecretCode": ...,
        "Session": ...,
        "ResponseMetadata": ...,
    }
# AssociateSoftwareTokenResponseTypeDef definition

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

ChallengeResponseTypeTypeDef#

# ChallengeResponseTypeTypeDef 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 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 usage example

from mypy_boto3_cognito_idp.type_defs import EventFeedbackTypeTypeDef

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

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

EventRiskTypeTypeDef#

# EventRiskTypeTypeDef 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 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],

ChangePasswordRequestRequestTypeDef#

# ChangePasswordRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ChangePasswordRequestRequestTypeDef

def get_value() -> ChangePasswordRequestRequestTypeDef:
    return {
        "PreviousPassword": ...,
        "ProposedPassword": ...,
        "AccessToken": ...,
    }
# ChangePasswordRequestRequestTypeDef definition

class ChangePasswordRequestRequestTypeDef(TypedDict):
    PreviousPassword: str,
    ProposedPassword: str,
    AccessToken: str,

CodeDeliveryDetailsTypeTypeDef#

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

CompromisedCredentialsActionsTypeTypeDef#

# CompromisedCredentialsActionsTypeTypeDef 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 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],

ConfirmDeviceResponseTypeDef#

# ConfirmDeviceResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ConfirmDeviceResponseTypeDef

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

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

UserContextDataTypeTypeDef#

# UserContextDataTypeTypeDef 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 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],

CreateGroupRequestRequestTypeDef#

# CreateGroupRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CreateGroupRequestRequestTypeDef

def get_value() -> CreateGroupRequestRequestTypeDef:
    return {
        "GroupName": ...,
        "UserPoolId": ...,
    }
# CreateGroupRequestRequestTypeDef definition

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

CreateIdentityProviderRequestRequestTypeDef#

# CreateIdentityProviderRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CreateIdentityProviderRequestRequestTypeDef

def get_value() -> CreateIdentityProviderRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "ProviderName": ...,
        "ProviderType": ...,
        "ProviderDetails": ...,
    }
# CreateIdentityProviderRequestRequestTypeDef definition

class CreateIdentityProviderRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    ProviderName: str,
    ProviderType: IdentityProviderTypeTypeType,  # (1)
    ProviderDetails: Mapping[str, str],
    AttributeMapping: NotRequired[Mapping[str, str]],
    IdpIdentifiers: NotRequired[Sequence[str]],
  1. See IdentityProviderTypeTypeType

IdentityProviderTypeTypeDef#

# IdentityProviderTypeTypeDef 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],
    CreationDate: NotRequired[datetime],
  1. See IdentityProviderTypeTypeType

ResourceServerScopeTypeTypeDef#

# ResourceServerScopeTypeTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ResourceServerScopeTypeTypeDef

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

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

CreateUserImportJobRequestRequestTypeDef#

# CreateUserImportJobRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserImportJobRequestRequestTypeDef

def get_value() -> CreateUserImportJobRequestRequestTypeDef:
    return {
        "JobName": ...,
        "UserPoolId": ...,
        "CloudWatchLogsRoleArn": ...,
    }
# CreateUserImportJobRequestRequestTypeDef definition

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

UserImportJobTypeTypeDef#

# UserImportJobTypeTypeDef 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],
    StartDate: NotRequired[datetime],
    CompletionDate: NotRequired[datetime],
    Status: NotRequired[UserImportJobStatusTypeType],  # (1)
    CloudWatchLogsRoleArn: NotRequired[str],
    ImportedUsers: NotRequired[int],
    SkippedUsers: NotRequired[int],
    FailedUsers: NotRequired[int],
    CompletionMessage: NotRequired[str],
  1. See UserImportJobStatusTypeType

TokenValidityUnitsTypeTypeDef#

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

from mypy_boto3_cognito_idp.type_defs import CustomDomainConfigTypeTypeDef

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

class CustomDomainConfigTypeTypeDef(TypedDict):
    CertificateArn: str,

CreateUserPoolDomainResponseTypeDef#

# CreateUserPoolDomainResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserPoolDomainResponseTypeDef

def get_value() -> CreateUserPoolDomainResponseTypeDef:
    return {
        "CloudFrontDomain": ...,
        "ResponseMetadata": ...,
    }
# CreateUserPoolDomainResponseTypeDef definition

class CreateUserPoolDomainResponseTypeDef(TypedDict):
    CloudFrontDomain: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeviceConfigurationTypeTypeDef#

# DeviceConfigurationTypeTypeDef 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 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 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],

UserAttributeUpdateSettingsTypeTypeDef#

# UserAttributeUpdateSettingsTypeTypeDef 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 VerifiedAttributeTypeType

UserPoolAddOnsTypeTypeDef#

# UserPoolAddOnsTypeTypeDef 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)
  1. See AdvancedSecurityModeTypeType

UsernameConfigurationTypeTypeDef#

# UsernameConfigurationTypeTypeDef 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 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 usage example

from mypy_boto3_cognito_idp.type_defs import CustomEmailLambdaVersionConfigTypeTypeDef

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

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

CustomSMSLambdaVersionConfigTypeTypeDef#

# CustomSMSLambdaVersionConfigTypeTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CustomSMSLambdaVersionConfigTypeTypeDef

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

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

DeleteGroupRequestRequestTypeDef#

# DeleteGroupRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DeleteGroupRequestRequestTypeDef

def get_value() -> DeleteGroupRequestRequestTypeDef:
    return {
        "GroupName": ...,
        "UserPoolId": ...,
    }
# DeleteGroupRequestRequestTypeDef definition

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

DeleteIdentityProviderRequestRequestTypeDef#

# DeleteIdentityProviderRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DeleteIdentityProviderRequestRequestTypeDef

def get_value() -> DeleteIdentityProviderRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "ProviderName": ...,
    }
# DeleteIdentityProviderRequestRequestTypeDef definition

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

DeleteResourceServerRequestRequestTypeDef#

# DeleteResourceServerRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DeleteResourceServerRequestRequestTypeDef

def get_value() -> DeleteResourceServerRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Identifier": ...,
    }
# DeleteResourceServerRequestRequestTypeDef definition

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

DeleteUserAttributesRequestRequestTypeDef#

# DeleteUserAttributesRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DeleteUserAttributesRequestRequestTypeDef

def get_value() -> DeleteUserAttributesRequestRequestTypeDef:
    return {
        "UserAttributeNames": ...,
        "AccessToken": ...,
    }
# DeleteUserAttributesRequestRequestTypeDef definition

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

DeleteUserPoolClientRequestRequestTypeDef#

# DeleteUserPoolClientRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DeleteUserPoolClientRequestRequestTypeDef

def get_value() -> DeleteUserPoolClientRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "ClientId": ...,
    }
# DeleteUserPoolClientRequestRequestTypeDef definition

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

DeleteUserPoolDomainRequestRequestTypeDef#

# DeleteUserPoolDomainRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DeleteUserPoolDomainRequestRequestTypeDef

def get_value() -> DeleteUserPoolDomainRequestRequestTypeDef:
    return {
        "Domain": ...,
        "UserPoolId": ...,
    }
# DeleteUserPoolDomainRequestRequestTypeDef definition

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

DeleteUserPoolRequestRequestTypeDef#

# DeleteUserPoolRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DeleteUserPoolRequestRequestTypeDef

def get_value() -> DeleteUserPoolRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# DeleteUserPoolRequestRequestTypeDef definition

class DeleteUserPoolRequestRequestTypeDef(TypedDict):
    UserPoolId: str,

DeleteUserRequestRequestTypeDef#

# DeleteUserRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DeleteUserRequestRequestTypeDef

def get_value() -> DeleteUserRequestRequestTypeDef:
    return {
        "AccessToken": ...,
    }
# DeleteUserRequestRequestTypeDef definition

class DeleteUserRequestRequestTypeDef(TypedDict):
    AccessToken: str,

DescribeIdentityProviderRequestRequestTypeDef#

# DescribeIdentityProviderRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DescribeIdentityProviderRequestRequestTypeDef

def get_value() -> DescribeIdentityProviderRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "ProviderName": ...,
    }
# DescribeIdentityProviderRequestRequestTypeDef definition

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

DescribeResourceServerRequestRequestTypeDef#

# DescribeResourceServerRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DescribeResourceServerRequestRequestTypeDef

def get_value() -> DescribeResourceServerRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Identifier": ...,
    }
# DescribeResourceServerRequestRequestTypeDef definition

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

DescribeRiskConfigurationRequestRequestTypeDef#

# DescribeRiskConfigurationRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DescribeRiskConfigurationRequestRequestTypeDef

def get_value() -> DescribeRiskConfigurationRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# DescribeRiskConfigurationRequestRequestTypeDef definition

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

DescribeUserImportJobRequestRequestTypeDef#

# DescribeUserImportJobRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserImportJobRequestRequestTypeDef

def get_value() -> DescribeUserImportJobRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "JobId": ...,
    }
# DescribeUserImportJobRequestRequestTypeDef definition

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

DescribeUserPoolClientRequestRequestTypeDef#

# DescribeUserPoolClientRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserPoolClientRequestRequestTypeDef

def get_value() -> DescribeUserPoolClientRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "ClientId": ...,
    }
# DescribeUserPoolClientRequestRequestTypeDef definition

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

DescribeUserPoolDomainRequestRequestTypeDef#

# DescribeUserPoolDomainRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserPoolDomainRequestRequestTypeDef

def get_value() -> DescribeUserPoolDomainRequestRequestTypeDef:
    return {
        "Domain": ...,
    }
# DescribeUserPoolDomainRequestRequestTypeDef definition

class DescribeUserPoolDomainRequestRequestTypeDef(TypedDict):
    Domain: str,

DescribeUserPoolRequestRequestTypeDef#

# DescribeUserPoolRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserPoolRequestRequestTypeDef

def get_value() -> DescribeUserPoolRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# DescribeUserPoolRequestRequestTypeDef definition

class DescribeUserPoolRequestRequestTypeDef(TypedDict):
    UserPoolId: str,

EmptyResponseMetadataTypeDef#

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

ForgetDeviceRequestRequestTypeDef#

# ForgetDeviceRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ForgetDeviceRequestRequestTypeDef

def get_value() -> ForgetDeviceRequestRequestTypeDef:
    return {
        "DeviceKey": ...,
    }
# ForgetDeviceRequestRequestTypeDef definition

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

GetCSVHeaderRequestRequestTypeDef#

# GetCSVHeaderRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetCSVHeaderRequestRequestTypeDef

def get_value() -> GetCSVHeaderRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# GetCSVHeaderRequestRequestTypeDef definition

class GetCSVHeaderRequestRequestTypeDef(TypedDict):
    UserPoolId: str,

GetCSVHeaderResponseTypeDef#

# GetCSVHeaderResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetCSVHeaderResponseTypeDef

def get_value() -> GetCSVHeaderResponseTypeDef:
    return {
        "UserPoolId": ...,
        "CSVHeader": ...,
        "ResponseMetadata": ...,
    }
# GetCSVHeaderResponseTypeDef definition

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

GetDeviceRequestRequestTypeDef#

# GetDeviceRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetDeviceRequestRequestTypeDef

def get_value() -> GetDeviceRequestRequestTypeDef:
    return {
        "DeviceKey": ...,
    }
# GetDeviceRequestRequestTypeDef definition

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

GetGroupRequestRequestTypeDef#

# GetGroupRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetGroupRequestRequestTypeDef

def get_value() -> GetGroupRequestRequestTypeDef:
    return {
        "GroupName": ...,
        "UserPoolId": ...,
    }
# GetGroupRequestRequestTypeDef definition

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

GetIdentityProviderByIdentifierRequestRequestTypeDef#

# GetIdentityProviderByIdentifierRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetIdentityProviderByIdentifierRequestRequestTypeDef

def get_value() -> GetIdentityProviderByIdentifierRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "IdpIdentifier": ...,
    }
# GetIdentityProviderByIdentifierRequestRequestTypeDef definition

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

GetSigningCertificateRequestRequestTypeDef#

# GetSigningCertificateRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetSigningCertificateRequestRequestTypeDef

def get_value() -> GetSigningCertificateRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# GetSigningCertificateRequestRequestTypeDef definition

class GetSigningCertificateRequestRequestTypeDef(TypedDict):
    UserPoolId: str,

GetSigningCertificateResponseTypeDef#

# GetSigningCertificateResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetSigningCertificateResponseTypeDef

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

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

GetUICustomizationRequestRequestTypeDef#

# GetUICustomizationRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetUICustomizationRequestRequestTypeDef

def get_value() -> GetUICustomizationRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# GetUICustomizationRequestRequestTypeDef definition

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

UICustomizationTypeTypeDef#

# UICustomizationTypeTypeDef 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],
    CreationDate: NotRequired[datetime],

GetUserAttributeVerificationCodeRequestRequestTypeDef#

# GetUserAttributeVerificationCodeRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetUserAttributeVerificationCodeRequestRequestTypeDef

def get_value() -> GetUserAttributeVerificationCodeRequestRequestTypeDef:
    return {
        "AccessToken": ...,
        "AttributeName": ...,
    }
# GetUserAttributeVerificationCodeRequestRequestTypeDef definition

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

GetUserPoolMfaConfigRequestRequestTypeDef#

# GetUserPoolMfaConfigRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetUserPoolMfaConfigRequestRequestTypeDef

def get_value() -> GetUserPoolMfaConfigRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# GetUserPoolMfaConfigRequestRequestTypeDef definition

class GetUserPoolMfaConfigRequestRequestTypeDef(TypedDict):
    UserPoolId: str,

SoftwareTokenMfaConfigTypeTypeDef#

# SoftwareTokenMfaConfigTypeTypeDef 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],

GetUserRequestRequestTypeDef#

# GetUserRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetUserRequestRequestTypeDef

def get_value() -> GetUserRequestRequestTypeDef:
    return {
        "AccessToken": ...,
    }
# GetUserRequestRequestTypeDef definition

class GetUserRequestRequestTypeDef(TypedDict):
    AccessToken: str,

GlobalSignOutRequestRequestTypeDef#

# GlobalSignOutRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GlobalSignOutRequestRequestTypeDef

def get_value() -> GlobalSignOutRequestRequestTypeDef:
    return {
        "AccessToken": ...,
    }
# GlobalSignOutRequestRequestTypeDef definition

class GlobalSignOutRequestRequestTypeDef(TypedDict):
    AccessToken: str,

ListDevicesRequestRequestTypeDef#

# ListDevicesRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListDevicesRequestRequestTypeDef

def get_value() -> ListDevicesRequestRequestTypeDef:
    return {
        "AccessToken": ...,
    }
# ListDevicesRequestRequestTypeDef definition

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

ListGroupsRequestListGroupsPaginateTypeDef#

# ListGroupsRequestListGroupsPaginateTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListGroupsRequestListGroupsPaginateTypeDef

def get_value() -> ListGroupsRequestListGroupsPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }
# ListGroupsRequestListGroupsPaginateTypeDef definition

class ListGroupsRequestListGroupsPaginateTypeDef(TypedDict):
    UserPoolId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListGroupsRequestRequestTypeDef#

# ListGroupsRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListGroupsRequestRequestTypeDef

def get_value() -> ListGroupsRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# ListGroupsRequestRequestTypeDef definition

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

ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef#

# ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef

def get_value() -> ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }
# ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef definition

class ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef(TypedDict):
    UserPoolId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListIdentityProvidersRequestRequestTypeDef#

# ListIdentityProvidersRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListIdentityProvidersRequestRequestTypeDef

def get_value() -> ListIdentityProvidersRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# ListIdentityProvidersRequestRequestTypeDef definition

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

ProviderDescriptionTypeDef#

# ProviderDescriptionTypeDef 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],
    CreationDate: NotRequired[datetime],
  1. See IdentityProviderTypeTypeType

ListResourceServersRequestListResourceServersPaginateTypeDef#

# ListResourceServersRequestListResourceServersPaginateTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListResourceServersRequestListResourceServersPaginateTypeDef

def get_value() -> ListResourceServersRequestListResourceServersPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }
# ListResourceServersRequestListResourceServersPaginateTypeDef definition

class ListResourceServersRequestListResourceServersPaginateTypeDef(TypedDict):
    UserPoolId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListResourceServersRequestRequestTypeDef#

# ListResourceServersRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListResourceServersRequestRequestTypeDef

def get_value() -> ListResourceServersRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# ListResourceServersRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListTagsForResourceResponseTypeDef

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

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

ListUserImportJobsRequestRequestTypeDef#

# ListUserImportJobsRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUserImportJobsRequestRequestTypeDef

def get_value() -> ListUserImportJobsRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "MaxResults": ...,
    }
# ListUserImportJobsRequestRequestTypeDef definition

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

ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef#

# ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef

def get_value() -> ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }
# ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef definition

class ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef(TypedDict):
    UserPoolId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListUserPoolClientsRequestRequestTypeDef#

# ListUserPoolClientsRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUserPoolClientsRequestRequestTypeDef

def get_value() -> ListUserPoolClientsRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# ListUserPoolClientsRequestRequestTypeDef definition

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

UserPoolClientDescriptionTypeDef#

# UserPoolClientDescriptionTypeDef 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],

ListUserPoolsRequestListUserPoolsPaginateTypeDef#

# ListUserPoolsRequestListUserPoolsPaginateTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUserPoolsRequestListUserPoolsPaginateTypeDef

def get_value() -> ListUserPoolsRequestListUserPoolsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
# ListUserPoolsRequestListUserPoolsPaginateTypeDef definition

class ListUserPoolsRequestListUserPoolsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListUserPoolsRequestRequestTypeDef#

# ListUserPoolsRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUserPoolsRequestRequestTypeDef

def get_value() -> ListUserPoolsRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }
# ListUserPoolsRequestRequestTypeDef definition

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

ListUsersInGroupRequestListUsersInGroupPaginateTypeDef#

# ListUsersInGroupRequestListUsersInGroupPaginateTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersInGroupRequestListUsersInGroupPaginateTypeDef

def get_value() -> ListUsersInGroupRequestListUsersInGroupPaginateTypeDef:
    return {
        "UserPoolId": ...,
        "GroupName": ...,
    }
# ListUsersInGroupRequestListUsersInGroupPaginateTypeDef definition

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

ListUsersInGroupRequestRequestTypeDef#

# ListUsersInGroupRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersInGroupRequestRequestTypeDef

def get_value() -> ListUsersInGroupRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "GroupName": ...,
    }
# ListUsersInGroupRequestRequestTypeDef definition

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

ListUsersRequestListUsersPaginateTypeDef#

# ListUsersRequestListUsersPaginateTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersRequestListUsersPaginateTypeDef

def get_value() -> ListUsersRequestListUsersPaginateTypeDef:
    return {
        "UserPoolId": ...,
    }
# ListUsersRequestListUsersPaginateTypeDef definition

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

ListUsersRequestRequestTypeDef#

# ListUsersRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersRequestRequestTypeDef

def get_value() -> ListUsersRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# ListUsersRequestRequestTypeDef definition

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

NotifyEmailTypeTypeDef#

# NotifyEmailTypeTypeDef 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 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],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef 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],

PasswordPolicyTypeTypeDef#

# PasswordPolicyTypeTypeDef 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],
    TemporaryPasswordValidityDays: NotRequired[int],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

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

RevokeTokenRequestRequestTypeDef#

# RevokeTokenRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import RevokeTokenRequestRequestTypeDef

def get_value() -> RevokeTokenRequestRequestTypeDef:
    return {
        "Token": ...,
        "ClientId": ...,
    }
# RevokeTokenRequestRequestTypeDef definition

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

RiskExceptionConfigurationTypeTypeDef#

# RiskExceptionConfigurationTypeTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import RiskExceptionConfigurationTypeTypeDef

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

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

StringAttributeConstraintsTypeTypeDef#

# StringAttributeConstraintsTypeTypeDef 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],

SetUICustomizationRequestRequestTypeDef#

# SetUICustomizationRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import SetUICustomizationRequestRequestTypeDef

def get_value() -> SetUICustomizationRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
    }
# SetUICustomizationRequestRequestTypeDef definition

class SetUICustomizationRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    ClientId: NotRequired[str],
    CSS: NotRequired[str],
    ImageFile: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],

StartUserImportJobRequestRequestTypeDef#

# StartUserImportJobRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import StartUserImportJobRequestRequestTypeDef

def get_value() -> StartUserImportJobRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "JobId": ...,
    }
# StartUserImportJobRequestRequestTypeDef definition

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

StopUserImportJobRequestRequestTypeDef#

# StopUserImportJobRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import StopUserImportJobRequestRequestTypeDef

def get_value() -> StopUserImportJobRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "JobId": ...,
    }
# StopUserImportJobRequestRequestTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

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

UpdateAuthEventFeedbackRequestRequestTypeDef#

# UpdateAuthEventFeedbackRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateAuthEventFeedbackRequestRequestTypeDef

def get_value() -> UpdateAuthEventFeedbackRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
        "EventId": ...,
        "FeedbackToken": ...,
        "FeedbackValue": ...,
    }
# UpdateAuthEventFeedbackRequestRequestTypeDef definition

class UpdateAuthEventFeedbackRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    EventId: str,
    FeedbackToken: str,
    FeedbackValue: FeedbackValueTypeType,  # (1)
  1. See FeedbackValueTypeType

UpdateDeviceStatusRequestRequestTypeDef#

# UpdateDeviceStatusRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateDeviceStatusRequestRequestTypeDef

def get_value() -> UpdateDeviceStatusRequestRequestTypeDef:
    return {
        "AccessToken": ...,
        "DeviceKey": ...,
    }
# UpdateDeviceStatusRequestRequestTypeDef definition

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

UpdateGroupRequestRequestTypeDef#

# UpdateGroupRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateGroupRequestRequestTypeDef

def get_value() -> UpdateGroupRequestRequestTypeDef:
    return {
        "GroupName": ...,
        "UserPoolId": ...,
    }
# UpdateGroupRequestRequestTypeDef definition

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

UpdateIdentityProviderRequestRequestTypeDef#

# UpdateIdentityProviderRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateIdentityProviderRequestRequestTypeDef

def get_value() -> UpdateIdentityProviderRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "ProviderName": ...,
    }
# UpdateIdentityProviderRequestRequestTypeDef definition

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

UpdateUserPoolDomainResponseTypeDef#

# UpdateUserPoolDomainResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserPoolDomainResponseTypeDef

def get_value() -> UpdateUserPoolDomainResponseTypeDef:
    return {
        "CloudFrontDomain": ...,
        "ResponseMetadata": ...,
    }
# UpdateUserPoolDomainResponseTypeDef definition

class UpdateUserPoolDomainResponseTypeDef(TypedDict):
    CloudFrontDomain: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

VerifySoftwareTokenRequestRequestTypeDef#

# VerifySoftwareTokenRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import VerifySoftwareTokenRequestRequestTypeDef

def get_value() -> VerifySoftwareTokenRequestRequestTypeDef:
    return {
        "UserCode": ...,
    }
# VerifySoftwareTokenRequestRequestTypeDef definition

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

VerifySoftwareTokenResponseTypeDef#

# VerifySoftwareTokenResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import VerifySoftwareTokenResponseTypeDef

def get_value() -> VerifySoftwareTokenResponseTypeDef:
    return {
        "Status": ...,
        "Session": ...,
        "ResponseMetadata": ...,
    }
# VerifySoftwareTokenResponseTypeDef definition

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

VerifyUserAttributeRequestRequestTypeDef#

# VerifyUserAttributeRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import VerifyUserAttributeRequestRequestTypeDef

def get_value() -> VerifyUserAttributeRequestRequestTypeDef:
    return {
        "AccessToken": ...,
        "AttributeName": ...,
        "Code": ...,
    }
# VerifyUserAttributeRequestRequestTypeDef definition

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

AccountRecoverySettingTypeTypeDef#

# AccountRecoverySettingTypeTypeDef 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 RecoveryOptionTypeTypeDef

AccountTakeoverActionsTypeTypeDef#

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

AdminCreateUserRequestRequestTypeDef#

# AdminCreateUserRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminCreateUserRequestRequestTypeDef

def get_value() -> AdminCreateUserRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
    }
# AdminCreateUserRequestRequestTypeDef definition

class AdminCreateUserRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    Username: str,
    UserAttributes: NotRequired[Sequence[AttributeTypeTypeDef]],  # (1)
    ValidationData: NotRequired[Sequence[AttributeTypeTypeDef]],  # (1)
    TemporaryPassword: NotRequired[str],
    ForceAliasCreation: NotRequired[bool],
    MessageAction: NotRequired[MessageActionTypeType],  # (3)
    DesiredDeliveryMediums: NotRequired[Sequence[DeliveryMediumTypeType]],  # (4)
    ClientMetadata: NotRequired[Mapping[str, str]],
  1. See AttributeTypeTypeDef
  2. See AttributeTypeTypeDef
  3. See MessageActionTypeType
  4. See DeliveryMediumTypeType

AdminUpdateUserAttributesRequestRequestTypeDef#

# AdminUpdateUserAttributesRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminUpdateUserAttributesRequestRequestTypeDef

def get_value() -> AdminUpdateUserAttributesRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
        "UserAttributes": ...,
    }
# AdminUpdateUserAttributesRequestRequestTypeDef definition

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

DeviceTypeTypeDef#

# DeviceTypeTypeDef 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],
    DeviceLastModifiedDate: NotRequired[datetime],
    DeviceLastAuthenticatedDate: NotRequired[datetime],
  1. See AttributeTypeTypeDef

UpdateUserAttributesRequestRequestTypeDef#

# UpdateUserAttributesRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserAttributesRequestRequestTypeDef

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

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

AdminDisableProviderForUserRequestRequestTypeDef#

# AdminDisableProviderForUserRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminDisableProviderForUserRequestRequestTypeDef

def get_value() -> AdminDisableProviderForUserRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "User": ...,
    }
# AdminDisableProviderForUserRequestRequestTypeDef definition

class AdminDisableProviderForUserRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    User: ProviderUserIdentifierTypeTypeDef,  # (1)
  1. See ProviderUserIdentifierTypeTypeDef

AdminLinkProviderForUserRequestRequestTypeDef#

# AdminLinkProviderForUserRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminLinkProviderForUserRequestRequestTypeDef

def get_value() -> AdminLinkProviderForUserRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "DestinationUser": ...,
        "SourceUser": ...,
    }
# AdminLinkProviderForUserRequestRequestTypeDef definition

class AdminLinkProviderForUserRequestRequestTypeDef(TypedDict):
    UserPoolId: str,
    DestinationUser: ProviderUserIdentifierTypeTypeDef,  # (1)
    SourceUser: ProviderUserIdentifierTypeTypeDef,  # (1)
  1. See ProviderUserIdentifierTypeTypeDef
  2. See ProviderUserIdentifierTypeTypeDef

AdminGetUserResponseTypeDef#

# AdminGetUserResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminGetUserResponseTypeDef

def get_value() -> AdminGetUserResponseTypeDef:
    return {
        "Username": ...,
        "UserAttributes": ...,
        "UserCreateDate": ...,
        "UserLastModifiedDate": ...,
        "Enabled": ...,
        "UserStatus": ...,
        "MFAOptions": ...,
        "PreferredMfaSetting": ...,
        "UserMFASettingList": ...,
        "ResponseMetadata": ...,
    }
# AdminGetUserResponseTypeDef definition

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

AdminSetUserSettingsRequestRequestTypeDef#

# AdminSetUserSettingsRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminSetUserSettingsRequestRequestTypeDef

def get_value() -> AdminSetUserSettingsRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Username": ...,
        "MFAOptions": ...,
    }
# AdminSetUserSettingsRequestRequestTypeDef definition

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

GetUserResponseTypeDef#

# GetUserResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetUserResponseTypeDef

def get_value() -> GetUserResponseTypeDef:
    return {
        "Username": ...,
        "UserAttributes": ...,
        "MFAOptions": ...,
        "PreferredMfaSetting": ...,
        "UserMFASettingList": ...,
        "ResponseMetadata": ...,
    }
# 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 AttributeTypeTypeDef
  2. See MFAOptionTypeTypeDef
  3. See ResponseMetadataTypeDef

SetUserSettingsRequestRequestTypeDef#

# SetUserSettingsRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import SetUserSettingsRequestRequestTypeDef

def get_value() -> SetUserSettingsRequestRequestTypeDef:
    return {
        "AccessToken": ...,
        "MFAOptions": ...,
    }
# SetUserSettingsRequestRequestTypeDef definition

class SetUserSettingsRequestRequestTypeDef(TypedDict):
    AccessToken: str,
    MFAOptions: Sequence[MFAOptionTypeTypeDef],  # (1)
  1. See MFAOptionTypeTypeDef

UserTypeTypeDef#

# UserTypeTypeDef 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],
    UserLastModifiedDate: NotRequired[datetime],
    Enabled: NotRequired[bool],
    UserStatus: NotRequired[UserStatusTypeType],  # (2)
    MFAOptions: NotRequired[List[MFAOptionTypeTypeDef]],  # (3)
  1. See AttributeTypeTypeDef
  2. See UserStatusTypeType
  3. See MFAOptionTypeTypeDef

AdminListGroupsForUserResponseTypeDef#

# AdminListGroupsForUserResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminListGroupsForUserResponseTypeDef

def get_value() -> AdminListGroupsForUserResponseTypeDef:
    return {
        "Groups": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# AdminListGroupsForUserResponseTypeDef definition

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

CreateGroupResponseTypeDef#

# CreateGroupResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CreateGroupResponseTypeDef

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

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

GetGroupResponseTypeDef#

# GetGroupResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetGroupResponseTypeDef

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

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

ListGroupsResponseTypeDef#

# ListGroupsResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListGroupsResponseTypeDef

def get_value() -> ListGroupsResponseTypeDef:
    return {
        "Groups": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListGroupsResponseTypeDef definition

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

UpdateGroupResponseTypeDef#

# UpdateGroupResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateGroupResponseTypeDef

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

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

AdminSetUserMFAPreferenceRequestRequestTypeDef#

# AdminSetUserMFAPreferenceRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminSetUserMFAPreferenceRequestRequestTypeDef

def get_value() -> AdminSetUserMFAPreferenceRequestRequestTypeDef:
    return {
        "Username": ...,
        "UserPoolId": ...,
    }
# AdminSetUserMFAPreferenceRequestRequestTypeDef definition

class AdminSetUserMFAPreferenceRequestRequestTypeDef(TypedDict):
    Username: str,
    UserPoolId: str,
    SMSMfaSettings: NotRequired[SMSMfaSettingsTypeTypeDef],  # (1)
    SoftwareTokenMfaSettings: NotRequired[SoftwareTokenMfaSettingsTypeTypeDef],  # (2)
  1. See SMSMfaSettingsTypeTypeDef
  2. See SoftwareTokenMfaSettingsTypeTypeDef

SetUserMFAPreferenceRequestRequestTypeDef#

# SetUserMFAPreferenceRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import SetUserMFAPreferenceRequestRequestTypeDef

def get_value() -> SetUserMFAPreferenceRequestRequestTypeDef:
    return {
        "AccessToken": ...,
    }
# SetUserMFAPreferenceRequestRequestTypeDef definition

class SetUserMFAPreferenceRequestRequestTypeDef(TypedDict):
    AccessToken: str,
    SMSMfaSettings: NotRequired[SMSMfaSettingsTypeTypeDef],  # (1)
    SoftwareTokenMfaSettings: NotRequired[SoftwareTokenMfaSettingsTypeTypeDef],  # (2)
  1. See SMSMfaSettingsTypeTypeDef
  2. See SoftwareTokenMfaSettingsTypeTypeDef

AuthEventTypeTypeDef#

# AuthEventTypeTypeDef 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],
    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 ChallengeResponseTypeTypeDef
  5. See EventContextDataTypeTypeDef
  6. See EventFeedbackTypeTypeDef

AuthenticationResultTypeTypeDef#

# AuthenticationResultTypeTypeDef 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 usage example

from mypy_boto3_cognito_idp.type_defs import ForgotPasswordResponseTypeDef

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

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

GetUserAttributeVerificationCodeResponseTypeDef#

# GetUserAttributeVerificationCodeResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetUserAttributeVerificationCodeResponseTypeDef

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

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

ResendConfirmationCodeResponseTypeDef#

# ResendConfirmationCodeResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ResendConfirmationCodeResponseTypeDef

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

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

SignUpResponseTypeDef#

# SignUpResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import SignUpResponseTypeDef

def get_value() -> SignUpResponseTypeDef:
    return {
        "UserConfirmed": ...,
        "CodeDeliveryDetails": ...,
        "UserSub": ...,
        "ResponseMetadata": ...,
    }
# SignUpResponseTypeDef definition

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

UpdateUserAttributesResponseTypeDef#

# UpdateUserAttributesResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserAttributesResponseTypeDef

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

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

CompromisedCredentialsRiskConfigurationTypeTypeDef#

# CompromisedCredentialsRiskConfigurationTypeTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CompromisedCredentialsRiskConfigurationTypeTypeDef

def get_value() -> CompromisedCredentialsRiskConfigurationTypeTypeDef:
    return {
        "Actions": ...,
    }
# CompromisedCredentialsRiskConfigurationTypeTypeDef definition

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

ConfirmDeviceRequestRequestTypeDef#

# ConfirmDeviceRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ConfirmDeviceRequestRequestTypeDef

def get_value() -> ConfirmDeviceRequestRequestTypeDef:
    return {
        "AccessToken": ...,
        "DeviceKey": ...,
    }
# ConfirmDeviceRequestRequestTypeDef definition

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

ConfirmForgotPasswordRequestRequestTypeDef#

# ConfirmForgotPasswordRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ConfirmForgotPasswordRequestRequestTypeDef

def get_value() -> ConfirmForgotPasswordRequestRequestTypeDef:
    return {
        "ClientId": ...,
        "Username": ...,
        "ConfirmationCode": ...,
        "Password": ...,
    }
# ConfirmForgotPasswordRequestRequestTypeDef definition

class ConfirmForgotPasswordRequestRequestTypeDef(TypedDict):
    ClientId: str,
    Username: str,
    ConfirmationCode: str,
    Password: str,
    SecretHash: NotRequired[str],
    AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef],  # (1)
    UserContextData: NotRequired[UserContextDataTypeTypeDef],  # (2)
    ClientMetadata: NotRequired[Mapping[str, str]],
  1. See AnalyticsMetadataTypeTypeDef
  2. See UserContextDataTypeTypeDef

ConfirmSignUpRequestRequestTypeDef#

# ConfirmSignUpRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ConfirmSignUpRequestRequestTypeDef

def get_value() -> ConfirmSignUpRequestRequestTypeDef:
    return {
        "ClientId": ...,
        "Username": ...,
        "ConfirmationCode": ...,
    }
# ConfirmSignUpRequestRequestTypeDef definition

class ConfirmSignUpRequestRequestTypeDef(TypedDict):
    ClientId: str,
    Username: str,
    ConfirmationCode: str,
    SecretHash: NotRequired[str],
    ForceAliasCreation: NotRequired[bool],
    AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef],  # (1)
    UserContextData: NotRequired[UserContextDataTypeTypeDef],  # (2)
    ClientMetadata: NotRequired[Mapping[str, str]],
  1. See AnalyticsMetadataTypeTypeDef
  2. See UserContextDataTypeTypeDef

ForgotPasswordRequestRequestTypeDef#

# ForgotPasswordRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ForgotPasswordRequestRequestTypeDef

def get_value() -> ForgotPasswordRequestRequestTypeDef:
    return {
        "ClientId": ...,
        "Username": ...,
    }
# ForgotPasswordRequestRequestTypeDef definition

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

InitiateAuthRequestRequestTypeDef#

# InitiateAuthRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import InitiateAuthRequestRequestTypeDef

def get_value() -> InitiateAuthRequestRequestTypeDef:
    return {
        "AuthFlow": ...,
        "ClientId": ...,
    }
# InitiateAuthRequestRequestTypeDef definition

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

ResendConfirmationCodeRequestRequestTypeDef#

# ResendConfirmationCodeRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ResendConfirmationCodeRequestRequestTypeDef

def get_value() -> ResendConfirmationCodeRequestRequestTypeDef:
    return {
        "ClientId": ...,
        "Username": ...,
    }
# ResendConfirmationCodeRequestRequestTypeDef definition

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

RespondToAuthChallengeRequestRequestTypeDef#

# RespondToAuthChallengeRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import RespondToAuthChallengeRequestRequestTypeDef

def get_value() -> RespondToAuthChallengeRequestRequestTypeDef:
    return {
        "ClientId": ...,
        "ChallengeName": ...,
    }
# RespondToAuthChallengeRequestRequestTypeDef definition

class RespondToAuthChallengeRequestRequestTypeDef(TypedDict):
    ClientId: str,
    ChallengeName: ChallengeNameTypeType,  # (1)
    Session: NotRequired[str],
    ChallengeResponses: NotRequired[Mapping[str, str]],
    AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef],  # (2)
    UserContextData: NotRequired[UserContextDataTypeTypeDef],  # (3)
    ClientMetadata: NotRequired[Mapping[str, str]],
  1. See ChallengeNameTypeType
  2. See AnalyticsMetadataTypeTypeDef
  3. See UserContextDataTypeTypeDef

SignUpRequestRequestTypeDef#

# SignUpRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import SignUpRequestRequestTypeDef

def get_value() -> SignUpRequestRequestTypeDef:
    return {
        "ClientId": ...,
        "Username": ...,
        "Password": ...,
    }
# SignUpRequestRequestTypeDef definition

class SignUpRequestRequestTypeDef(TypedDict):
    ClientId: str,
    Username: str,
    Password: str,
    SecretHash: NotRequired[str],
    UserAttributes: NotRequired[Sequence[AttributeTypeTypeDef]],  # (1)
    ValidationData: NotRequired[Sequence[AttributeTypeTypeDef]],  # (1)
    AnalyticsMetadata: NotRequired[AnalyticsMetadataTypeTypeDef],  # (3)
    UserContextData: NotRequired[UserContextDataTypeTypeDef],  # (4)
    ClientMetadata: NotRequired[Mapping[str, str]],
  1. See AttributeTypeTypeDef
  2. See AttributeTypeTypeDef
  3. See AnalyticsMetadataTypeTypeDef
  4. See UserContextDataTypeTypeDef

ContextDataTypeTypeDef#

# ContextDataTypeTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ContextDataTypeTypeDef

def get_value() -> ContextDataTypeTypeDef:
    return {
        "IpAddress": ...,
        "ServerName": ...,
        "ServerPath": ...,
        "HttpHeaders": ...,
    }
# ContextDataTypeTypeDef definition

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

CreateIdentityProviderResponseTypeDef#

# CreateIdentityProviderResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CreateIdentityProviderResponseTypeDef

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

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

DescribeIdentityProviderResponseTypeDef#

# DescribeIdentityProviderResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DescribeIdentityProviderResponseTypeDef

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

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

GetIdentityProviderByIdentifierResponseTypeDef#

# GetIdentityProviderByIdentifierResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetIdentityProviderByIdentifierResponseTypeDef

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

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

UpdateIdentityProviderResponseTypeDef#

# UpdateIdentityProviderResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateIdentityProviderResponseTypeDef

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

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

CreateResourceServerRequestRequestTypeDef#

# CreateResourceServerRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CreateResourceServerRequestRequestTypeDef

def get_value() -> CreateResourceServerRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Identifier": ...,
        "Name": ...,
    }
# CreateResourceServerRequestRequestTypeDef definition

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

ResourceServerTypeTypeDef#

# ResourceServerTypeTypeDef 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 ResourceServerScopeTypeTypeDef

UpdateResourceServerRequestRequestTypeDef#

# UpdateResourceServerRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateResourceServerRequestRequestTypeDef

def get_value() -> UpdateResourceServerRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "Identifier": ...,
        "Name": ...,
    }
# UpdateResourceServerRequestRequestTypeDef definition

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

CreateUserImportJobResponseTypeDef#

# CreateUserImportJobResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserImportJobResponseTypeDef

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

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

DescribeUserImportJobResponseTypeDef#

# DescribeUserImportJobResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import DescribeUserImportJobResponseTypeDef

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

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

ListUserImportJobsResponseTypeDef#

# ListUserImportJobsResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUserImportJobsResponseTypeDef

def get_value() -> ListUserImportJobsResponseTypeDef:
    return {
        "UserImportJobs": ...,
        "PaginationToken": ...,
        "ResponseMetadata": ...,
    }
# ListUserImportJobsResponseTypeDef definition

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

StartUserImportJobResponseTypeDef#

# StartUserImportJobResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import StartUserImportJobResponseTypeDef

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

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

StopUserImportJobResponseTypeDef#

# StopUserImportJobResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import StopUserImportJobResponseTypeDef

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

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

CreateUserPoolClientRequestRequestTypeDef#

# CreateUserPoolClientRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserPoolClientRequestRequestTypeDef

def get_value() -> CreateUserPoolClientRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "ClientName": ...,
    }
# CreateUserPoolClientRequestRequestTypeDef definition

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

UpdateUserPoolClientRequestRequestTypeDef#

# UpdateUserPoolClientRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserPoolClientRequestRequestTypeDef

def get_value() -> UpdateUserPoolClientRequestRequestTypeDef:
    return {
        "UserPoolId": ...,
        "ClientId": ...,
    }
# UpdateUserPoolClientRequestRequestTypeDef definition

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

UserPoolClientTypeTypeDef#

# UserPoolClientTypeTypeDef 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],
    CreationDate: NotRequired[datetime],
    RefreshTokenValidity: NotRequired[int],
    AccessTokenValidity: NotRequired[int],
    IdTokenValidity: NotRequired[int],
    TokenValidityUnits: NotRequired[TokenValidityUnitsTypeTypeDef],  # (1)
    ReadAttributes: NotRequired[List[str]],
    WriteAttributes: NotRequired[List[str]],
    ExplicitAuthFlows: NotRequired[List[ExplicitAuthFlowsTypeType]],  # (2)
    SupportedIdentityProviders: NotRequired[List[str]],
    CallbackURLs: NotRequired[List[str]],
    LogoutURLs: NotRequired[List[str]],
    DefaultRedirectURI: NotRequired[str],
    AllowedOAuthFlows: NotRequired[List[OAuthFlowTypeType]],  # (3)
    AllowedOAuthScopes: NotRequired[List[str]],
    AllowedOAuthFlowsUserPoolClient: NotRequired[bool],
    AnalyticsConfiguration: NotRequired[AnalyticsConfigurationTypeTypeDef],  # (4)
    PreventUserExistenceErrors: NotRequired[PreventUserExistenceErrorTypesType],  # (5)
    EnableTokenRevocation: NotRequired[bool],
    EnablePropagateAdditionalUserContextData: NotRequired[bool],
    AuthSessionValidity: NotRequired[int],
  1. See TokenValidityUnitsTypeTypeDef
  2. See ExplicitAuthFlowsTypeType
  3. See OAuthFlowTypeType
  4. See AnalyticsConfigurationTypeTypeDef
  5. See PreventUserExistenceErrorTypesType

CreateUserPoolDomainRequestRequestTypeDef#

# CreateUserPoolDomainRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import CreateUserPoolDomainRequestRequestTypeDef

def get_value() -> CreateUserPoolDomainRequestRequestTypeDef:
    return {
        "Domain": ...,
        "UserPoolId": ...,
    }
# CreateUserPoolDomainRequestRequestTypeDef definition

class CreateUserPoolDomainRequestRequestTypeDef(TypedDict):
    Domain: str,
    UserPoolId: str,
    CustomDomainConfig: NotRequired[CustomDomainConfigTypeTypeDef],  # (1)
  1. See CustomDomainConfigTypeTypeDef

DomainDescriptionTypeTypeDef#

# DomainDescriptionTypeTypeDef 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)
  1. See DomainStatusTypeType
  2. See CustomDomainConfigTypeTypeDef

UpdateUserPoolDomainRequestRequestTypeDef#

# UpdateUserPoolDomainRequestRequestTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import UpdateUserPoolDomainRequestRequestTypeDef

def get_value() -> UpdateUserPoolDomainRequestRequestTypeDef:
    return {
        "Domain": ...,
        "UserPoolId": ...,
        "CustomDomainConfig": ...,
    }
# UpdateUserPoolDomainRequestRequestTypeDef definition

class UpdateUserPoolDomainRequestRequestTypeDef(TypedDict):
    Domain: str,
    UserPoolId: str,
    CustomDomainConfig: CustomDomainConfigTypeTypeDef,  # (1)
  1. See CustomDomainConfigTypeTypeDef

SmsMfaConfigTypeTypeDef#

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

LambdaConfigTypeTypeDef#

# LambdaConfigTypeTypeDef 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],
    CustomSMSSender: NotRequired[CustomSMSLambdaVersionConfigTypeTypeDef],  # (1)
    CustomEmailSender: NotRequired[CustomEmailLambdaVersionConfigTypeTypeDef],  # (2)
    KMSKeyID: NotRequired[str],
  1. See CustomSMSLambdaVersionConfigTypeTypeDef
  2. See CustomEmailLambdaVersionConfigTypeTypeDef

GetUICustomizationResponseTypeDef#

# GetUICustomizationResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetUICustomizationResponseTypeDef

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

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

SetUICustomizationResponseTypeDef#

# SetUICustomizationResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import SetUICustomizationResponseTypeDef

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

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

ListIdentityProvidersResponseTypeDef#

# ListIdentityProvidersResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListIdentityProvidersResponseTypeDef

def get_value() -> ListIdentityProvidersResponseTypeDef:
    return {
        "Providers": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListIdentityProvidersResponseTypeDef definition

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

ListUserPoolClientsResponseTypeDef#

# ListUserPoolClientsResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUserPoolClientsResponseTypeDef

def get_value() -> ListUserPoolClientsResponseTypeDef:
    return {
        "UserPoolClients": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListUserPoolClientsResponseTypeDef definition

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

NotifyConfigurationTypeTypeDef#

# NotifyConfigurationTypeTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import NotifyConfigurationTypeTypeDef

def get_value() -> NotifyConfigurationTypeTypeDef:
    return {
        "SourceArn": ...,
    }
# 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

UserPoolPolicyTypeTypeDef#

# UserPoolPolicyTypeTypeDef 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)
  1. See PasswordPolicyTypeTypeDef

SchemaAttributeTypeTypeDef#

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

AdminGetDeviceResponseTypeDef#

# AdminGetDeviceResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminGetDeviceResponseTypeDef

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

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

AdminListDevicesResponseTypeDef#

# AdminListDevicesResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminListDevicesResponseTypeDef

def get_value() -> AdminListDevicesResponseTypeDef:
    return {
        "Devices": ...,
        "PaginationToken": ...,
        "ResponseMetadata": ...,
    }
# AdminListDevicesResponseTypeDef definition

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

GetDeviceResponseTypeDef#

# GetDeviceResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import GetDeviceResponseTypeDef

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

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

ListDevicesResponseTypeDef#

# ListDevicesResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListDevicesResponseTypeDef

def get_value() -> ListDevicesResponseTypeDef:
    return {
        "Devices": ...,
        "PaginationToken": ...,
        "ResponseMetadata": ...,
    }
# ListDevicesResponseTypeDef definition

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

AdminCreateUserResponseTypeDef#

# AdminCreateUserResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminCreateUserResponseTypeDef

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

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

ListUsersInGroupResponseTypeDef#

# ListUsersInGroupResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersInGroupResponseTypeDef

def get_value() -> ListUsersInGroupResponseTypeDef:
    return {
        "Users": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListUsersInGroupResponseTypeDef definition

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

ListUsersResponseTypeDef#

# ListUsersResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import ListUsersResponseTypeDef

def get_value() -> ListUsersResponseTypeDef:
    return {
        "Users": ...,
        "PaginationToken": ...,
        "ResponseMetadata": ...,
    }
# ListUsersResponseTypeDef definition

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

AdminListUserAuthEventsResponseTypeDef#

# AdminListUserAuthEventsResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminListUserAuthEventsResponseTypeDef

def get_value() -> AdminListUserAuthEventsResponseTypeDef:
    return {
        "AuthEvents": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# AdminListUserAuthEventsResponseTypeDef definition

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

AdminInitiateAuthResponseTypeDef#

# AdminInitiateAuthResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminInitiateAuthResponseTypeDef

def get_value() -> AdminInitiateAuthResponseTypeDef:
    return {
        "ChallengeName": ...,
        "Session": ...,
        "ChallengeParameters": ...,
        "AuthenticationResult": ...,
        "ResponseMetadata": ...,
    }
# AdminInitiateAuthResponseTypeDef definition

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

AdminRespondToAuthChallengeResponseTypeDef#

# AdminRespondToAuthChallengeResponseTypeDef usage example

from mypy_boto3_cognito_idp.type_defs import AdminRespondToAuthChallengeResponseTypeDef

def get_value() -> AdminRespondToAuthChallengeResponseTypeDef:
    return {
        "ChallengeName": ...,
        "Session": ...,
        "ChallengeParameters": ...,
        "AuthenticationResult"