// // Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"). // You may not use this file except in compliance with the License. // A copy of the License is located at // // http://aws.amazon.com/apache2.0 // // or in the "license" file accompanying this file. This file is distributed // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either // express or implied. See the License for the specific language governing // permissions and limitations under the License. // #import #import #import NS_ASSUME_NONNULL_BEGIN FOUNDATION_EXPORT NSString *const AWSCognitoIdentityProviderErrorDomain; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderErrorType) { AWSCognitoIdentityProviderErrorUnknown, AWSCognitoIdentityProviderErrorAliasExists, AWSCognitoIdentityProviderErrorCodeDeliveryFailure, AWSCognitoIdentityProviderErrorCodeMismatch, AWSCognitoIdentityProviderErrorConcurrentModification, AWSCognitoIdentityProviderErrorDuplicateProvider, AWSCognitoIdentityProviderErrorEnableSoftwareTokenMFA, AWSCognitoIdentityProviderErrorExpiredCode, AWSCognitoIdentityProviderErrorForbidden, AWSCognitoIdentityProviderErrorGroupExists, AWSCognitoIdentityProviderErrorInternalError, AWSCognitoIdentityProviderErrorInvalidEmailRoleAccessPolicy, AWSCognitoIdentityProviderErrorInvalidLambdaResponse, AWSCognitoIdentityProviderErrorInvalidOAuthFlow, AWSCognitoIdentityProviderErrorInvalidParameter, AWSCognitoIdentityProviderErrorInvalidPassword, AWSCognitoIdentityProviderErrorInvalidSmsRoleAccessPolicy, AWSCognitoIdentityProviderErrorInvalidSmsRoleTrustRelationship, AWSCognitoIdentityProviderErrorInvalidUserPoolConfiguration, AWSCognitoIdentityProviderErrorLimitExceeded, AWSCognitoIdentityProviderErrorMFAMethodNotFound, AWSCognitoIdentityProviderErrorNotAuthorized, AWSCognitoIdentityProviderErrorPasswordResetRequired, AWSCognitoIdentityProviderErrorPreconditionNotMet, AWSCognitoIdentityProviderErrorResourceNotFound, AWSCognitoIdentityProviderErrorScopeDoesNotExist, AWSCognitoIdentityProviderErrorSoftwareTokenMFANotFound, AWSCognitoIdentityProviderErrorTooManyFailedAttempts, AWSCognitoIdentityProviderErrorTooManyRequests, AWSCognitoIdentityProviderErrorUnauthorized, AWSCognitoIdentityProviderErrorUnexpectedLambda, AWSCognitoIdentityProviderErrorUnsupportedIdentityProvider, AWSCognitoIdentityProviderErrorUnsupportedOperation, AWSCognitoIdentityProviderErrorUnsupportedTokenType, AWSCognitoIdentityProviderErrorUnsupportedUserState, AWSCognitoIdentityProviderErrorUserImportInProgress, AWSCognitoIdentityProviderErrorUserLambdaValidation, AWSCognitoIdentityProviderErrorUserNotConfirmed, AWSCognitoIdentityProviderErrorUserNotFound, AWSCognitoIdentityProviderErrorUserPoolAddOnNotEnabled, AWSCognitoIdentityProviderErrorUserPoolTagging, AWSCognitoIdentityProviderErrorUsernameExists, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderAccountTakeoverEventActionType) { AWSCognitoIdentityProviderAccountTakeoverEventActionTypeUnknown, AWSCognitoIdentityProviderAccountTakeoverEventActionTypeBlock, AWSCognitoIdentityProviderAccountTakeoverEventActionTypeMfaIfConfigured, AWSCognitoIdentityProviderAccountTakeoverEventActionTypeMfaRequired, AWSCognitoIdentityProviderAccountTakeoverEventActionTypeNoAction, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderAdvancedSecurityModeType) { AWSCognitoIdentityProviderAdvancedSecurityModeTypeUnknown, AWSCognitoIdentityProviderAdvancedSecurityModeTypeOff, AWSCognitoIdentityProviderAdvancedSecurityModeTypeAudit, AWSCognitoIdentityProviderAdvancedSecurityModeTypeEnforced, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderAliasAttributeType) { AWSCognitoIdentityProviderAliasAttributeTypeUnknown, AWSCognitoIdentityProviderAliasAttributeTypePhoneNumber, AWSCognitoIdentityProviderAliasAttributeTypeEmail, AWSCognitoIdentityProviderAliasAttributeTypePreferredUsername, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderAttributeDataType) { AWSCognitoIdentityProviderAttributeDataTypeUnknown, AWSCognitoIdentityProviderAttributeDataTypeString, AWSCognitoIdentityProviderAttributeDataTypeNumber, AWSCognitoIdentityProviderAttributeDataTypeDateTime, AWSCognitoIdentityProviderAttributeDataTypeBoolean, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderAuthFlowType) { AWSCognitoIdentityProviderAuthFlowTypeUnknown, AWSCognitoIdentityProviderAuthFlowTypeUserSrpAuth, AWSCognitoIdentityProviderAuthFlowTypeRefreshTokenAuth, AWSCognitoIdentityProviderAuthFlowTypeRefreshToken, AWSCognitoIdentityProviderAuthFlowTypeCustomAuth, AWSCognitoIdentityProviderAuthFlowTypeAdminNoSrpAuth, AWSCognitoIdentityProviderAuthFlowTypeUserPasswordAuth, AWSCognitoIdentityProviderAuthFlowTypeAdminUserPasswordAuth, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderChallengeName) { AWSCognitoIdentityProviderChallengeNameUnknown, AWSCognitoIdentityProviderChallengeNamePassword, AWSCognitoIdentityProviderChallengeNameMfa, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderChallengeNameType) { AWSCognitoIdentityProviderChallengeNameTypeUnknown, AWSCognitoIdentityProviderChallengeNameTypeSmsMfa, AWSCognitoIdentityProviderChallengeNameTypeSoftwareTokenMfa, AWSCognitoIdentityProviderChallengeNameTypeSelectMfaType, AWSCognitoIdentityProviderChallengeNameTypeMfaSetup, AWSCognitoIdentityProviderChallengeNameTypePasswordVerifier, AWSCognitoIdentityProviderChallengeNameTypeCustomChallenge, AWSCognitoIdentityProviderChallengeNameTypeDeviceSrpAuth, AWSCognitoIdentityProviderChallengeNameTypeDevicePasswordVerifier, AWSCognitoIdentityProviderChallengeNameTypeAdminNoSrpAuth, AWSCognitoIdentityProviderChallengeNameTypeNewPasswordRequired, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderChallengeResponse) { AWSCognitoIdentityProviderChallengeResponseUnknown, AWSCognitoIdentityProviderChallengeResponseSuccess, AWSCognitoIdentityProviderChallengeResponseFailure, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderCompromisedCredentialsEventActionType) { AWSCognitoIdentityProviderCompromisedCredentialsEventActionTypeUnknown, AWSCognitoIdentityProviderCompromisedCredentialsEventActionTypeBlock, AWSCognitoIdentityProviderCompromisedCredentialsEventActionTypeNoAction, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderCustomEmailSenderLambdaVersionType) { AWSCognitoIdentityProviderCustomEmailSenderLambdaVersionTypeUnknown, AWSCognitoIdentityProviderCustomEmailSenderLambdaVersionTypeV10, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderCustomSMSSenderLambdaVersionType) { AWSCognitoIdentityProviderCustomSMSSenderLambdaVersionTypeUnknown, AWSCognitoIdentityProviderCustomSMSSenderLambdaVersionTypeV10, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderDefaultEmailOptionType) { AWSCognitoIdentityProviderDefaultEmailOptionTypeUnknown, AWSCognitoIdentityProviderDefaultEmailOptionTypeConfirmWithLink, AWSCognitoIdentityProviderDefaultEmailOptionTypeConfirmWithCode, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderDeletionProtectionType) { AWSCognitoIdentityProviderDeletionProtectionTypeUnknown, AWSCognitoIdentityProviderDeletionProtectionTypeActive, AWSCognitoIdentityProviderDeletionProtectionTypeInactive, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderDeliveryMediumType) { AWSCognitoIdentityProviderDeliveryMediumTypeUnknown, AWSCognitoIdentityProviderDeliveryMediumTypeSms, AWSCognitoIdentityProviderDeliveryMediumTypeEmail, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderDeviceRememberedStatusType) { AWSCognitoIdentityProviderDeviceRememberedStatusTypeUnknown, AWSCognitoIdentityProviderDeviceRememberedStatusTypeRemembered, AWSCognitoIdentityProviderDeviceRememberedStatusTypeNotRemembered, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderDomainStatusType) { AWSCognitoIdentityProviderDomainStatusTypeUnknown, AWSCognitoIdentityProviderDomainStatusTypeCreating, AWSCognitoIdentityProviderDomainStatusTypeDeleting, AWSCognitoIdentityProviderDomainStatusTypeUpdating, AWSCognitoIdentityProviderDomainStatusTypeActive, AWSCognitoIdentityProviderDomainStatusTypeFailed, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderEmailSendingAccountType) { AWSCognitoIdentityProviderEmailSendingAccountTypeUnknown, AWSCognitoIdentityProviderEmailSendingAccountTypeCognitoDefault, AWSCognitoIdentityProviderEmailSendingAccountTypeDeveloper, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderEventFilterType) { AWSCognitoIdentityProviderEventFilterTypeUnknown, AWSCognitoIdentityProviderEventFilterTypeSignIn, AWSCognitoIdentityProviderEventFilterTypePasswordChange, AWSCognitoIdentityProviderEventFilterTypeSignUp, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderEventResponseType) { AWSCognitoIdentityProviderEventResponseTypeUnknown, AWSCognitoIdentityProviderEventResponseTypePass, AWSCognitoIdentityProviderEventResponseTypeFail, AWSCognitoIdentityProviderEventResponseTypeInProgress, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderEventType) { AWSCognitoIdentityProviderEventTypeUnknown, AWSCognitoIdentityProviderEventTypeSignIn, AWSCognitoIdentityProviderEventTypeSignUp, AWSCognitoIdentityProviderEventTypeForgotPassword, AWSCognitoIdentityProviderEventTypePasswordChange, AWSCognitoIdentityProviderEventTypeResendCode, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderExplicitAuthFlowsType) { AWSCognitoIdentityProviderExplicitAuthFlowsTypeUnknown, AWSCognitoIdentityProviderExplicitAuthFlowsTypeAdminNoSrpAuth, AWSCognitoIdentityProviderExplicitAuthFlowsTypeCustomAuthFlowOnly, AWSCognitoIdentityProviderExplicitAuthFlowsTypeUserPasswordAuth, AWSCognitoIdentityProviderExplicitAuthFlowsTypeAllowAdminUserPasswordAuth, AWSCognitoIdentityProviderExplicitAuthFlowsTypeAllowCustomAuth, AWSCognitoIdentityProviderExplicitAuthFlowsTypeAllowUserPasswordAuth, AWSCognitoIdentityProviderExplicitAuthFlowsTypeAllowUserSrpAuth, AWSCognitoIdentityProviderExplicitAuthFlowsTypeAllowRefreshTokenAuth, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderFeedbackValueType) { AWSCognitoIdentityProviderFeedbackValueTypeUnknown, AWSCognitoIdentityProviderFeedbackValueTypeValid, AWSCognitoIdentityProviderFeedbackValueTypeInvalid, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderIdentityProviderTypeType) { AWSCognitoIdentityProviderIdentityProviderTypeTypeUnknown, AWSCognitoIdentityProviderIdentityProviderTypeTypeSaml, AWSCognitoIdentityProviderIdentityProviderTypeTypeFacebook, AWSCognitoIdentityProviderIdentityProviderTypeTypeGoogle, AWSCognitoIdentityProviderIdentityProviderTypeTypeLoginWithAmazon, AWSCognitoIdentityProviderIdentityProviderTypeTypeSignInWithApple, AWSCognitoIdentityProviderIdentityProviderTypeTypeOidc, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderMessageActionType) { AWSCognitoIdentityProviderMessageActionTypeUnknown, AWSCognitoIdentityProviderMessageActionTypeResend, AWSCognitoIdentityProviderMessageActionTypeSuppress, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderOAuthFlowType) { AWSCognitoIdentityProviderOAuthFlowTypeUnknown, AWSCognitoIdentityProviderOAuthFlowTypeCode, AWSCognitoIdentityProviderOAuthFlowTypeImplicit, AWSCognitoIdentityProviderOAuthFlowTypeClientCredentials, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderPreventUserExistenceErrorTypes) { AWSCognitoIdentityProviderPreventUserExistenceErrorTypesUnknown, AWSCognitoIdentityProviderPreventUserExistenceErrorTypesLegacy, AWSCognitoIdentityProviderPreventUserExistenceErrorTypesEnabled, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderRecoveryOptionNameType) { AWSCognitoIdentityProviderRecoveryOptionNameTypeUnknown, AWSCognitoIdentityProviderRecoveryOptionNameTypeVerifiedEmail, AWSCognitoIdentityProviderRecoveryOptionNameTypeVerifiedPhoneNumber, AWSCognitoIdentityProviderRecoveryOptionNameTypeAdminOnly, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderRiskDecisionType) { AWSCognitoIdentityProviderRiskDecisionTypeUnknown, AWSCognitoIdentityProviderRiskDecisionTypeNoRisk, AWSCognitoIdentityProviderRiskDecisionTypeAccountTakeover, AWSCognitoIdentityProviderRiskDecisionTypeBlock, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderRiskLevelType) { AWSCognitoIdentityProviderRiskLevelTypeUnknown, AWSCognitoIdentityProviderRiskLevelTypeLow, AWSCognitoIdentityProviderRiskLevelTypeMedium, AWSCognitoIdentityProviderRiskLevelTypeHigh, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderStatusType) { AWSCognitoIdentityProviderStatusTypeUnknown, AWSCognitoIdentityProviderStatusTypeEnabled, AWSCognitoIdentityProviderStatusTypeDisabled, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderTimeUnitsType) { AWSCognitoIdentityProviderTimeUnitsTypeUnknown, AWSCognitoIdentityProviderTimeUnitsTypeSeconds, AWSCognitoIdentityProviderTimeUnitsTypeMinutes, AWSCognitoIdentityProviderTimeUnitsTypeHours, AWSCognitoIdentityProviderTimeUnitsTypeDays, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderUserImportJobStatusType) { AWSCognitoIdentityProviderUserImportJobStatusTypeUnknown, AWSCognitoIdentityProviderUserImportJobStatusTypeCreated, AWSCognitoIdentityProviderUserImportJobStatusTypePending, AWSCognitoIdentityProviderUserImportJobStatusTypeInProgress, AWSCognitoIdentityProviderUserImportJobStatusTypeStopping, AWSCognitoIdentityProviderUserImportJobStatusTypeExpired, AWSCognitoIdentityProviderUserImportJobStatusTypeStopped, AWSCognitoIdentityProviderUserImportJobStatusTypeFailed, AWSCognitoIdentityProviderUserImportJobStatusTypeSucceeded, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderUserPoolMfaType) { AWSCognitoIdentityProviderUserPoolMfaTypeUnknown, AWSCognitoIdentityProviderUserPoolMfaTypeOff, AWSCognitoIdentityProviderUserPoolMfaTypeOn, AWSCognitoIdentityProviderUserPoolMfaTypeOptional, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderUserStatusType) { AWSCognitoIdentityProviderUserStatusTypeUnknown, AWSCognitoIdentityProviderUserStatusTypeUnconfirmed, AWSCognitoIdentityProviderUserStatusTypeConfirmed, AWSCognitoIdentityProviderUserStatusTypeArchived, AWSCognitoIdentityProviderUserStatusTypeCompromised, AWSCognitoIdentityProviderUserStatusTypeResetRequired, AWSCognitoIdentityProviderUserStatusTypeForceChangePassword, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderUsernameAttributeType) { AWSCognitoIdentityProviderUsernameAttributeTypeUnknown, AWSCognitoIdentityProviderUsernameAttributeTypePhoneNumber, AWSCognitoIdentityProviderUsernameAttributeTypeEmail, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderVerifiedAttributeType) { AWSCognitoIdentityProviderVerifiedAttributeTypeUnknown, AWSCognitoIdentityProviderVerifiedAttributeTypePhoneNumber, AWSCognitoIdentityProviderVerifiedAttributeTypeEmail, }; typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderVerifySoftwareTokenResponseType) { AWSCognitoIdentityProviderVerifySoftwareTokenResponseTypeUnknown, AWSCognitoIdentityProviderVerifySoftwareTokenResponseTypeSuccess, AWSCognitoIdentityProviderVerifySoftwareTokenResponseTypeError, }; @class AWSCognitoIdentityProviderAccountRecoverySettingType; @class AWSCognitoIdentityProviderAccountTakeoverActionType; @class AWSCognitoIdentityProviderAccountTakeoverActionsType; @class AWSCognitoIdentityProviderAccountTakeoverRiskConfigurationType; @class AWSCognitoIdentityProviderAddCustomAttributesRequest; @class AWSCognitoIdentityProviderAddCustomAttributesResponse; @class AWSCognitoIdentityProviderAdminAddUserToGroupRequest; @class AWSCognitoIdentityProviderAdminConfirmSignUpRequest; @class AWSCognitoIdentityProviderAdminConfirmSignUpResponse; @class AWSCognitoIdentityProviderAdminCreateUserConfigType; @class AWSCognitoIdentityProviderAdminCreateUserRequest; @class AWSCognitoIdentityProviderAdminCreateUserResponse; @class AWSCognitoIdentityProviderAdminDeleteUserAttributesRequest; @class AWSCognitoIdentityProviderAdminDeleteUserAttributesResponse; @class AWSCognitoIdentityProviderAdminDeleteUserRequest; @class AWSCognitoIdentityProviderAdminDisableProviderForUserRequest; @class AWSCognitoIdentityProviderAdminDisableProviderForUserResponse; @class AWSCognitoIdentityProviderAdminDisableUserRequest; @class AWSCognitoIdentityProviderAdminDisableUserResponse; @class AWSCognitoIdentityProviderAdminEnableUserRequest; @class AWSCognitoIdentityProviderAdminEnableUserResponse; @class AWSCognitoIdentityProviderAdminForgetDeviceRequest; @class AWSCognitoIdentityProviderAdminGetDeviceRequest; @class AWSCognitoIdentityProviderAdminGetDeviceResponse; @class AWSCognitoIdentityProviderAdminGetUserRequest; @class AWSCognitoIdentityProviderAdminGetUserResponse; @class AWSCognitoIdentityProviderAdminInitiateAuthRequest; @class AWSCognitoIdentityProviderAdminInitiateAuthResponse; @class AWSCognitoIdentityProviderAdminLinkProviderForUserRequest; @class AWSCognitoIdentityProviderAdminLinkProviderForUserResponse; @class AWSCognitoIdentityProviderAdminListDevicesRequest; @class AWSCognitoIdentityProviderAdminListDevicesResponse; @class AWSCognitoIdentityProviderAdminListGroupsForUserRequest; @class AWSCognitoIdentityProviderAdminListGroupsForUserResponse; @class AWSCognitoIdentityProviderAdminListUserAuthEventsRequest; @class AWSCognitoIdentityProviderAdminListUserAuthEventsResponse; @class AWSCognitoIdentityProviderAdminRemoveUserFromGroupRequest; @class AWSCognitoIdentityProviderAdminResetUserPasswordRequest; @class AWSCognitoIdentityProviderAdminResetUserPasswordResponse; @class AWSCognitoIdentityProviderAdminRespondToAuthChallengeRequest; @class AWSCognitoIdentityProviderAdminRespondToAuthChallengeResponse; @class AWSCognitoIdentityProviderAdminSetUserMFAPreferenceRequest; @class AWSCognitoIdentityProviderAdminSetUserMFAPreferenceResponse; @class AWSCognitoIdentityProviderAdminSetUserPasswordRequest; @class AWSCognitoIdentityProviderAdminSetUserPasswordResponse; @class AWSCognitoIdentityProviderAdminSetUserSettingsRequest; @class AWSCognitoIdentityProviderAdminSetUserSettingsResponse; @class AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackRequest; @class AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackResponse; @class AWSCognitoIdentityProviderAdminUpdateDeviceStatusRequest; @class AWSCognitoIdentityProviderAdminUpdateDeviceStatusResponse; @class AWSCognitoIdentityProviderAdminUpdateUserAttributesRequest; @class AWSCognitoIdentityProviderAdminUpdateUserAttributesResponse; @class AWSCognitoIdentityProviderAdminUserGlobalSignOutRequest; @class AWSCognitoIdentityProviderAdminUserGlobalSignOutResponse; @class AWSCognitoIdentityProviderAnalyticsConfigurationType; @class AWSCognitoIdentityProviderAnalyticsMetadataType; @class AWSCognitoIdentityProviderAssociateSoftwareTokenRequest; @class AWSCognitoIdentityProviderAssociateSoftwareTokenResponse; @class AWSCognitoIdentityProviderAttributeType; @class AWSCognitoIdentityProviderAuthEventType; @class AWSCognitoIdentityProviderAuthenticationResultType; @class AWSCognitoIdentityProviderChallengeResponseType; @class AWSCognitoIdentityProviderChangePasswordRequest; @class AWSCognitoIdentityProviderChangePasswordResponse; @class AWSCognitoIdentityProviderCodeDeliveryDetailsType; @class AWSCognitoIdentityProviderCompromisedCredentialsActionsType; @class AWSCognitoIdentityProviderCompromisedCredentialsRiskConfigurationType; @class AWSCognitoIdentityProviderConfirmDeviceRequest; @class AWSCognitoIdentityProviderConfirmDeviceResponse; @class AWSCognitoIdentityProviderConfirmForgotPasswordRequest; @class AWSCognitoIdentityProviderConfirmForgotPasswordResponse; @class AWSCognitoIdentityProviderConfirmSignUpRequest; @class AWSCognitoIdentityProviderConfirmSignUpResponse; @class AWSCognitoIdentityProviderContextDataType; @class AWSCognitoIdentityProviderCreateGroupRequest; @class AWSCognitoIdentityProviderCreateGroupResponse; @class AWSCognitoIdentityProviderCreateIdentityProviderRequest; @class AWSCognitoIdentityProviderCreateIdentityProviderResponse; @class AWSCognitoIdentityProviderCreateResourceServerRequest; @class AWSCognitoIdentityProviderCreateResourceServerResponse; @class AWSCognitoIdentityProviderCreateUserImportJobRequest; @class AWSCognitoIdentityProviderCreateUserImportJobResponse; @class AWSCognitoIdentityProviderCreateUserPoolClientRequest; @class AWSCognitoIdentityProviderCreateUserPoolClientResponse; @class AWSCognitoIdentityProviderCreateUserPoolDomainRequest; @class AWSCognitoIdentityProviderCreateUserPoolDomainResponse; @class AWSCognitoIdentityProviderCreateUserPoolRequest; @class AWSCognitoIdentityProviderCreateUserPoolResponse; @class AWSCognitoIdentityProviderCustomDomainConfigType; @class AWSCognitoIdentityProviderCustomEmailLambdaVersionConfigType; @class AWSCognitoIdentityProviderCustomSMSLambdaVersionConfigType; @class AWSCognitoIdentityProviderDeleteGroupRequest; @class AWSCognitoIdentityProviderDeleteIdentityProviderRequest; @class AWSCognitoIdentityProviderDeleteResourceServerRequest; @class AWSCognitoIdentityProviderDeleteUserAttributesRequest; @class AWSCognitoIdentityProviderDeleteUserAttributesResponse; @class AWSCognitoIdentityProviderDeleteUserPoolClientRequest; @class AWSCognitoIdentityProviderDeleteUserPoolDomainRequest; @class AWSCognitoIdentityProviderDeleteUserPoolDomainResponse; @class AWSCognitoIdentityProviderDeleteUserPoolRequest; @class AWSCognitoIdentityProviderDeleteUserRequest; @class AWSCognitoIdentityProviderDescribeIdentityProviderRequest; @class AWSCognitoIdentityProviderDescribeIdentityProviderResponse; @class AWSCognitoIdentityProviderDescribeResourceServerRequest; @class AWSCognitoIdentityProviderDescribeResourceServerResponse; @class AWSCognitoIdentityProviderDescribeRiskConfigurationRequest; @class AWSCognitoIdentityProviderDescribeRiskConfigurationResponse; @class AWSCognitoIdentityProviderDescribeUserImportJobRequest; @class AWSCognitoIdentityProviderDescribeUserImportJobResponse; @class AWSCognitoIdentityProviderDescribeUserPoolClientRequest; @class AWSCognitoIdentityProviderDescribeUserPoolClientResponse; @class AWSCognitoIdentityProviderDescribeUserPoolDomainRequest; @class AWSCognitoIdentityProviderDescribeUserPoolDomainResponse; @class AWSCognitoIdentityProviderDescribeUserPoolRequest; @class AWSCognitoIdentityProviderDescribeUserPoolResponse; @class AWSCognitoIdentityProviderDeviceConfigurationType; @class AWSCognitoIdentityProviderDeviceSecretVerifierConfigType; @class AWSCognitoIdentityProviderDeviceType; @class AWSCognitoIdentityProviderDomainDescriptionType; @class AWSCognitoIdentityProviderEmailConfigurationType; @class AWSCognitoIdentityProviderEventContextDataType; @class AWSCognitoIdentityProviderEventFeedbackType; @class AWSCognitoIdentityProviderEventRiskType; @class AWSCognitoIdentityProviderForgetDeviceRequest; @class AWSCognitoIdentityProviderForgotPasswordRequest; @class AWSCognitoIdentityProviderForgotPasswordResponse; @class AWSCognitoIdentityProviderGetCSVHeaderRequest; @class AWSCognitoIdentityProviderGetCSVHeaderResponse; @class AWSCognitoIdentityProviderGetDeviceRequest; @class AWSCognitoIdentityProviderGetDeviceResponse; @class AWSCognitoIdentityProviderGetGroupRequest; @class AWSCognitoIdentityProviderGetGroupResponse; @class AWSCognitoIdentityProviderGetIdentityProviderByIdentifierRequest; @class AWSCognitoIdentityProviderGetIdentityProviderByIdentifierResponse; @class AWSCognitoIdentityProviderGetSigningCertificateRequest; @class AWSCognitoIdentityProviderGetSigningCertificateResponse; @class AWSCognitoIdentityProviderGetUICustomizationRequest; @class AWSCognitoIdentityProviderGetUICustomizationResponse; @class AWSCognitoIdentityProviderGetUserAttributeVerificationCodeRequest; @class AWSCognitoIdentityProviderGetUserAttributeVerificationCodeResponse; @class AWSCognitoIdentityProviderGetUserPoolMfaConfigRequest; @class AWSCognitoIdentityProviderGetUserPoolMfaConfigResponse; @class AWSCognitoIdentityProviderGetUserRequest; @class AWSCognitoIdentityProviderGetUserResponse; @class AWSCognitoIdentityProviderGlobalSignOutRequest; @class AWSCognitoIdentityProviderGlobalSignOutResponse; @class AWSCognitoIdentityProviderGroupType; @class AWSCognitoIdentityProviderHttpHeader; @class AWSCognitoIdentityProviderIdentityProviderType; @class AWSCognitoIdentityProviderInitiateAuthRequest; @class AWSCognitoIdentityProviderInitiateAuthResponse; @class AWSCognitoIdentityProviderLambdaConfigType; @class AWSCognitoIdentityProviderListDevicesRequest; @class AWSCognitoIdentityProviderListDevicesResponse; @class AWSCognitoIdentityProviderListGroupsRequest; @class AWSCognitoIdentityProviderListGroupsResponse; @class AWSCognitoIdentityProviderListIdentityProvidersRequest; @class AWSCognitoIdentityProviderListIdentityProvidersResponse; @class AWSCognitoIdentityProviderListResourceServersRequest; @class AWSCognitoIdentityProviderListResourceServersResponse; @class AWSCognitoIdentityProviderListTagsForResourceRequest; @class AWSCognitoIdentityProviderListTagsForResourceResponse; @class AWSCognitoIdentityProviderListUserImportJobsRequest; @class AWSCognitoIdentityProviderListUserImportJobsResponse; @class AWSCognitoIdentityProviderListUserPoolClientsRequest; @class AWSCognitoIdentityProviderListUserPoolClientsResponse; @class AWSCognitoIdentityProviderListUserPoolsRequest; @class AWSCognitoIdentityProviderListUserPoolsResponse; @class AWSCognitoIdentityProviderListUsersInGroupRequest; @class AWSCognitoIdentityProviderListUsersInGroupResponse; @class AWSCognitoIdentityProviderListUsersRequest; @class AWSCognitoIdentityProviderListUsersResponse; @class AWSCognitoIdentityProviderMFAOptionType; @class AWSCognitoIdentityProviderMessageTemplateType; @class AWSCognitoIdentityProviderLatestDeviceMetadataType; @class AWSCognitoIdentityProviderNotifyConfigurationType; @class AWSCognitoIdentityProviderNotifyEmailType; @class AWSCognitoIdentityProviderNumberAttributeConstraintsType; @class AWSCognitoIdentityProviderPasswordPolicyType; @class AWSCognitoIdentityProviderProviderDescription; @class AWSCognitoIdentityProviderProviderUserIdentifierType; @class AWSCognitoIdentityProviderRecoveryOptionType; @class AWSCognitoIdentityProviderResendConfirmationCodeRequest; @class AWSCognitoIdentityProviderResendConfirmationCodeResponse; @class AWSCognitoIdentityProviderResourceServerScopeType; @class AWSCognitoIdentityProviderResourceServerType; @class AWSCognitoIdentityProviderRespondToAuthChallengeRequest; @class AWSCognitoIdentityProviderRespondToAuthChallengeResponse; @class AWSCognitoIdentityProviderRevokeTokenRequest; @class AWSCognitoIdentityProviderRevokeTokenResponse; @class AWSCognitoIdentityProviderRiskConfigurationType; @class AWSCognitoIdentityProviderRiskExceptionConfigurationType; @class AWSCognitoIdentityProviderSMSMfaSettingsType; @class AWSCognitoIdentityProviderSchemaAttributeType; @class AWSCognitoIdentityProviderSetRiskConfigurationRequest; @class AWSCognitoIdentityProviderSetRiskConfigurationResponse; @class AWSCognitoIdentityProviderSetUICustomizationRequest; @class AWSCognitoIdentityProviderSetUICustomizationResponse; @class AWSCognitoIdentityProviderSetUserMFAPreferenceRequest; @class AWSCognitoIdentityProviderSetUserMFAPreferenceResponse; @class AWSCognitoIdentityProviderSetUserPoolMfaConfigRequest; @class AWSCognitoIdentityProviderSetUserPoolMfaConfigResponse; @class AWSCognitoIdentityProviderSetUserSettingsRequest; @class AWSCognitoIdentityProviderSetUserSettingsResponse; @class AWSCognitoIdentityProviderSignUpRequest; @class AWSCognitoIdentityProviderSignUpResponse; @class AWSCognitoIdentityProviderSmsConfigurationType; @class AWSCognitoIdentityProviderSmsMfaConfigType; @class AWSCognitoIdentityProviderSoftwareTokenMfaConfigType; @class AWSCognitoIdentityProviderSoftwareTokenMfaSettingsType; @class AWSCognitoIdentityProviderStartUserImportJobRequest; @class AWSCognitoIdentityProviderStartUserImportJobResponse; @class AWSCognitoIdentityProviderStopUserImportJobRequest; @class AWSCognitoIdentityProviderStopUserImportJobResponse; @class AWSCognitoIdentityProviderStringAttributeConstraintsType; @class AWSCognitoIdentityProviderTagResourceRequest; @class AWSCognitoIdentityProviderTagResourceResponse; @class AWSCognitoIdentityProviderTokenValidityUnitsType; @class AWSCognitoIdentityProviderUICustomizationType; @class AWSCognitoIdentityProviderUntagResourceRequest; @class AWSCognitoIdentityProviderUntagResourceResponse; @class AWSCognitoIdentityProviderUpdateAuthEventFeedbackRequest; @class AWSCognitoIdentityProviderUpdateAuthEventFeedbackResponse; @class AWSCognitoIdentityProviderUpdateDeviceStatusRequest; @class AWSCognitoIdentityProviderUpdateDeviceStatusResponse; @class AWSCognitoIdentityProviderUpdateGroupRequest; @class AWSCognitoIdentityProviderUpdateGroupResponse; @class AWSCognitoIdentityProviderUpdateIdentityProviderRequest; @class AWSCognitoIdentityProviderUpdateIdentityProviderResponse; @class AWSCognitoIdentityProviderUpdateResourceServerRequest; @class AWSCognitoIdentityProviderUpdateResourceServerResponse; @class AWSCognitoIdentityProviderUpdateUserAttributesRequest; @class AWSCognitoIdentityProviderUpdateUserAttributesResponse; @class AWSCognitoIdentityProviderUpdateUserPoolClientRequest; @class AWSCognitoIdentityProviderUpdateUserPoolClientResponse; @class AWSCognitoIdentityProviderUpdateUserPoolDomainRequest; @class AWSCognitoIdentityProviderUpdateUserPoolDomainResponse; @class AWSCognitoIdentityProviderUpdateUserPoolRequest; @class AWSCognitoIdentityProviderUpdateUserPoolResponse; @class AWSCognitoIdentityProviderUserAttributeUpdateSettingsType; @class AWSCognitoIdentityProviderUserContextDataType; @class AWSCognitoIdentityProviderUserImportJobType; @class AWSCognitoIdentityProviderUserPoolAddOnsType; @class AWSCognitoIdentityProviderUserPoolClientDescription; @class AWSCognitoIdentityProviderUserPoolClientType; @class AWSCognitoIdentityProviderUserPoolDescriptionType; @class AWSCognitoIdentityProviderUserPoolPolicyType; @class AWSCognitoIdentityProviderUserPoolType; @class AWSCognitoIdentityProviderUserType; @class AWSCognitoIdentityProviderUsernameConfigurationType; @class AWSCognitoIdentityProviderVerificationMessageTemplateType; @class AWSCognitoIdentityProviderVerifySoftwareTokenRequest; @class AWSCognitoIdentityProviderVerifySoftwareTokenResponse; @class AWSCognitoIdentityProviderVerifyUserAttributeRequest; @class AWSCognitoIdentityProviderVerifyUserAttributeResponse; /**

The data type for AccountRecoverySetting.

*/ @interface AWSCognitoIdentityProviderAccountRecoverySettingType : AWSModel /**

The list of RecoveryOptionTypes.

*/ @property (nonatomic, strong) NSArray * _Nullable recoveryMechanisms; @end /**

Account takeover action type.

Required parameters: [Notify, EventAction] */ @interface AWSCognitoIdentityProviderAccountTakeoverActionType : AWSModel /**

The action to take in response to the account takeover action. Valid values are as follows:

  • BLOCK Choosing this action will block the request.

  • MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.

  • MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.

  • NO_ACTION Allow the user to sign in.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderAccountTakeoverEventActionType eventAction; /**

Flag specifying whether to send a notification.

*/ @property (nonatomic, strong) NSNumber * _Nullable notify; @end /**

Account takeover actions type.

*/ @interface AWSCognitoIdentityProviderAccountTakeoverActionsType : AWSModel /**

Action to take for a high risk.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverActionType * _Nullable highAction; /**

Action to take for a low risk.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverActionType * _Nullable lowAction; /**

Action to take for a medium risk.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverActionType * _Nullable mediumAction; @end /**

Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.

Required parameters: [Actions] */ @interface AWSCognitoIdentityProviderAccountTakeoverRiskConfigurationType : AWSModel /**

Account takeover risk configuration actions.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverActionsType * _Nullable actions; /**

The notify configuration used to construct email notifications.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderNotifyConfigurationType * _Nullable notifyConfiguration; @end /**

Represents the request to add custom attributes.

Required parameters: [UserPoolId, CustomAttributes] */ @interface AWSCognitoIdentityProviderAddCustomAttributesRequest : AWSRequest /**

An array of custom attributes, such as Mutable and Name.

*/ @property (nonatomic, strong) NSArray * _Nullable customAttributes; /**

The user pool ID for the user pool where you want to add custom attributes.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the response from the server for the request to add custom attributes.

*/ @interface AWSCognitoIdentityProviderAddCustomAttributesResponse : AWSModel @end /** */ @interface AWSCognitoIdentityProviderAdminAddUserToGroupRequest : AWSRequest /**

The group name.

*/ @property (nonatomic, strong) NSString * _Nullable groupName; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The username for the user.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the request to confirm user registration.

Required parameters: [UserPoolId, Username] */ @interface AWSCognitoIdentityProviderAdminConfirmSignUpRequest : AWSRequest /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

The user pool ID for which you want to confirm user registration.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name for which you want to confirm user registration.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the response from the server for the request to confirm registration.

*/ @interface AWSCognitoIdentityProviderAdminConfirmSignUpResponse : AWSModel @end /**

The configuration for creating a new user profile.

*/ @interface AWSCognitoIdentityProviderAdminCreateUserConfigType : AWSModel /**

Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

*/ @property (nonatomic, strong) NSNumber * _Nullable allowAdminCreateUserOnly; /**

The message template to be used for the welcome message to new users.

See also Customizing User Invitation Messages.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderMessageTemplateType * _Nullable inviteMessageTemplate; /**

The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.

 */ @property (nonatomic, strong) NSNumber * _Nullable unusedAccountValidityDays; @end /**

Represents the request to create a user in the specified user pool.

Required parameters: [UserPoolId, Username] */ @interface AWSCognitoIdentityProviderAdminCreateUserRequest : AWSRequest /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". You can specify more than one value.

*/ @property (nonatomic, strong) NSArray * _Nullable desiredDeliveryMediums; /**

This parameter is used only if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.

If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.

If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.

*/ @property (nonatomic, strong) NSNumber * _Nullable forceAliasCreation; /**

Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to SUPPRESS to suppress sending the message. You can specify only one value.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderMessageActionType messageAction; /**

The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.

The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.

This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.

The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.

*/ @property (nonatomic, strong) NSString * _Nullable temporaryPassword; /**

An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign up in response to your welcome message).

For custom attributes, you must prepend the custom: prefix to the attribute name.

To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. You can also do this by calling AdminUpdateUserAttributes.

  • email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.

  • phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.

*/ @property (nonatomic, strong) NSArray * _Nullable userAttributes; /**

The user pool ID for the user pool where the user will be created.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.

*/ @property (nonatomic, strong) NSString * _Nullable username; /**

The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.

To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.

The user's validation data isn't persisted.

*/ @property (nonatomic, strong) NSArray * _Nullable validationData; @end /**

Represents the response from the server to the request to create the user.

*/ @interface AWSCognitoIdentityProviderAdminCreateUserResponse : AWSModel /**

The newly created user.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserType * _Nullable user; @end /**

Represents the request to delete user attributes as an administrator.

Required parameters: [UserPoolId, Username, UserAttributeNames] */ @interface AWSCognitoIdentityProviderAdminDeleteUserAttributesRequest : AWSRequest /**

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

*/ @property (nonatomic, strong) NSArray * _Nullable userAttributeNames; /**

The user pool ID for the user pool where you want to delete user attributes.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name of the user from which you would like to delete attributes.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the response received from the server for a request to delete user attributes.

*/ @interface AWSCognitoIdentityProviderAdminDeleteUserAttributesResponse : AWSModel @end /**

Represents the request to delete a user as an administrator.

Required parameters: [UserPoolId, Username] */ @interface AWSCognitoIdentityProviderAdminDeleteUserRequest : AWSRequest /**

The user pool ID for the user pool where you want to delete the user.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name of the user you want to delete.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /** */ @interface AWSCognitoIdentityProviderAdminDisableProviderForUserRequest : AWSRequest /**

The user to be disabled.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderProviderUserIdentifierType * _Nullable user; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderAdminDisableProviderForUserResponse : AWSModel @end /**

Represents the request to disable the user as an administrator.

Required parameters: [UserPoolId, Username] */ @interface AWSCognitoIdentityProviderAdminDisableUserRequest : AWSRequest /**

The user pool ID for the user pool where you want to disable the user.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name of the user you want to disable.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the response received from the server to disable the user as an administrator.

*/ @interface AWSCognitoIdentityProviderAdminDisableUserResponse : AWSModel @end /**

Represents the request that enables the user as an administrator.

Required parameters: [UserPoolId, Username] */ @interface AWSCognitoIdentityProviderAdminEnableUserRequest : AWSRequest /**

The user pool ID for the user pool where you want to enable the user.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name of the user you want to enable.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the response from the server for the request to enable a user as an administrator.

*/ @interface AWSCognitoIdentityProviderAdminEnableUserResponse : AWSModel @end /**

Sends the forgot device request, as an administrator.

Required parameters: [UserPoolId, Username, DeviceKey] */ @interface AWSCognitoIdentityProviderAdminForgetDeviceRequest : AWSRequest /**

The device key.

*/ @property (nonatomic, strong) NSString * _Nullable deviceKey; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the request to get the device, as an administrator.

Required parameters: [DeviceKey, UserPoolId, Username] */ @interface AWSCognitoIdentityProviderAdminGetDeviceRequest : AWSRequest /**

The device key.

*/ @property (nonatomic, strong) NSString * _Nullable deviceKey; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Gets the device response, as an administrator.

Required parameters: [Device] */ @interface AWSCognitoIdentityProviderAdminGetDeviceResponse : AWSModel /**

The device.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceType * _Nullable device; @end /**

Represents the request to get the specified user as an administrator.

Required parameters: [UserPoolId, Username] */ @interface AWSCognitoIdentityProviderAdminGetUserRequest : AWSRequest /**

The user pool ID for the user pool where you want to get information about the user.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name of the user you want to retrieve.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the response from the server from the request to get the specified user as an administrator.

Required parameters: [Username] */ @interface AWSCognitoIdentityProviderAdminGetUserResponse : AWSModel /**

Indicates that the status is enabled.

*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

*/ @property (nonatomic, strong) NSArray * _Nullable MFAOptions; /**

The user's preferred MFA setting.

*/ @property (nonatomic, strong) NSString * _Nullable preferredMfaSetting; /**

An array of name-value pairs representing user attributes.

*/ @property (nonatomic, strong) NSArray * _Nullable userAttributes; /**

The date the user was created.

*/ @property (nonatomic, strong) NSDate * _Nullable userCreateDate; /**

The date the user was last modified.

*/ @property (nonatomic, strong) NSDate * _Nullable userLastModifiedDate; /**

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

*/ @property (nonatomic, strong) NSArray * _Nullable userMFASettingList; /**

The user status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • ARCHIVED - User is no longer active.

  • UNKNOWN - User status isn't known.

  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

  • FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderUserStatusType userStatus; /**

The user name of the user about whom you're receiving information.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Initiates the authorization request, as an administrator.

Required parameters: [UserPoolId, ClientId, AuthFlow] */ @interface AWSCognitoIdentityProviderAdminInitiateAuthRequest : AWSRequest /**

The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata; /**

The authentication flow for this call to run. The API action will depend on this value. For example:

  • REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.

  • USER_SRP_AUTH will take in USERNAME and SRP_A and return the Secure Remote Password (SRP) protocol variables to be used for next challenge execution.

  • ADMIN_USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

Valid values include:

  • USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

  • REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

  • CUSTOM_AUTH: Custom authentication flow.

  • ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.

  • ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderAuthFlowType authFlow; /**

The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow:

  • For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

  • For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

  • For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY.

  • For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

*/ @property (nonatomic, strong) NSDictionary * _Nullable authParameters; /**

The app client ID.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

  • Pre signup

  • Pre authentication

  • User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

  • Post authentication

  • Custom message

  • Pre token generation

  • Create auth challenge

  • Define auth challenge

  • Verify auth challenge

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderContextDataType * _Nullable contextData; /**

The ID of the Amazon Cognito user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Initiates the authentication response, as an administrator.

*/ @interface AWSCognitoIdentityProviderAdminInitiateAuthResponse : AWSModel /**

The result of the authentication response. This is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAuthenticationResultType * _Nullable authenticationResult; /**

The name of the challenge that you're responding to with this call. This is returned in the AdminInitiateAuth response if you must pass another challenge.

  • MFA_SETUP: If MFA is required, users who don't have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate.

  • SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for time-based one-time password (TOTP) software token MFA.

  • SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.

  • PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.

  • CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

  • DEVICE_SRP_AUTH: If device tracking was activated in your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.

  • DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.

  • ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow.

  • NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see AdminRespondToAuthChallenge.

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.

  • MFA_SETUP: For users who are required to set up an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.

    To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken, and use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, users will need help from an administrator to add a phone number to their account and then call InitiateAuth again to restart sign-in.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName; /**

The challenge parameters. These are returned to you in the AdminInitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge).

All challenges require USERNAME and SECRET_HASH (if applicable).

The value of the USER_ID_FOR_SRP attribute is the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This happens because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute can't be an alias.

*/ @property (nonatomic, strong) NSDictionary * _Nullable challengeParameters; /**

The session that should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge API call.

*/ @property (nonatomic, strong) NSString * _Nullable session; @end /** */ @interface AWSCognitoIdentityProviderAdminLinkProviderForUserRequest : AWSRequest /**

The existing user in the user pool that you want to assign to the external IdP user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.

For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id.

The ProviderAttributeName of the DestinationUser is ignored.

The ProviderName should be set to Cognito for users in Cognito user pools.

All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.

 */ @property (nonatomic, strong) AWSCognitoIdentityProviderProviderUserIdentifierType * _Nullable destinationUser; /**

An external IdP account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.

If the SourceUser is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject. For social IdPs, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social IdP token.

For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML IdP and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderProviderUserIdentifierType * _Nullable sourceUser; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderAdminLinkProviderForUserResponse : AWSModel @end /**

Represents the request to list devices, as an administrator.

Required parameters: [UserPoolId, Username] */ @interface AWSCognitoIdentityProviderAdminListDevicesRequest : AWSRequest /**

The limit of the devices request.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

The pagination token.

*/ @property (nonatomic, strong) NSString * _Nullable paginationToken; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Lists the device's response, as an administrator.

*/ @interface AWSCognitoIdentityProviderAdminListDevicesResponse : AWSModel /**

The devices in the list of devices response.

*/ @property (nonatomic, strong) NSArray * _Nullable devices; /**

The pagination token.

*/ @property (nonatomic, strong) NSString * _Nullable paginationToken; @end /** */ @interface AWSCognitoIdentityProviderAdminListGroupsForUserRequest : AWSRequest /**

The limit of the request to list groups.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The username for the user.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /** */ @interface AWSCognitoIdentityProviderAdminListGroupsForUserResponse : AWSModel /**

The groups that the user belongs to.

*/ @property (nonatomic, strong) NSArray * _Nullable groups; /**

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSCognitoIdentityProviderAdminListUserAuthEventsRequest : AWSRequest /**

The maximum number of authentication events to return. Returns 60 events if you set MaxResults to 0, or if you don't include a MaxResults parameter.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

A pagination token.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user pool username or an alias.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /** */ @interface AWSCognitoIdentityProviderAdminListUserAuthEventsResponse : AWSModel /**

The response object. It includes the EventID, EventType, CreationDate, EventRisk, and EventResponse.

*/ @property (nonatomic, strong) NSArray * _Nullable authEvents; /**

A pagination token.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSCognitoIdentityProviderAdminRemoveUserFromGroupRequest : AWSRequest /**

The group name.

*/ @property (nonatomic, strong) NSString * _Nullable groupName; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The username for the user.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the request to reset a user's password as an administrator.

Required parameters: [UserPoolId, Username] */ @interface AWSCognitoIdentityProviderAdminResetUserPasswordRequest : AWSRequest /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

The user pool ID for the user pool where you want to reset the user's password.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name of the user whose password you want to reset.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the response from the server to reset a user password as an administrator.

*/ @interface AWSCognitoIdentityProviderAdminResetUserPasswordResponse : AWSModel @end /**

The request to respond to the authentication challenge, as an administrator.

Required parameters: [UserPoolId, ClientId, ChallengeName] */ @interface AWSCognitoIdentityProviderAdminRespondToAuthChallengeRequest : AWSRequest /**

The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata; /**

The challenge name. For more information, see AdminInitiateAuth.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName; /**

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

  • SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

    PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.

  • ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.

  • MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.

The value of the USERNAME attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.

*/ @property (nonatomic, strong) NSDictionary * _Nullable challengeResponses; /**

The app client ID.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:

  • pre sign-up

  • custom message

  • post authentication

  • user migration

  • pre token generation

  • define auth challenge

  • create auth challenge

  • verify auth challenge response

When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderContextDataType * _Nullable contextData; /**

The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

*/ @property (nonatomic, strong) NSString * _Nullable session; /**

The ID of the Amazon Cognito user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Responds to the authentication challenge, as an administrator.

*/ @interface AWSCognitoIdentityProviderAdminRespondToAuthChallengeResponse : AWSModel /**

The result returned by the server in response to the authentication request.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAuthenticationResultType * _Nullable authenticationResult; /**

The name of the challenge. For more information, see AdminInitiateAuth.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName; /**

The challenge parameters. For more information, see AdminInitiateAuth.

*/ @property (nonatomic, strong) NSDictionary * _Nullable challengeParameters; /**

The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

*/ @property (nonatomic, strong) NSString * _Nullable session; @end /** */ @interface AWSCognitoIdentityProviderAdminSetUserMFAPreferenceRequest : AWSRequest /**

The SMS text message MFA settings.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSMSMfaSettingsType * _Nullable SMSMfaSettings; /**

The time-based one-time password software token MFA settings.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSoftwareTokenMfaSettingsType * _Nullable softwareTokenMfaSettings; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user pool username or alias.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /** */ @interface AWSCognitoIdentityProviderAdminSetUserMFAPreferenceResponse : AWSModel @end /** */ @interface AWSCognitoIdentityProviderAdminSetUserPasswordRequest : AWSRequest /**

The password for the user.

*/ @property (nonatomic, strong) NSString * _Nullable password; /**

True if the password is permanent, False if it is temporary.

*/ @property (nonatomic, strong) NSNumber * _Nullable permanent; /**

The user pool ID for the user pool where you want to set the user's password.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name of the user whose password you want to set.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /** */ @interface AWSCognitoIdentityProviderAdminSetUserPasswordResponse : AWSModel @end /**

You can use this parameter to set an MFA configuration that uses the SMS delivery medium.

Required parameters: [UserPoolId, Username, MFAOptions] */ @interface AWSCognitoIdentityProviderAdminSetUserSettingsRequest : AWSRequest /**

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

*/ @property (nonatomic, strong) NSArray * _Nullable MFAOptions; /**

The ID of the user pool that contains the user whose options you're setting.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name of the user whose options you're setting.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the response from the server to set user settings as an administrator.

*/ @interface AWSCognitoIdentityProviderAdminSetUserSettingsResponse : AWSModel @end /** */ @interface AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackRequest : AWSRequest /**

The authentication event ID.

*/ @property (nonatomic, strong) NSString * _Nullable eventId; /**

The authentication event feedback value.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderFeedbackValueType feedbackValue; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user pool username.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /** */ @interface AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackResponse : AWSModel @end /**

The request to update the device status, as an administrator.

Required parameters: [UserPoolId, Username, DeviceKey] */ @interface AWSCognitoIdentityProviderAdminUpdateDeviceStatusRequest : AWSRequest /**

The device key.

*/ @property (nonatomic, strong) NSString * _Nullable deviceKey; /**

The status indicating whether a device has been remembered or not.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderDeviceRememberedStatusType deviceRememberedStatus; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

The status response to the request to update the device, as an administrator.

*/ @interface AWSCognitoIdentityProviderAdminUpdateDeviceStatusResponse : AWSModel @end /**

Represents the request to update the user's attributes as an administrator.

Required parameters: [UserPoolId, Username, UserAttributes] */ @interface AWSCognitoIdentityProviderAdminUpdateUserAttributesRequest : AWSRequest /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

To update the value of an attribute that requires verification in the same API request, include the email_verified or phone_number_verified attribute, with a value of true. If you set the email_verified or phone_number_verified value for an email or phone_number attribute that requires verification to true, Amazon Cognito doesn’t send a verification message to your user.

*/ @property (nonatomic, strong) NSArray * _Nullable userAttributes; /**

The user pool ID for the user pool where you want to update user attributes.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name of the user for whom you want to update user attributes.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the response from the server for the request to update user attributes as an administrator.

*/ @interface AWSCognitoIdentityProviderAdminUpdateUserAttributesResponse : AWSModel @end /**

The request to sign out of all devices, as an administrator.

Required parameters: [UserPoolId, Username] */ @interface AWSCognitoIdentityProviderAdminUserGlobalSignOutRequest : AWSRequest /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user name.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

The global sign-out response, as an administrator.

*/ @interface AWSCognitoIdentityProviderAdminUserGlobalSignOutResponse : AWSModel @end /**

The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.

In Regions where Amazon Pinpointisn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

 */ @interface AWSCognitoIdentityProviderAnalyticsConfigurationType : AWSModel /**

The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.

*/ @property (nonatomic, strong) NSString * _Nullable applicationArn; /**

The application ID for an Amazon Pinpoint application.

*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**

The external ID.

*/ @property (nonatomic, strong) NSString * _Nullable externalId; /**

The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

*/ @property (nonatomic, strong) NSString * _Nullable roleArn; /**

If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

*/ @property (nonatomic, strong) NSNumber * _Nullable userDataShared; @end /**

An Amazon Pinpoint analytics endpoint.

An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.

*/ @interface AWSCognitoIdentityProviderAnalyticsMetadataType : AWSModel /**

The endpoint ID.

*/ @property (nonatomic, strong) NSString * _Nullable analyticsEndpointId; @end /** */ @interface AWSCognitoIdentityProviderAssociateSoftwareTokenRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose software token you want to generate.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

*/ @property (nonatomic, strong) NSString * _Nullable session; @end /** */ @interface AWSCognitoIdentityProviderAssociateSoftwareTokenResponse : AWSModel /**

A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.

*/ @property (nonatomic, strong) NSString * _Nullable secretCode; /**

The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

*/ @property (nonatomic, strong) NSString * _Nullable session; @end /**

Specifies whether the attribute is standard or custom.

Required parameters: [Name] */ @interface AWSCognitoIdentityProviderAttributeType : AWSModel /**

The name of the attribute.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The value of the attribute.

*/ @property (nonatomic, strong) NSString * _Nullable value; @end /**

The authentication event type.

*/ @interface AWSCognitoIdentityProviderAuthEventType : AWSModel /**

The challenge responses.

*/ @property (nonatomic, strong) NSArray * _Nullable challengeResponses; /**

The creation date

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderEventContextDataType * _Nullable eventContextData; /**

A flag specifying the user feedback captured at the time of an event request is good or bad.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderEventFeedbackType * _Nullable eventFeedback; /**

The event ID.

*/ @property (nonatomic, strong) NSString * _Nullable eventId; /**

The event response.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderEventResponseType eventResponse; /**

The event risk.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderEventRiskType * _Nullable eventRisk; /**

The event type.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderEventType eventType; @end /**

The authentication result.

*/ @interface AWSCognitoIdentityProviderAuthenticationResultType : AWSModel /**

A valid access token that Amazon Cognito issued to the user who you want to authenticate.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The expiration period of the authentication result in seconds.

*/ @property (nonatomic, strong) NSNumber * _Nullable expiresIn; /**

The ID token.

*/ @property (nonatomic, strong) NSString * _Nullable idToken; /**

The new device metadata from an authentication result.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderLatestDeviceMetadataType * _Nullable latestDeviceMetadata; /**

The refresh token.

*/ @property (nonatomic, strong) NSString * _Nullable refreshToken; /**

The token type.

*/ @property (nonatomic, strong) NSString * _Nullable tokenType; @end /**

The challenge response type.

*/ @interface AWSCognitoIdentityProviderChallengeResponseType : AWSModel /**

The challenge name.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeName challengeName; /**

The challenge response.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeResponse challengeResponse; @end /**

Represents the request to change a user password.

Required parameters: [PreviousPassword, ProposedPassword, AccessToken] */ @interface AWSCognitoIdentityProviderChangePasswordRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose password you want to change.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The old password.

*/ @property (nonatomic, strong) NSString * _Nullable previousPassword; /**

The new password.

*/ @property (nonatomic, strong) NSString * _Nullable proposedPassword; @end /**

The response from the server to the change password request.

*/ @interface AWSCognitoIdentityProviderChangePasswordResponse : AWSModel @end /**

The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.

*/ @interface AWSCognitoIdentityProviderCodeDeliveryDetailsType : AWSModel /**

The name of the attribute that Amazon Cognito verifies with the code.

*/ @property (nonatomic, strong) NSString * _Nullable attributeName; /**

The method that Amazon Cognito used to send the code.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderDeliveryMediumType deliveryMedium; /**

The email address or phone number destination where Amazon Cognito sent the code.

*/ @property (nonatomic, strong) NSString * _Nullable destination; @end /**

The compromised credentials actions type.

Required parameters: [EventAction] */ @interface AWSCognitoIdentityProviderCompromisedCredentialsActionsType : AWSModel /**

The event action.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderCompromisedCredentialsEventActionType eventAction; @end /**

The compromised credentials risk configuration type.

Required parameters: [Actions] */ @interface AWSCognitoIdentityProviderCompromisedCredentialsRiskConfigurationType : AWSModel /**

The compromised credentials risk configuration actions.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCompromisedCredentialsActionsType * _Nullable actions; /**

Perform the action for these events. The default is to perform all events if no event filter is specified.

*/ @property (nonatomic, strong) NSArray * _Nullable eventFilter; @end /**

Confirms the device request.

Required parameters: [AccessToken, DeviceKey] */ @interface AWSCognitoIdentityProviderConfirmDeviceRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose device you want to confirm.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The device key.

*/ @property (nonatomic, strong) NSString * _Nullable deviceKey; /**

The device name.

*/ @property (nonatomic, strong) NSString * _Nullable deviceName; /**

The configuration of the device secret verifier.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceSecretVerifierConfigType * _Nullable deviceSecretVerifierConfig; @end /**

Confirms the device response.

*/ @interface AWSCognitoIdentityProviderConfirmDeviceResponse : AWSModel /**

Indicates whether the user confirmation must confirm the device response.

*/ @property (nonatomic, strong) NSNumber * _Nullable userConfirmationNecessary; @end /**

The request representing the confirmation for a password reset.

Required parameters: [ClientId, Username, ConfirmationCode, Password] */ @interface AWSCognitoIdentityProviderConfirmForgotPasswordRequest : AWSRequest /**

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata; /**

The app client ID of the app associated with the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.

*/ @property (nonatomic, strong) NSString * _Nullable confirmationCode; /**

The new password that your user wants to set.

*/ @property (nonatomic, strong) NSString * _Nullable password; /**

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

*/ @property (nonatomic, strong) NSString * _Nullable secretHash; /**

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData; /**

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

The response from the server that results from a user's request to retrieve a forgotten password.

*/ @interface AWSCognitoIdentityProviderConfirmForgotPasswordResponse : AWSModel @end /**

Represents the request to confirm registration of a user.

Required parameters: [ClientId, Username, ConfirmationCode] */ @interface AWSCognitoIdentityProviderConfirmSignUpRequest : AWSRequest /**

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata; /**

The ID of the app client associated with the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

The confirmation code sent by a user's request to confirm registration.

*/ @property (nonatomic, strong) NSString * _Nullable confirmationCode; /**

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

*/ @property (nonatomic, strong) NSNumber * _Nullable forceAliasCreation; /**

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

*/ @property (nonatomic, strong) NSString * _Nullable secretHash; /**

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData; /**

The user name of the user whose registration you want to confirm.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the response from the server for the registration confirmation.

*/ @interface AWSCognitoIdentityProviderConfirmSignUpResponse : AWSModel @end /**

Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Required parameters: [IpAddress, ServerName, ServerPath, HttpHeaders] */ @interface AWSCognitoIdentityProviderContextDataType : AWSModel /**

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

*/ @property (nonatomic, strong) NSString * _Nullable encodedData; /**

HttpHeaders received on your server in same order.

*/ @property (nonatomic, strong) NSArray * _Nullable httpHeaders; /**

The source IP address of your user's device.

*/ @property (nonatomic, strong) NSString * _Nullable ipAddress; /**

Your server endpoint where this API is invoked.

*/ @property (nonatomic, strong) NSString * _Nullable serverName; /**

Your server path where this API is invoked.

*/ @property (nonatomic, strong) NSString * _Nullable serverPath; @end /** */ @interface AWSCognitoIdentityProviderCreateGroupRequest : AWSRequest /**

A string containing the description of the group.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The name of the group. Must be unique.

*/ @property (nonatomic, strong) NSString * _Nullable groupName; /**

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

*/ @property (nonatomic, strong) NSNumber * _Nullable precedence; /**

The role Amazon Resource Name (ARN) for the group.

*/ @property (nonatomic, strong) NSString * _Nullable roleArn; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderCreateGroupResponse : AWSModel /**

The group object for the group.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderGroupType * _Nullable group; @end /** */ @interface AWSCognitoIdentityProviderCreateIdentityProviderRequest : AWSRequest /**

A mapping of IdP attributes to standard and custom user pool attributes.

*/ @property (nonatomic, strong) NSDictionary * _Nullable attributeMapping; /**

A list of IdP identifiers.

*/ @property (nonatomic, strong) NSArray * _Nullable idpIdentifiers; /**

The IdP details. The following list describes the provider detail keys for each IdP type.

  • For Google and Login with Amazon:

    • client_id

    • client_secret

    • authorize_scopes

  • For Facebook:

    • client_id

    • client_secret

    • authorize_scopes

    • api_version

  • For Sign in with Apple:

    • client_id

    • team_id

    • key_id

    • private_key

    • authorize_scopes

  • For OpenID Connect (OIDC) providers:

    • client_id

    • client_secret

    • attributes_request_method

    • oidc_issuer

    • authorize_scopes

    • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

      • authorize_url

      • token_url

      • attributes_url

      • jwks_uri

    • Amazon Cognito sets the value of the following keys automatically. They are read-only.

      • attributes_url_add_attributes

  • For SAML providers:

    • MetadataFile or MetadataURL

    • IDPSignout optional

*/ @property (nonatomic, strong) NSDictionary * _Nullable providerDetails; /**

The IdP name.

*/ @property (nonatomic, strong) NSString * _Nullable providerName; /**

The IdP type.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderIdentityProviderTypeType providerType; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderCreateIdentityProviderResponse : AWSModel /**

The newly created IdP object.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderIdentityProviderType * _Nullable identityProvider; @end /** */ @interface AWSCognitoIdentityProviderCreateResourceServerRequest : AWSRequest /**

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com.

*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**

A friendly name for the resource server.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

A list of scopes. Each scope is a key-value map with the keys name and description.

*/ @property (nonatomic, strong) NSArray * _Nullable scopes; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderCreateResourceServerResponse : AWSModel /**

The newly created resource server.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderResourceServerType * _Nullable resourceServer; @end /**

Represents the request to create the user import job.

Required parameters: [JobName, UserPoolId, CloudWatchLogsRoleArn] */ @interface AWSCognitoIdentityProviderCreateUserImportJobRequest : AWSRequest /**

The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

*/ @property (nonatomic, strong) NSString * _Nullable cloudWatchLogsRoleArn; /**

The job name for the user import job.

*/ @property (nonatomic, strong) NSString * _Nullable jobName; /**

The user pool ID for the user pool that the users are being imported into.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the response from the server to the request to create the user import job.

*/ @interface AWSCognitoIdentityProviderCreateUserImportJobResponse : AWSModel /**

The job object that represents the user import job.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserImportJobType * _Nullable userImportJob; @end /**

Represents the request to create a user pool client.

Required parameters: [UserPoolId, ClientName] */ @interface AWSCognitoIdentityProviderCreateUserPoolClientRequest : AWSRequest /**

The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

*/ @property (nonatomic, strong) NSNumber * _Nullable accessTokenValidity; /**

The allowed OAuth flows.

code

Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.

implicit

Issue the access token (and, optionally, ID token, based on scopes) directly to your user.

client_credentials

Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.

*/ @property (nonatomic, strong) NSArray * _Nullable allowedOAuthFlows; /**

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

*/ @property (nonatomic, strong) NSNumber * _Nullable allowedOAuthFlowsUserPoolClient; /**

The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

*/ @property (nonatomic, strong) NSArray * _Nullable allowedOAuthScopes; /**

The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

 */ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsConfigurationType * _Nullable analyticsConfiguration; /**

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

*/ @property (nonatomic, strong) NSNumber * _Nullable authSessionValidity; /**

A list of allowed redirect (callback) URLs for the IdPs.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

*/ @property (nonatomic, strong) NSArray * _Nullable callbackURLs; /**

The client name for the user pool client you would like to create.

*/ @property (nonatomic, strong) NSString * _Nullable clientName; /**

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

*/ @property (nonatomic, strong) NSString * _Nullable defaultRedirectURI; /**

Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.

*/ @property (nonatomic, strong) NSNumber * _Nullable enablePropagateAdditionalUserContextData; /**

Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.

If you don't include this parameter, token revocation is automatically activated for the new user pool client.

*/ @property (nonatomic, strong) NSNumber * _Nullable enableTokenRevocation; /**

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.

*/ @property (nonatomic, strong) NSArray * _Nullable explicitAuthFlows; /**

Boolean to specify whether you want to generate a secret for the user pool client being created.

*/ @property (nonatomic, strong) NSNumber * _Nullable generateSecret; /**

The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

*/ @property (nonatomic, strong) NSNumber * _Nullable idTokenValidity; /**

A list of allowed logout URLs for the IdPs.

*/ @property (nonatomic, strong) NSArray * _Nullable logoutURLs; /**

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.

Valid values include:

  • ENABLED - This prevents user existence-related errors.

  • LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderPreventUserExistenceErrorTypes preventUserExistenceErrors; /**

The read attributes.

*/ @property (nonatomic, strong) NSArray * _Nullable readAttributes; /**

The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

*/ @property (nonatomic, strong) NSNumber * _Nullable refreshTokenValidity; /**

A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.

*/ @property (nonatomic, strong) NSArray * _Nullable supportedIdentityProviders; /**

The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderTokenValidityUnitsType * _Nullable tokenValidityUnits; /**

The user pool ID for the user pool where you want to create a user pool client.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user pool attributes that the app client can write to.

If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.

*/ @property (nonatomic, strong) NSArray * _Nullable writeAttributes; @end /**

Represents the response from the server to create a user pool client.

*/ @interface AWSCognitoIdentityProviderCreateUserPoolClientResponse : AWSModel /**

The user pool client that was just created.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolClientType * _Nullable userPoolClient; @end /** */ @interface AWSCognitoIdentityProviderCreateUserPoolDomainRequest : AWSRequest /**

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCustomDomainConfigType * _Nullable customDomainConfig; /**

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

*/ @property (nonatomic, strong) NSString * _Nullable domain; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderCreateUserPoolDomainResponse : AWSModel /**

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

*/ @property (nonatomic, strong) NSString * _Nullable cloudFrontDomain; @end /**

Represents the request to create a user pool.

Required parameters: [PoolName] */ @interface AWSCognitoIdentityProviderCreateUserPoolRequest : AWSRequest /**

The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAccountRecoverySettingType * _Nullable accountRecoverySetting; /**

The configuration for AdminCreateUser requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAdminCreateUserConfigType * _Nullable adminCreateUserConfig; /**

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

*/ @property (nonatomic, strong) NSArray * _Nullable aliasAttributes; /**

The attributes to be auto-verified. Possible values: email, phone_number.

*/ @property (nonatomic, strong) NSArray * _Nullable autoVerifiedAttributes; /**

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderDeletionProtectionType deletionProtection; /**

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

 */ @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceConfigurationType * _Nullable deviceConfiguration; /**

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderEmailConfigurationType * _Nullable emailConfiguration; /**

This parameter is no longer used. See VerificationMessageTemplateType.

*/ @property (nonatomic, strong) NSString * _Nullable emailVerificationMessage; /**

This parameter is no longer used. See VerificationMessageTemplateType.

*/ @property (nonatomic, strong) NSString * _Nullable emailVerificationSubject; /**

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the CLI, see add-permission .

 */ @property (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType * _Nullable lambdaConfig; /**

Specifies MFA configuration details.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration; /**

The policies associated with the new user pool.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolPolicyType * _Nullable policies; /**

A string used to name the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable poolName; /**

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

*/ @property (nonatomic, strong) NSArray * _Nullable schema; /**

A string representing the SMS authentication message.

*/ @property (nonatomic, strong) NSString * _Nullable smsAuthenticationMessage; /**

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType * _Nullable smsConfiguration; /**

This parameter is no longer used. See VerificationMessageTemplateType.

*/ @property (nonatomic, strong) NSString * _Nullable smsVerificationMessage; /**

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserAttributeUpdateSettingsType * _Nullable userAttributeUpdateSettings; /**

Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolAddOnsType * _Nullable userPoolAddOns; /**

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

*/ @property (nonatomic, strong) NSDictionary * _Nullable userPoolTags; /**

Specifies whether a user can use an email address or phone number as a username when they sign up.

*/ @property (nonatomic, strong) NSArray * _Nullable usernameAttributes; /**

Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUsernameConfigurationType * _Nullable usernameConfiguration; /**

The template for the verification message that the user sees when the app requests permission to access the user's information.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderVerificationMessageTemplateType * _Nullable verificationMessageTemplate; @end /**

Represents the response from the server for the request to create a user pool.

*/ @interface AWSCognitoIdentityProviderCreateUserPoolResponse : AWSModel /**

A container for the user pool details.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolType * _Nullable userPool; @end /**

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Required parameters: [CertificateArn] */ @interface AWSCognitoIdentityProviderCustomDomainConfigType : AWSModel /**

The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.

*/ @property (nonatomic, strong) NSString * _Nullable certificateArn; @end /**

A custom email sender Lambda configuration type.

Required parameters: [LambdaVersion, LambdaArn] */ @interface AWSCognitoIdentityProviderCustomEmailLambdaVersionConfigType : AWSModel /**

The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.

*/ @property (nonatomic, strong) NSString * _Nullable lambdaArn; /**

Signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom email Lambda function. The only supported value is V1_0.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderCustomEmailSenderLambdaVersionType lambdaVersion; @end /**

A custom SMS sender Lambda configuration type.

Required parameters: [LambdaVersion, LambdaArn] */ @interface AWSCognitoIdentityProviderCustomSMSLambdaVersionConfigType : AWSModel /**

The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.

*/ @property (nonatomic, strong) NSString * _Nullable lambdaArn; /**

Signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderCustomSMSSenderLambdaVersionType lambdaVersion; @end /** */ @interface AWSCognitoIdentityProviderDeleteGroupRequest : AWSRequest /**

The name of the group.

*/ @property (nonatomic, strong) NSString * _Nullable groupName; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderDeleteIdentityProviderRequest : AWSRequest /**

The IdP name.

*/ @property (nonatomic, strong) NSString * _Nullable providerName; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderDeleteResourceServerRequest : AWSRequest /**

The identifier for the resource server.

*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**

The user pool ID for the user pool that hosts the resource server.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the request to delete user attributes.

Required parameters: [UserAttributeNames, AccessToken] */ @interface AWSCognitoIdentityProviderDeleteUserAttributesRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.

*/ @property (nonatomic, strong) NSArray * _Nullable userAttributeNames; @end /**

Represents the response from the server to delete user attributes.

*/ @interface AWSCognitoIdentityProviderDeleteUserAttributesResponse : AWSModel @end /**

Represents the request to delete a user pool client.

Required parameters: [UserPoolId, ClientId] */ @interface AWSCognitoIdentityProviderDeleteUserPoolClientRequest : AWSRequest /**

The app client ID of the app associated with the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The user pool ID for the user pool where you want to delete the client.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderDeleteUserPoolDomainRequest : AWSRequest /**

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

*/ @property (nonatomic, strong) NSString * _Nullable domain; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderDeleteUserPoolDomainResponse : AWSModel @end /**

Represents the request to delete a user pool.

Required parameters: [UserPoolId] */ @interface AWSCognitoIdentityProviderDeleteUserPoolRequest : AWSRequest /**

The user pool ID for the user pool you want to delete.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the request to delete a user.

Required parameters: [AccessToken] */ @interface AWSCognitoIdentityProviderDeleteUserRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; @end /** */ @interface AWSCognitoIdentityProviderDescribeIdentityProviderRequest : AWSRequest /**

The IdP name.

*/ @property (nonatomic, strong) NSString * _Nullable providerName; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderDescribeIdentityProviderResponse : AWSModel /**

The identity provider details.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderIdentityProviderType * _Nullable identityProvider; @end /** */ @interface AWSCognitoIdentityProviderDescribeResourceServerRequest : AWSRequest /**

The identifier for the resource server

*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**

The user pool ID for the user pool that hosts the resource server.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderDescribeResourceServerResponse : AWSModel /**

The resource server.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderResourceServerType * _Nullable resourceServer; @end /** */ @interface AWSCognitoIdentityProviderDescribeRiskConfigurationRequest : AWSRequest /**

The app client ID.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderDescribeRiskConfigurationResponse : AWSModel /**

The risk configuration.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderRiskConfigurationType * _Nullable riskConfiguration; @end /**

Represents the request to describe the user import job.

Required parameters: [UserPoolId, JobId] */ @interface AWSCognitoIdentityProviderDescribeUserImportJobRequest : AWSRequest /**

The job ID for the user import job.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; /**

The user pool ID for the user pool that the users are being imported into.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the response from the server to the request to describe the user import job.

*/ @interface AWSCognitoIdentityProviderDescribeUserImportJobResponse : AWSModel /**

The job object that represents the user import job.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserImportJobType * _Nullable userImportJob; @end /**

Represents the request to describe a user pool client.

Required parameters: [UserPoolId, ClientId] */ @interface AWSCognitoIdentityProviderDescribeUserPoolClientRequest : AWSRequest /**

The app client ID of the app associated with the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The user pool ID for the user pool you want to describe.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the response from the server from a request to describe the user pool client.

*/ @interface AWSCognitoIdentityProviderDescribeUserPoolClientResponse : AWSModel /**

The user pool client from a server response to describe the user pool client.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolClientType * _Nullable userPoolClient; @end /** */ @interface AWSCognitoIdentityProviderDescribeUserPoolDomainRequest : AWSRequest /**

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

*/ @property (nonatomic, strong) NSString * _Nullable domain; @end /** */ @interface AWSCognitoIdentityProviderDescribeUserPoolDomainResponse : AWSModel /**

A domain description object containing information about the domain.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderDomainDescriptionType * _Nullable domainDescription; @end /**

Represents the request to describe the user pool.

Required parameters: [UserPoolId] */ @interface AWSCognitoIdentityProviderDescribeUserPoolRequest : AWSRequest /**

The user pool ID for the user pool you want to describe.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the response to describe the user pool.

*/ @interface AWSCognitoIdentityProviderDescribeUserPoolResponse : AWSModel /**

The container of metadata returned by the server to describe the pool.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolType * _Nullable userPool; @end /**

The device-remembering configuration for a user pool. A DescribeUserPool request returns a null value for this object when the user pool isn't configured to remember devices. When device remembering is active, you can remember a user's device with a ConfirmDevice API request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt is true, you must follow ConfirmDevice with an UpdateDeviceStatus API request that sets the user's device to remembered or not_remembered.

To sign in with a remembered device, include DEVICE_KEY in the authentication parameters in your user's InitiateAuth request. If your app doesn't include a DEVICE_KEY parameter, the response from Amazon Cognito includes newly-generated DEVICE_KEY and DEVICE_GROUP_KEY values under NewDeviceMetadata. Store these values to use in future device-authentication requests.

When you provide a value for any property of DeviceConfiguration, you activate the device remembering for the user pool.

 */ @interface AWSCognitoIdentityProviderDeviceConfigurationType : AWSModel /**

When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.

 */ @property (nonatomic, strong) NSNumber * _Nullable challengeRequiredOnNewDevice; /**

When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.

When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

*/ @property (nonatomic, strong) NSNumber * _Nullable deviceOnlyRememberedOnUserPrompt; @end /**

The device verifier against which it is authenticated.

*/ @interface AWSCognitoIdentityProviderDeviceSecretVerifierConfigType : AWSModel /**

The password verifier.

*/ @property (nonatomic, strong) NSString * _Nullable passwordVerifier; /**

The salt

*/ @property (nonatomic, strong) NSString * _Nullable salt; @end /**

The device type.

*/ @interface AWSCognitoIdentityProviderDeviceType : AWSModel /**

The device attributes.

*/ @property (nonatomic, strong) NSArray * _Nullable deviceAttributes; /**

The creation date of the device.

*/ @property (nonatomic, strong) NSDate * _Nullable deviceCreateDate; /**

The device key.

*/ @property (nonatomic, strong) NSString * _Nullable deviceKey; /**

The date when the device was last authenticated.

*/ @property (nonatomic, strong) NSDate * _Nullable deviceLastAuthenticatedDate; /**

The last modified date of the device.

*/ @property (nonatomic, strong) NSDate * _Nullable deviceLastModifiedDate; @end /**

A container for information about a domain.

*/ @interface AWSCognitoIdentityProviderDomainDescriptionType : AWSModel /**

The Amazon Web Services ID for the user pool owner.

*/ @property (nonatomic, strong) NSString * _Nullable AWSAccountId; /**

The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.

*/ @property (nonatomic, strong) NSString * _Nullable cloudFrontDistribution; /**

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCustomDomainConfigType * _Nullable customDomainConfig; /**

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

*/ @property (nonatomic, strong) NSString * _Nullable domain; /**

The Amazon S3 bucket where the static files for this domain are stored.

*/ @property (nonatomic, strong) NSString * _Nullable s3Bucket; /**

The domain status.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderDomainStatusType status; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The app version.

*/ @property (nonatomic, strong) NSString * _Nullable version; @end /**

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you created your user pool, and in alternate Regions in some cases. For more information on the supported Regions, see Email settings for Amazon Cognito user pools.

 */ @interface AWSCognitoIdentityProviderEmailConfigurationType : AWSModel /**

The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:

Event publishing

Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch

IP pool management

When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

*/ @property (nonatomic, strong) NSString * _Nullable configurationSet; /**

Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

COGNITO_DEFAULT

When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide.

The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.

DEVELOPER

When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.

If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of role in your Amazon Web Services account. This role contains the permissions that allow you to access Amazon SES and send email messages from your email address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderEmailSendingAccountType emailSendingAccount; /**

Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address appears before the body of the email.

*/ @property (nonatomic, strong) NSString * _Nullable from; /**

The destination to which the receiver of the email should reply.

*/ @property (nonatomic, strong) NSString * _Nullable replyToEmailAddress; /**

The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:

  • If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.

  • If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable sourceArn; @end /**

Specifies the user context data captured at the time of an event request.

*/ @interface AWSCognitoIdentityProviderEventContextDataType : AWSModel /**

The user's city.

*/ @property (nonatomic, strong) NSString * _Nullable city; /**

The user's country.

*/ @property (nonatomic, strong) NSString * _Nullable country; /**

The user's device name.

*/ @property (nonatomic, strong) NSString * _Nullable deviceName; /**

The source IP address of your user's device.

*/ @property (nonatomic, strong) NSString * _Nullable ipAddress; /**

The user's time zone.

*/ @property (nonatomic, strong) NSString * _Nullable timezone; @end /**

Specifies the event feedback type.

Required parameters: [FeedbackValue, Provider] */ @interface AWSCognitoIdentityProviderEventFeedbackType : AWSModel /**

The event feedback date.

*/ @property (nonatomic, strong) NSDate * _Nullable feedbackDate; /**

The event feedback value.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderFeedbackValueType feedbackValue; /**

The provider.

*/ @property (nonatomic, strong) NSString * _Nullable provider; @end /**

The event risk type.

*/ @interface AWSCognitoIdentityProviderEventRiskType : AWSModel /**

Indicates whether compromised credentials were detected during an authentication event.

*/ @property (nonatomic, strong) NSNumber * _Nullable compromisedCredentialsDetected; /**

The risk decision.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderRiskDecisionType riskDecision; /**

The risk level.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderRiskLevelType riskLevel; @end /**

Represents the request to forget the device.

Required parameters: [DeviceKey] */ @interface AWSCognitoIdentityProviderForgetDeviceRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The device key.

*/ @property (nonatomic, strong) NSString * _Nullable deviceKey; @end /**

Represents the request to reset a user's password.

Required parameters: [ClientId, Username] */ @interface AWSCognitoIdentityProviderForgotPasswordRequest : AWSRequest /**

The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata; /**

The ID of the client associated with the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

*/ @property (nonatomic, strong) NSString * _Nullable secretHash; /**

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData; /**

The user name of the user for whom you want to enter a code to reset a forgotten password.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

The response from Amazon Cognito to a request to reset a password.

*/ @interface AWSCognitoIdentityProviderForgotPasswordResponse : AWSModel /**

The code delivery details returned by the server in response to the request to reset a password.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCodeDeliveryDetailsType * _Nullable codeDeliveryDetails; @end /**

Represents the request to get the header information of the CSV file for the user import job.

Required parameters: [UserPoolId] */ @interface AWSCognitoIdentityProviderGetCSVHeaderRequest : AWSRequest /**

The user pool ID for the user pool that the users are to be imported into.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the response from the server to the request to get the header information of the CSV file for the user import job.

*/ @interface AWSCognitoIdentityProviderGetCSVHeaderResponse : AWSModel /**

The header information of the CSV file for the user import job.

*/ @property (nonatomic, strong) NSArray * _Nullable CSVHeader; /**

The user pool ID for the user pool that the users are to be imported into.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the request to get the device.

Required parameters: [DeviceKey] */ @interface AWSCognitoIdentityProviderGetDeviceRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose device information you want to request.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The device key.

*/ @property (nonatomic, strong) NSString * _Nullable deviceKey; @end /**

Gets the device response.

Required parameters: [Device] */ @interface AWSCognitoIdentityProviderGetDeviceResponse : AWSModel /**

The device.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceType * _Nullable device; @end /** */ @interface AWSCognitoIdentityProviderGetGroupRequest : AWSRequest /**

The name of the group.

*/ @property (nonatomic, strong) NSString * _Nullable groupName; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderGetGroupResponse : AWSModel /**

The group object for the group.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderGroupType * _Nullable group; @end /** */ @interface AWSCognitoIdentityProviderGetIdentityProviderByIdentifierRequest : AWSRequest /**

The IdP identifier.

*/ @property (nonatomic, strong) NSString * _Nullable idpIdentifier; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderGetIdentityProviderByIdentifierResponse : AWSModel /**

The identity provider details.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderIdentityProviderType * _Nullable identityProvider; @end /**

Request to get a signing certificate from Amazon Cognito.

Required parameters: [UserPoolId] */ @interface AWSCognitoIdentityProviderGetSigningCertificateRequest : AWSRequest /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Response from Amazon Cognito for a signing certificate request.

*/ @interface AWSCognitoIdentityProviderGetSigningCertificateResponse : AWSModel /**

The signing certificate.

*/ @property (nonatomic, strong) NSString * _Nullable certificate; @end /** */ @interface AWSCognitoIdentityProviderGetUICustomizationRequest : AWSRequest /**

The client ID for the client app.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderGetUICustomizationResponse : AWSModel /**

The UI customization information.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUICustomizationType * _Nullable UICustomization; @end /**

Represents the request to get user attribute verification.

Required parameters: [AccessToken, AttributeName] */ @interface AWSCognitoIdentityProviderGetUserAttributeVerificationCodeRequest : AWSRequest /**

A non-expired access token for the user whose attribute verification code you want to generate.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The attribute name returned by the server response to get the user attribute verification code.

*/ @property (nonatomic, strong) NSString * _Nullable attributeName; /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; @end /**

The verification code response returned by the server response to get the user attribute verification code.

*/ @interface AWSCognitoIdentityProviderGetUserAttributeVerificationCodeResponse : AWSModel /**

The code delivery details returned by the server in response to the request to get the user attribute verification code.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCodeDeliveryDetailsType * _Nullable codeDeliveryDetails; @end /** */ @interface AWSCognitoIdentityProviderGetUserPoolMfaConfigRequest : AWSRequest /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderGetUserPoolMfaConfigResponse : AWSModel /**

The multi-factor authentication (MFA) configuration. Valid values include:

  • OFF MFA won't be used for any users.

  • ON MFA is required for all users to sign in.

  • OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration; /**

The SMS text message multi-factor authentication (MFA) configuration.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSmsMfaConfigType * _Nullable smsMfaConfiguration; /**

The software token multi-factor authentication (MFA) configuration.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSoftwareTokenMfaConfigType * _Nullable softwareTokenMfaConfiguration; @end /**

Represents the request to get information about the user.

Required parameters: [AccessToken] */ @interface AWSCognitoIdentityProviderGetUserRequest : AWSRequest /**

A non-expired access token for the user whose information you want to query.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; @end /**

Represents the response from the server from the request to get information about the user.

Required parameters: [Username, UserAttributes] */ @interface AWSCognitoIdentityProviderGetUserResponse : AWSModel /**

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

*/ @property (nonatomic, strong) NSArray * _Nullable MFAOptions; /**

The user's preferred MFA setting.

*/ @property (nonatomic, strong) NSString * _Nullable preferredMfaSetting; /**

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

*/ @property (nonatomic, strong) NSArray * _Nullable userAttributes; /**

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

*/ @property (nonatomic, strong) NSArray * _Nullable userMFASettingList; /**

The user name of the user you want to retrieve from the get user request.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

Represents the request to sign out all devices.

Required parameters: [AccessToken] */ @interface AWSCognitoIdentityProviderGlobalSignOutRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user who you want to sign out.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; @end /**

The response to the request to sign out all devices.

*/ @interface AWSCognitoIdentityProviderGlobalSignOutResponse : AWSModel @end /**

The group type.

*/ @interface AWSCognitoIdentityProviderGroupType : AWSModel /**

The date the group was created.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

A string containing the description of the group.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The name of the group.

*/ @property (nonatomic, strong) NSString * _Nullable groupName; /**

The date the group was last modified.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate; /**

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher ornull Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null.

*/ @property (nonatomic, strong) NSNumber * _Nullable precedence; /**

The role Amazon Resource Name (ARN) for the group.

*/ @property (nonatomic, strong) NSString * _Nullable roleArn; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

The HTTP header.

*/ @interface AWSCognitoIdentityProviderHttpHeader : AWSModel /**

The header name.

*/ @property (nonatomic, strong) NSString * _Nullable headerName; /**

The header value.

*/ @property (nonatomic, strong) NSString * _Nullable headerValue; @end /**

A container for information about an IdP.

*/ @interface AWSCognitoIdentityProviderIdentityProviderType : AWSModel /**

A mapping of IdP attributes to standard and custom user pool attributes.

*/ @property (nonatomic, strong) NSDictionary * _Nullable attributeMapping; /**

The date the IdP was created.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

A list of IdP identifiers.

*/ @property (nonatomic, strong) NSArray * _Nullable idpIdentifiers; /**

The date the IdP was last modified.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate; /**

The IdP details. The following list describes the provider detail keys for each IdP type.

  • For Google and Login with Amazon:

    • client_id

    • client_secret

    • authorize_scopes

  • For Facebook:

    • client_id

    • client_secret

    • authorize_scopes

    • api_version

  • For Sign in with Apple:

    • client_id

    • team_id

    • key_id

    • private_key

      You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.

    • authorize_scopes

  • For OIDC providers:

    • client_id

    • client_secret

    • attributes_request_method

    • oidc_issuer

    • authorize_scopes

    • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

      • authorize_url

      • token_url

      • attributes_url

      • jwks_uri

    • Amazon Cognito sets the value of the following keys automatically. They are read-only.

      • attributes_url_add_attributes

  • For SAML providers:

    • MetadataFile or MetadataURL

    • IDPSignout optional

*/ @property (nonatomic, strong) NSDictionary * _Nullable providerDetails; /**

The IdP name.

*/ @property (nonatomic, strong) NSString * _Nullable providerName; /**

The IdP type.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderIdentityProviderTypeType providerType; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Initiates the authentication request.

Required parameters: [AuthFlow, ClientId] */ @interface AWSCognitoIdentityProviderInitiateAuthRequest : AWSRequest /**

The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata; /**

The authentication flow for this call to run. The API action will depend on this value. For example:

  • REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

  • USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

  • USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns the next challenge or tokens.

Valid values include:

  • USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

  • REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

  • CUSTOM_AUTH: Custom authentication flow.

  • USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

ADMIN_NO_SRP_AUTH isn't a valid value.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderAuthFlowType authFlow; /**

The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow:

  • For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

  • For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

  • For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

*/ @property (nonatomic, strong) NSDictionary * _Nullable authParameters; /**

The app client ID.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

  • Pre signup

  • Pre authentication

  • User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

  • Post authentication

  • Custom message

  • Pre token generation

  • Create auth challenge

  • Define auth challenge

  • Verify auth challenge

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData; @end /**

Initiates the authentication response.

*/ @interface AWSCognitoIdentityProviderInitiateAuthResponse : AWSModel /**

The result of the authentication response. This result is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAuthenticationResultType * _Nullable authenticationResult; /**

The name of the challenge that you're responding to with this call. This name is returned in the AdminInitiateAuth response if you must pass another challenge.

Valid values include the following:

All of the following challenges require USERNAME and SECRET_HASH (if applicable) in the parameters.

  • SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.

  • PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.

  • CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

  • DEVICE_SRP_AUTH: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.

  • DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.

  • NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login.

    Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see RespondToAuthChallenge.

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.

  • MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.

    To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call InitiateAuth again to restart sign-in.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName; /**

The challenge parameters. These are returned in the InitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge).

All challenges require USERNAME and SECRET_HASH (if applicable).

*/ @property (nonatomic, strong) NSDictionary * _Nullable challengeParameters; /**

The session that should pass both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

*/ @property (nonatomic, strong) NSString * _Nullable session; @end /**

Specifies the configuration for Lambda triggers.

*/ @interface AWSCognitoIdentityProviderLambdaConfigType : AWSModel /**

Creates an authentication challenge.

*/ @property (nonatomic, strong) NSString * _Nullable createAuthChallenge; /**

A custom email sender Lambda trigger.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCustomEmailLambdaVersionConfigType * _Nullable customEmailSender; /**

A custom Message Lambda trigger.

*/ @property (nonatomic, strong) NSString * _Nullable customMessage; /**

A custom SMS sender Lambda trigger.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCustomSMSLambdaVersionConfigType * _Nullable customSMSSender; /**

Defines the authentication challenge.

*/ @property (nonatomic, strong) NSString * _Nullable defineAuthChallenge; /**

The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.

*/ @property (nonatomic, strong) NSString * _Nullable KMSKeyID; /**

A post-authentication Lambda trigger.

*/ @property (nonatomic, strong) NSString * _Nullable postAuthentication; /**

A post-confirmation Lambda trigger.

*/ @property (nonatomic, strong) NSString * _Nullable postConfirmation; /**

A pre-authentication Lambda trigger.

*/ @property (nonatomic, strong) NSString * _Nullable preAuthentication; /**

A pre-registration Lambda trigger.

*/ @property (nonatomic, strong) NSString * _Nullable preSignUp; /**

A Lambda trigger that is invoked before token generation.

*/ @property (nonatomic, strong) NSString * _Nullable preTokenGeneration; /**

The user migration Lambda config type.

*/ @property (nonatomic, strong) NSString * _Nullable userMigration; /**

Verifies the authentication challenge response.

*/ @property (nonatomic, strong) NSString * _Nullable verifyAuthChallengeResponse; @end /**

Represents the request to list the devices.

Required parameters: [AccessToken] */ @interface AWSCognitoIdentityProviderListDevicesRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The limit of the device request.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

The pagination token for the list request.

*/ @property (nonatomic, strong) NSString * _Nullable paginationToken; @end /**

Represents the response to list devices.

*/ @interface AWSCognitoIdentityProviderListDevicesResponse : AWSModel /**

The devices returned in the list devices response.

*/ @property (nonatomic, strong) NSArray * _Nullable devices; /**

The pagination token for the list device response.

*/ @property (nonatomic, strong) NSString * _Nullable paginationToken; @end /** */ @interface AWSCognitoIdentityProviderListGroupsRequest : AWSRequest /**

The limit of the request to list groups.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderListGroupsResponse : AWSModel /**

The group objects for the groups.

*/ @property (nonatomic, strong) NSArray * _Nullable groups; /**

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSCognitoIdentityProviderListIdentityProvidersRequest : AWSRequest /**

The maximum number of IdPs to return.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

A pagination token.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderListIdentityProvidersResponse : AWSModel /**

A pagination token.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

A list of IdP objects.

*/ @property (nonatomic, strong) NSArray * _Nullable providers; @end /** */ @interface AWSCognitoIdentityProviderListResourceServersRequest : AWSRequest /**

The maximum number of resource servers to return.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

A pagination token.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderListResourceServersResponse : AWSModel /**

A pagination token.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The resource servers.

*/ @property (nonatomic, strong) NSArray * _Nullable resourceServers; @end /** */ @interface AWSCognitoIdentityProviderListTagsForResourceRequest : AWSRequest /**

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; @end /** */ @interface AWSCognitoIdentityProviderListTagsForResourceResponse : AWSModel /**

The tags that are assigned to the user pool.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; @end /**

Represents the request to list the user import jobs.

Required parameters: [UserPoolId, MaxResults] */ @interface AWSCognitoIdentityProviderListUserImportJobsRequest : AWSRequest /**

The maximum number of import jobs you want the request to return.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.

*/ @property (nonatomic, strong) NSString * _Nullable paginationToken; /**

The user pool ID for the user pool that the users are being imported into.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the response from the server to the request to list the user import jobs.

*/ @interface AWSCognitoIdentityProviderListUserImportJobsResponse : AWSModel /**

An identifier that can be used to return the next set of user import jobs in the list.

*/ @property (nonatomic, strong) NSString * _Nullable paginationToken; /**

The user import jobs.

*/ @property (nonatomic, strong) NSArray * _Nullable userImportJobs; @end /**

Represents the request to list the user pool clients.

Required parameters: [UserPoolId] */ @interface AWSCognitoIdentityProviderListUserPoolClientsRequest : AWSRequest /**

The maximum number of results you want the request to return when listing the user pool clients.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The user pool ID for the user pool where you want to list user pool clients.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the response from the server that lists user pool clients.

*/ @interface AWSCognitoIdentityProviderListUserPoolClientsResponse : AWSModel /**

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The user pool clients in the response that lists user pool clients.

*/ @property (nonatomic, strong) NSArray * _Nullable userPoolClients; @end /**

Represents the request to list user pools.

Required parameters: [MaxResults] */ @interface AWSCognitoIdentityProviderListUserPoolsRequest : AWSRequest /**

The maximum number of results you want the request to return when listing the user pools.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**

Represents the response to list user pools.

*/ @interface AWSCognitoIdentityProviderListUserPoolsResponse : AWSModel /**

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The user pools from the response to list users.

*/ @property (nonatomic, strong) NSArray * _Nullable userPools; @end /** */ @interface AWSCognitoIdentityProviderListUsersInGroupRequest : AWSRequest /**

The name of the group.

*/ @property (nonatomic, strong) NSString * _Nullable groupName; /**

The limit of the request to list users.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderListUsersInGroupResponse : AWSModel /**

An identifier that you can use in a later request to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

The users returned in the request to list users.

*/ @property (nonatomic, strong) NSArray * _Nullable users; @end /**

Represents the request to list users.

Required parameters: [UserPoolId] */ @interface AWSCognitoIdentityProviderListUsersRequest : AWSRequest /**

An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.

*/ @property (nonatomic, strong) NSArray * _Nullable attributesToGet; /**

A filter string of the form "AttributeNameFilter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name = \"Reddy\"".

  • AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.

  • Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".

  • AttributeValue: The attribute value that must be matched for each user.

If the filter string is empty, ListUsers returns all users in the user pool.

You can only search for the following standard attributes:

  • username (case-sensitive)

  • email

  • phone_number

  • name

  • given_name

  • family_name

  • preferred_username

  • cognito:user_status (called Status in the Console) (case-insensitive)

  • status (called Enabled in the Console) (case-sensitive)

  • sub

Custom attributes aren't searchable.

You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable filter; /**

Maximum number of users to be returned.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable paginationToken; /**

The user pool ID for the user pool on which the search should be performed.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

The response from the request to list users.

*/ @interface AWSCognitoIdentityProviderListUsersResponse : AWSModel /**

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

*/ @property (nonatomic, strong) NSString * _Nullable paginationToken; /**

The users returned in the request to list users.

*/ @property (nonatomic, strong) NSArray * _Nullable users; @end /**

This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.

*/ @interface AWSCognitoIdentityProviderMFAOptionType : AWSModel /**

The attribute name of the MFA option type. The only valid value is phone_number.

*/ @property (nonatomic, strong) NSString * _Nullable attributeName; /**

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderDeliveryMediumType deliveryMedium; @end /**

The message template structure.

*/ @interface AWSCognitoIdentityProviderMessageTemplateType : AWSModel /**

The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

*/ @property (nonatomic, strong) NSString * _Nullable emailMessage; /**

The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.

*/ @property (nonatomic, strong) NSString * _Nullable emailSubject; /**

The message template for SMS messages.

*/ @property (nonatomic, strong) NSString * _Nullable SMSMessage; @end /**

The new device metadata type.

*/ @interface AWSCognitoIdentityProviderLatestDeviceMetadataType : AWSModel /**

The device group key.

*/ @property (nonatomic, strong) NSString * _Nullable deviceGroupKey; /**

The device key.

*/ @property (nonatomic, strong) NSString * _Nullable deviceKey; @end /**

The notify configuration type.

Required parameters: [SourceArn] */ @interface AWSCognitoIdentityProviderNotifyConfigurationType : AWSModel /**

Email template used when a detected risk event is blocked.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderNotifyEmailType * _Nullable blockEmail; /**

The email address that is sending the email. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.

*/ @property (nonatomic, strong) NSString * _Nullable from; /**

The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderNotifyEmailType * _Nullable mfaEmail; /**

The email template used when a detected risk event is allowed.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderNotifyEmailType * _Nullable noActionEmail; /**

The destination to which the receiver of an email should reply to.

*/ @property (nonatomic, strong) NSString * _Nullable replyTo; /**

The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the From parameter.

*/ @property (nonatomic, strong) NSString * _Nullable sourceArn; @end /**

The notify email type.

Required parameters: [Subject] */ @interface AWSCognitoIdentityProviderNotifyEmailType : AWSModel /**

The email HTML body.

*/ @property (nonatomic, strong) NSString * _Nullable htmlBody; /**

The email subject.

*/ @property (nonatomic, strong) NSString * _Nullable subject; /**

The email text body.

*/ @property (nonatomic, strong) NSString * _Nullable textBody; @end /**

The minimum and maximum values of an attribute that is of the number data type.

*/ @interface AWSCognitoIdentityProviderNumberAttributeConstraintsType : AWSModel /**

The maximum value of an attribute that is of the number data type.

*/ @property (nonatomic, strong) NSString * _Nullable maxValue; /**

The minimum value of an attribute that is of the number data type.

*/ @property (nonatomic, strong) NSString * _Nullable minValue; @end /**

The password policy type.

*/ @interface AWSCognitoIdentityProviderPasswordPolicyType : AWSModel /**

The minimum length of the password in the policy that you have set. This value can't be less than 6.

*/ @property (nonatomic, strong) NSNumber * _Nullable minimumLength; /**

In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.

*/ @property (nonatomic, strong) NSNumber * _Nullable requireLowercase; /**

In the password policy that you have set, refers to whether you have required users to use at least one number in their password.

*/ @property (nonatomic, strong) NSNumber * _Nullable requireNumbers; /**

In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.

*/ @property (nonatomic, strong) NSNumber * _Nullable requireSymbols; /**

In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.

*/ @property (nonatomic, strong) NSNumber * _Nullable requireUppercase; /**

The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password.

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

 */ @property (nonatomic, strong) NSNumber * _Nullable temporaryPasswordValidityDays; @end /**

A container for IdP details.

*/ @interface AWSCognitoIdentityProviderProviderDescription : AWSModel /**

The date the provider was added to the user pool.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

The date the provider was last modified.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate; /**

The IdP name.

*/ @property (nonatomic, strong) NSString * _Nullable providerName; /**

The IdP type.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderIdentityProviderTypeType providerType; @end /**

A container for information about an IdP for a user pool.

*/ @interface AWSCognitoIdentityProviderProviderUserIdentifierType : AWSModel /**

The name of the provider attribute to link to, such as NameID.

*/ @property (nonatomic, strong) NSString * _Nullable providerAttributeName; /**

The value of the provider attribute to link to, such as xxxxx_account.

*/ @property (nonatomic, strong) NSString * _Nullable providerAttributeValue; /**

The name of the provider, such as Facebook, Google, or Login with Amazon.

*/ @property (nonatomic, strong) NSString * _Nullable providerName; @end /**

A map containing a priority as a key, and recovery method name as a value.

Required parameters: [Priority, Name] */ @interface AWSCognitoIdentityProviderRecoveryOptionType : AWSModel /**

The recovery method for a user.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderRecoveryOptionNameType name; /**

A positive integer specifying priority of a method with 1 being the highest priority.

*/ @property (nonatomic, strong) NSNumber * _Nullable priority; @end /**

Represents the request to resend the confirmation code.

Required parameters: [ClientId, Username] */ @interface AWSCognitoIdentityProviderResendConfirmationCodeRequest : AWSRequest /**

The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode calls.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata; /**

The ID of the client associated with the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

*/ @property (nonatomic, strong) NSString * _Nullable secretHash; /**

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData; /**

The username attribute of the user to whom you want to resend a confirmation code.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

The response from the server when Amazon Cognito makes the request to resend a confirmation code.

*/ @interface AWSCognitoIdentityProviderResendConfirmationCodeResponse : AWSModel /**

The code delivery details returned by the server in response to the request to resend the confirmation code.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCodeDeliveryDetailsType * _Nullable codeDeliveryDetails; @end /**

A resource server scope.

Required parameters: [ScopeName, ScopeDescription] */ @interface AWSCognitoIdentityProviderResourceServerScopeType : AWSModel /**

A description of the scope.

*/ @property (nonatomic, strong) NSString * _Nullable scopeDescription; /**

The name of the scope.

*/ @property (nonatomic, strong) NSString * _Nullable scopeName; @end /**

A container for information about a resource server for a user pool.

*/ @interface AWSCognitoIdentityProviderResourceServerType : AWSModel /**

The identifier for the resource server.

*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**

The name of the resource server.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

A list of scopes that are defined for the resource server.

*/ @property (nonatomic, strong) NSArray * _Nullable scopes; /**

The user pool ID for the user pool that hosts the resource server.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

The request to respond to an authentication challenge.

Required parameters: [ClientId, ChallengeName] */ @interface AWSCognitoIdentityProviderRespondToAuthChallengeRequest : AWSRequest /**

The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata; /**

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH isn't a valid value.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName; /**

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

    PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.

*/ @property (nonatomic, strong) NSDictionary * _Nullable challengeResponses; /**

The app client ID.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

The session that should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

*/ @property (nonatomic, strong) NSString * _Nullable session; /**

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData; @end /**

The response to respond to the authentication challenge.

*/ @interface AWSCognitoIdentityProviderRespondToAuthChallengeResponse : AWSModel /**

The result returned by the server in response to the request to respond to the authentication challenge.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAuthenticationResultType * _Nullable authenticationResult; /**

The challenge name. For more information, see InitiateAuth.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName; /**

The challenge parameters. For more information, see InitiateAuth.

*/ @property (nonatomic, strong) NSDictionary * _Nullable challengeParameters; /**

The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

*/ @property (nonatomic, strong) NSString * _Nullable session; @end /** */ @interface AWSCognitoIdentityProviderRevokeTokenRequest : AWSRequest /**

The client ID for the token that you want to revoke.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The secret for the client ID. This is required only if the client ID has a secret.

*/ @property (nonatomic, strong) NSString * _Nullable clientSecret; /**

The refresh token that you want to revoke.

*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSCognitoIdentityProviderRevokeTokenResponse : AWSModel @end /**

The risk configuration type.

*/ @interface AWSCognitoIdentityProviderRiskConfigurationType : AWSModel /**

The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverRiskConfigurationType * _Nullable accountTakeoverRiskConfiguration; /**

The app client ID.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The compromised credentials risk configuration object, including the EventFilter and the EventAction.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCompromisedCredentialsRiskConfigurationType * _Nullable compromisedCredentialsRiskConfiguration; /**

The last modified date.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate; /**

The configuration to override the risk decision.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderRiskExceptionConfigurationType * _Nullable riskExceptionConfiguration; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

The type of the configuration to override the risk decision.

*/ @interface AWSCognitoIdentityProviderRiskExceptionConfigurationType : AWSModel /**

Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation, a compact representation of an IP address and its routing prefix.

*/ @property (nonatomic, strong) NSArray * _Nullable blockedIPRangeList; /**

Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation.

*/ @property (nonatomic, strong) NSArray * _Nullable skippedIPRangeList; @end /**

The type used for enabling SMS multi-factor authentication (MFA) at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

*/ @interface AWSCognitoIdentityProviderSMSMfaSettingsType : AWSModel /**

Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**

Specifies whether SMS is the preferred MFA method.

*/ @property (nonatomic, strong) NSNumber * _Nullable preferredMfa; @end /**

Contains information about the schema attribute.

*/ @interface AWSCognitoIdentityProviderSchemaAttributeType : AWSModel /**

The attribute data type.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderAttributeDataType attributeDataType; /**

You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.

Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.

*/ @property (nonatomic, strong) NSNumber * _Nullable developerOnlyAttribute; /**

Specifies whether the value of the attribute can be changed.

For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.

*/ @property (nonatomic, strong) NSNumber * _Nullable varying; /**

A schema attribute of the name type.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

Specifies the constraints for an attribute of the number type.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderNumberAttributeConstraintsType * _Nullable numberAttributeConstraints; /**

Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.

*/ @property (nonatomic, strong) NSNumber * _Nullable required; /**

Specifies the constraints for an attribute of the string type.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderStringAttributeConstraintsType * _Nullable stringAttributeConstraints; @end /** */ @interface AWSCognitoIdentityProviderSetRiskConfigurationRequest : AWSRequest /**

The account takeover risk configuration.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverRiskConfigurationType * _Nullable accountTakeoverRiskConfiguration; /**

The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.

Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The compromised credentials risk configuration.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCompromisedCredentialsRiskConfigurationType * _Nullable compromisedCredentialsRiskConfiguration; /**

The configuration to override the risk decision.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderRiskExceptionConfigurationType * _Nullable riskExceptionConfiguration; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderSetRiskConfigurationResponse : AWSModel /**

The risk configuration.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderRiskConfigurationType * _Nullable riskConfiguration; @end /** */ @interface AWSCognitoIdentityProviderSetUICustomizationRequest : AWSRequest /**

The CSS values in the UI customization.

*/ @property (nonatomic, strong) NSString * _Nullable CSS; /**

The client ID for the client app.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The uploaded logo image for the UI customization.

*/ @property (nonatomic, strong) NSData * _Nullable imageFile; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderSetUICustomizationResponse : AWSModel /**

The UI customization information.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUICustomizationType * _Nullable UICustomization; @end /** */ @interface AWSCognitoIdentityProviderSetUserMFAPreferenceRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The SMS text message multi-factor authentication (MFA) settings.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSMSMfaSettingsType * _Nullable SMSMfaSettings; /**

The time-based one-time password (TOTP) software token MFA settings.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSoftwareTokenMfaSettingsType * _Nullable softwareTokenMfaSettings; @end /** */ @interface AWSCognitoIdentityProviderSetUserMFAPreferenceResponse : AWSModel @end /** */ @interface AWSCognitoIdentityProviderSetUserPoolMfaConfigRequest : AWSRequest /**

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:

  • OFF MFA won't be used for any users.

  • ON MFA is required for all users to sign in.

  • OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration; /**

The SMS text message MFA configuration.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSmsMfaConfigType * _Nullable smsMfaConfiguration; /**

The software token MFA configuration.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSoftwareTokenMfaConfigType * _Nullable softwareTokenMfaConfiguration; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderSetUserPoolMfaConfigResponse : AWSModel /**

The MFA configuration. Valid values include:

  • OFF MFA won't be used for any users.

  • ON MFA is required for all users to sign in.

  • OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration; /**

The SMS text message MFA configuration.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSmsMfaConfigType * _Nullable smsMfaConfiguration; /**

The software token MFA configuration.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSoftwareTokenMfaConfigType * _Nullable softwareTokenMfaConfiguration; @end /**

Represents the request to set user settings.

Required parameters: [AccessToken, MFAOptions] */ @interface AWSCognitoIdentityProviderSetUserSettingsRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

*/ @property (nonatomic, strong) NSArray * _Nullable MFAOptions; @end /**

The response from the server for a set user settings request.

*/ @interface AWSCognitoIdentityProviderSetUserSettingsResponse : AWSModel @end /**

Represents the request to register a user.

Required parameters: [ClientId, Username, Password] */ @interface AWSCognitoIdentityProviderSignUpRequest : AWSRequest /**

The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata; /**

The ID of the client associated with the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

The password of the user you want to register.

*/ @property (nonatomic, strong) NSString * _Nullable password; /**

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

*/ @property (nonatomic, strong) NSString * _Nullable secretHash; /**

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

*/ @property (nonatomic, strong) NSArray * _Nullable userAttributes; /**

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData; /**

The user name of the user you want to register.

*/ @property (nonatomic, strong) NSString * _Nullable username; /**

The validation data in the request to register a user.

*/ @property (nonatomic, strong) NSArray * _Nullable validationData; @end /**

The response from the server for a registration request.

Required parameters: [UserConfirmed, UserSub] */ @interface AWSCognitoIdentityProviderSignUpResponse : AWSModel /**

The code delivery details returned by the server response to the user registration request.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCodeDeliveryDetailsType * _Nullable codeDeliveryDetails; /**

A response from the server indicating that a user registration has been confirmed.

*/ @property (nonatomic, strong) NSNumber * _Nullable userConfirmed; /**

The UUID of the authenticated user. This isn't the same as username.

*/ @property (nonatomic, strong) NSString * _Nullable userSub; @end /**

The SMS configuration type is the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

Required parameters: [SnsCallerArn] */ @interface AWSCognitoIdentityProviderSmsConfigurationType : AWSModel /**

The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party

*/ @property (nonatomic, strong) NSString * _Nullable externalId; /**

The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.

*/ @property (nonatomic, strong) NSString * _Nullable snsCallerArn; /**

The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.

Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.

*/ @property (nonatomic, strong) NSString * _Nullable snsRegion; @end /**

The SMS text message multi-factor authentication (MFA) configuration type.

*/ @interface AWSCognitoIdentityProviderSmsMfaConfigType : AWSModel /**

The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.

*/ @property (nonatomic, strong) NSString * _Nullable smsAuthenticationMessage; /**

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType * _Nullable smsConfiguration; @end /**

The type used for enabling software token MFA at the user pool level.

*/ @interface AWSCognitoIdentityProviderSoftwareTokenMfaConfigType : AWSModel /**

Specifies whether software token MFA is activated.

*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; @end /**

The type used for enabling software token MFA at the user level. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

*/ @interface AWSCognitoIdentityProviderSoftwareTokenMfaSettingsType : AWSModel /**

Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**

Specifies whether software token MFA is the preferred MFA method.

*/ @property (nonatomic, strong) NSNumber * _Nullable preferredMfa; @end /**

Represents the request to start the user import job.

Required parameters: [UserPoolId, JobId] */ @interface AWSCognitoIdentityProviderStartUserImportJobRequest : AWSRequest /**

The job ID for the user import job.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; /**

The user pool ID for the user pool that the users are being imported into.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the response from the server to the request to start the user import job.

*/ @interface AWSCognitoIdentityProviderStartUserImportJobResponse : AWSModel /**

The job object that represents the user import job.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserImportJobType * _Nullable userImportJob; @end /**

Represents the request to stop the user import job.

Required parameters: [UserPoolId, JobId] */ @interface AWSCognitoIdentityProviderStopUserImportJobRequest : AWSRequest /**

The job ID for the user import job.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; /**

The user pool ID for the user pool that the users are being imported into.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Represents the response from the server to the request to stop the user import job.

*/ @interface AWSCognitoIdentityProviderStopUserImportJobResponse : AWSModel /**

The job object that represents the user import job.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserImportJobType * _Nullable userImportJob; @end /**

The constraints associated with a string attribute.

*/ @interface AWSCognitoIdentityProviderStringAttributeConstraintsType : AWSModel /**

The maximum length.

*/ @property (nonatomic, strong) NSString * _Nullable maxLength; /**

The minimum length.

*/ @property (nonatomic, strong) NSString * _Nullable minLength; @end /** */ @interface AWSCognitoIdentityProviderTagResourceRequest : AWSRequest /**

The Amazon Resource Name (ARN) of the user pool to assign the tags to.

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

The tags to assign to the user pool.

*/ @property (nonatomic, strong) NSDictionary * _Nullable tags; @end /** */ @interface AWSCognitoIdentityProviderTagResourceResponse : AWSModel @end /**

The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.

*/ @interface AWSCognitoIdentityProviderTokenValidityUnitsType : AWSModel /**

A time unit of seconds, minutes, hours, or days for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderTimeUnitsType accessToken; /**

A time unit of seconds, minutes, hours, or days for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderTimeUnitsType idToken; /**

A time unit of seconds, minutes, hours, or days for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderTimeUnitsType refreshToken; @end /**

A container for the UI customization information for a user pool's built-in app UI.

*/ @interface AWSCognitoIdentityProviderUICustomizationType : AWSModel /**

The CSS values in the UI customization.

*/ @property (nonatomic, strong) NSString * _Nullable CSS; /**

The CSS version number.

*/ @property (nonatomic, strong) NSString * _Nullable CSSVersion; /**

The client ID for the client app.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The creation date for the UI customization.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

The logo image for the UI customization.

*/ @property (nonatomic, strong) NSString * _Nullable imageUrl; /**

The last-modified date for the UI customization.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderUntagResourceRequest : AWSRequest /**

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

The keys of the tags to remove from the user pool.

*/ @property (nonatomic, strong) NSArray * _Nullable tagKeys; @end /** */ @interface AWSCognitoIdentityProviderUntagResourceResponse : AWSModel @end /** */ @interface AWSCognitoIdentityProviderUpdateAuthEventFeedbackRequest : AWSRequest /**

The event ID.

*/ @property (nonatomic, strong) NSString * _Nullable eventId; /**

The feedback token.

*/ @property (nonatomic, strong) NSString * _Nullable feedbackToken; /**

The authentication event feedback value.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderFeedbackValueType feedbackValue; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The user pool username.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /** */ @interface AWSCognitoIdentityProviderUpdateAuthEventFeedbackResponse : AWSModel @end /**

Represents the request to update the device status.

Required parameters: [AccessToken, DeviceKey] */ @interface AWSCognitoIdentityProviderUpdateDeviceStatusRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose device status you want to update.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The device key.

*/ @property (nonatomic, strong) NSString * _Nullable deviceKey; /**

The status of whether a device is remembered.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderDeviceRememberedStatusType deviceRememberedStatus; @end /**

The response to the request to update the device status.

*/ @interface AWSCognitoIdentityProviderUpdateDeviceStatusResponse : AWSModel @end /** */ @interface AWSCognitoIdentityProviderUpdateGroupRequest : AWSRequest /**

A string containing the new description of the group.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

The name of the group.

*/ @property (nonatomic, strong) NSString * _Nullable groupName; /**

The new precedence value for the group. For more information about this parameter, see CreateGroup.

*/ @property (nonatomic, strong) NSNumber * _Nullable precedence; /**

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

*/ @property (nonatomic, strong) NSString * _Nullable roleArn; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderUpdateGroupResponse : AWSModel /**

The group object for the group.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderGroupType * _Nullable group; @end /** */ @interface AWSCognitoIdentityProviderUpdateIdentityProviderRequest : AWSRequest /**

The IdP attribute mapping to be changed.

*/ @property (nonatomic, strong) NSDictionary * _Nullable attributeMapping; /**

A list of IdP identifiers.

*/ @property (nonatomic, strong) NSArray * _Nullable idpIdentifiers; /**

The IdP details to be updated, such as MetadataURL and MetadataFile.

*/ @property (nonatomic, strong) NSDictionary * _Nullable providerDetails; /**

The IdP name.

*/ @property (nonatomic, strong) NSString * _Nullable providerName; /**

The user pool ID.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderUpdateIdentityProviderResponse : AWSModel /**

The identity provider details.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderIdentityProviderType * _Nullable identityProvider; @end /** */ @interface AWSCognitoIdentityProviderUpdateResourceServerRequest : AWSRequest /**

The identifier for the resource server.

*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**

The name of the resource server.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The scope values to be set for the resource server.

*/ @property (nonatomic, strong) NSArray * _Nullable scopes; /**

The user pool ID for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /** */ @interface AWSCognitoIdentityProviderUpdateResourceServerResponse : AWSModel /**

The resource server.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderResourceServerType * _Nullable resourceServer; @end /**

Represents the request to update user attributes.

Required parameters: [UserAttributes, AccessToken] */ @interface AWSCognitoIdentityProviderUpdateUserAttributesRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

 */ @property (nonatomic, strong) NSDictionary * _Nullable clientMetadata; /**

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

*/ @property (nonatomic, strong) NSArray * _Nullable userAttributes; @end /**

Represents the response from the server for the request to update user attributes.

*/ @interface AWSCognitoIdentityProviderUpdateUserAttributesResponse : AWSModel /**

The code delivery details list from the server for the request to update user attributes.

*/ @property (nonatomic, strong) NSArray * _Nullable codeDeliveryDetailsList; @end /**

Represents the request to update the user pool client.

Required parameters: [UserPoolId, ClientId] */ @interface AWSCognitoIdentityProviderUpdateUserPoolClientRequest : AWSRequest /**

The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

*/ @property (nonatomic, strong) NSNumber * _Nullable accessTokenValidity; /**

The allowed OAuth flows.

code

Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.

implicit

Issue the access token (and, optionally, ID token, based on scopes) directly to your user.

client_credentials

Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.

*/ @property (nonatomic, strong) NSArray * _Nullable allowedOAuthFlows; /**

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

*/ @property (nonatomic, strong) NSNumber * _Nullable allowedOAuthFlowsUserPoolClient; /**

The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

*/ @property (nonatomic, strong) NSArray * _Nullable allowedOAuthScopes; /**

The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.

In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

 */ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsConfigurationType * _Nullable analyticsConfiguration; /**

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

*/ @property (nonatomic, strong) NSNumber * _Nullable authSessionValidity; /**

A list of allowed redirect (callback) URLs for the IdPs.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

*/ @property (nonatomic, strong) NSArray * _Nullable callbackURLs; /**

The ID of the client associated with the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The client name from the update user pool client request.

*/ @property (nonatomic, strong) NSString * _Nullable clientName; /**

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

*/ @property (nonatomic, strong) NSString * _Nullable defaultRedirectURI; /**

Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.

*/ @property (nonatomic, strong) NSNumber * _Nullable enablePropagateAdditionalUserContextData; /**

Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.

*/ @property (nonatomic, strong) NSNumber * _Nullable enableTokenRevocation; /**

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.

*/ @property (nonatomic, strong) NSArray * _Nullable explicitAuthFlows; /**

The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

*/ @property (nonatomic, strong) NSNumber * _Nullable idTokenValidity; /**

A list of allowed logout URLs for the IdPs.

*/ @property (nonatomic, strong) NSArray * _Nullable logoutURLs; /**

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.

Valid values include:

  • ENABLED - This prevents user existence-related errors.

  • LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderPreventUserExistenceErrorTypes preventUserExistenceErrors; /**

The read-only attributes of the user pool.

*/ @property (nonatomic, strong) NSArray * _Nullable readAttributes; /**

The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

*/ @property (nonatomic, strong) NSNumber * _Nullable refreshTokenValidity; /**

A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and the names of your own SAML and OIDC providers.

*/ @property (nonatomic, strong) NSArray * _Nullable supportedIdentityProviders; /**

The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderTokenValidityUnitsType * _Nullable tokenValidityUnits; /**

The user pool ID for the user pool where you want to update the user pool client.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The writeable attributes of the user pool.

*/ @property (nonatomic, strong) NSArray * _Nullable writeAttributes; @end /**

Represents the response from the server to the request to update the user pool client.

*/ @interface AWSCognitoIdentityProviderUpdateUserPoolClientResponse : AWSModel /**

The user pool client value from the response from the server when you request to update the user pool client.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolClientType * _Nullable userPoolClient; @end /**

The UpdateUserPoolDomain request input.

Required parameters: [Domain, UserPoolId, CustomDomainConfig] */ @interface AWSCognitoIdentityProviderUpdateUserPoolDomainRequest : AWSRequest /**

The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderCustomDomainConfigType * _Nullable customDomainConfig; /**

The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.

This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.

*/ @property (nonatomic, strong) NSString * _Nullable domain; /**

The ID of the user pool that is associated with the custom domain whose certificate you're updating.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

The UpdateUserPoolDomain response output.

*/ @interface AWSCognitoIdentityProviderUpdateUserPoolDomainResponse : AWSModel /**

The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.

*/ @property (nonatomic, strong) NSString * _Nullable cloudFrontDomain; @end /**

Represents the request to update the user pool.

Required parameters: [UserPoolId] */ @interface AWSCognitoIdentityProviderUpdateUserPoolRequest : AWSRequest /**

The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAccountRecoverySettingType * _Nullable accountRecoverySetting; /**

The configuration for AdminCreateUser requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAdminCreateUserConfigType * _Nullable adminCreateUserConfig; /**

The attributes that are automatically verified when Amazon Cognito requests to update user pools.

*/ @property (nonatomic, strong) NSArray * _Nullable autoVerifiedAttributes; /**

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderDeletionProtectionType deletionProtection; /**

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

 */ @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceConfigurationType * _Nullable deviceConfiguration; /**

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderEmailConfigurationType * _Nullable emailConfiguration; /**

This parameter is no longer used. See VerificationMessageTemplateType.

*/ @property (nonatomic, strong) NSString * _Nullable emailVerificationMessage; /**

This parameter is no longer used. See VerificationMessageTemplateType.

*/ @property (nonatomic, strong) NSString * _Nullable emailVerificationSubject; /**

The Lambda configuration information from the request to update the user pool.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType * _Nullable lambdaConfig; /**

Possible values include:

  • OFF - MFA tokens aren't required and can't be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.

  • OPTIONAL - Users have the option when registering to create an MFA token.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration; /**

A container with the policies you want to update in a user pool.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolPolicyType * _Nullable policies; /**

The contents of the SMS authentication message.

*/ @property (nonatomic, strong) NSString * _Nullable smsAuthenticationMessage; /**

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType * _Nullable smsConfiguration; /**

This parameter is no longer used. See VerificationMessageTemplateType.

*/ @property (nonatomic, strong) NSString * _Nullable smsVerificationMessage; /**

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserAttributeUpdateSettingsType * _Nullable userAttributeUpdateSettings; /**

Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolAddOnsType * _Nullable userPoolAddOns; /**

The user pool ID for the user pool you want to update.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

*/ @property (nonatomic, strong) NSDictionary * _Nullable userPoolTags; /**

The template for verification messages.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderVerificationMessageTemplateType * _Nullable verificationMessageTemplate; @end /**

Represents the response from the server when you make a request to update the user pool.

*/ @interface AWSCognitoIdentityProviderUpdateUserPoolResponse : AWSModel @end /**

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

*/ @interface AWSCognitoIdentityProviderUserAttributeUpdateSettingsType : AWSModel /**

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.

*/ @property (nonatomic, strong) NSArray * _Nullable attributesRequireVerificationBeforeUpdate; @end /**

Contextual data, such as the user's device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

*/ @interface AWSCognitoIdentityProviderUserContextDataType : AWSModel /**

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

*/ @property (nonatomic, strong) NSString * _Nullable encodedData; /**

The source IP address of your user's device.

*/ @property (nonatomic, strong) NSString * _Nullable ipAddress; @end /**

The user import job type.

*/ @interface AWSCognitoIdentityProviderUserImportJobType : AWSModel /**

The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable cloudWatchLogsRoleArn; /**

The date when the user import job was completed.

*/ @property (nonatomic, strong) NSDate * _Nullable completionDate; /**

The message returned when the user import job is completed.

*/ @property (nonatomic, strong) NSString * _Nullable completionMessage; /**

The date the user import job was created.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

The number of users that couldn't be imported.

*/ @property (nonatomic, strong) NSNumber * _Nullable failedUsers; /**

The number of users that were successfully imported.

*/ @property (nonatomic, strong) NSNumber * _Nullable importedUsers; /**

The job ID for the user import job.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; /**

The job name for the user import job.

*/ @property (nonatomic, strong) NSString * _Nullable jobName; /**

The pre-signed URL to be used to upload the .csv file.

*/ @property (nonatomic, strong) NSString * _Nullable preSignedUrl; /**

The number of users that were skipped.

*/ @property (nonatomic, strong) NSNumber * _Nullable skippedUsers; /**

The date when the user import job was started.

*/ @property (nonatomic, strong) NSDate * _Nullable startDate; /**

The status of the user import job. One of the following:

  • Created - The job was created but not started.

  • Pending - A transition state. You have started the job, but it has not begun importing users yet.

  • InProgress - The job has started, and users are being imported.

  • Stopping - You have stopped the job, but the job has not stopped importing users yet.

  • Stopped - You have stopped the job, and the job has stopped importing users.

  • Succeeded - The job has completed successfully.

  • Failed - The job has stopped due to an error.

  • Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderUserImportJobStatusType status; /**

The user pool ID for the user pool that the users are being imported into.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

The user pool add-ons type.

Required parameters: [AdvancedSecurityMode] */ @interface AWSCognitoIdentityProviderUserPoolAddOnsType : AWSModel /**

The advanced security mode.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderAdvancedSecurityModeType advancedSecurityMode; @end /**

The description of the user pool client.

*/ @interface AWSCognitoIdentityProviderUserPoolClientDescription : AWSModel /**

The ID of the client associated with the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The client name from the user pool client description.

*/ @property (nonatomic, strong) NSString * _Nullable clientName; /**

The user pool ID for the user pool where you want to describe the user pool client.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; @end /**

Contains information about a user pool client.

*/ @interface AWSCognitoIdentityProviderUserPoolClientType : AWSModel /**

The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

*/ @property (nonatomic, strong) NSNumber * _Nullable accessTokenValidity; /**

The allowed OAuth flows.

code

Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.

implicit

Issue the access token (and, optionally, ID token, based on scopes) directly to your user.

client_credentials

Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.

*/ @property (nonatomic, strong) NSArray * _Nullable allowedOAuthFlows; /**

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

*/ @property (nonatomic, strong) NSNumber * _Nullable allowedOAuthFlowsUserPoolClient; /**

The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.

*/ @property (nonatomic, strong) NSArray * _Nullable allowedOAuthScopes; /**

The Amazon Pinpoint analytics configuration for the user pool client.

Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.

 */ @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsConfigurationType * _Nullable analyticsConfiguration; /**

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

*/ @property (nonatomic, strong) NSNumber * _Nullable authSessionValidity; /**

A list of allowed redirect (callback) URLs for the IdPs.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

*/ @property (nonatomic, strong) NSArray * _Nullable callbackURLs; /**

The ID of the client associated with the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable clientId; /**

The client name from the user pool request of the client type.

*/ @property (nonatomic, strong) NSString * _Nullable clientName; /**

The client secret from the user pool request of the client type.

*/ @property (nonatomic, strong) NSString * _Nullable clientSecret; /**

The date the user pool client was created.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

*/ @property (nonatomic, strong) NSString * _Nullable defaultRedirectURI; /**

When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.

When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.

You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.

*/ @property (nonatomic, strong) NSNumber * _Nullable enablePropagateAdditionalUserContextData; /**

Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.

*/ @property (nonatomic, strong) NSNumber * _Nullable enableTokenRevocation; /**

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.

*/ @property (nonatomic, strong) NSArray * _Nullable explicitAuthFlows; /**

The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

*/ @property (nonatomic, strong) NSNumber * _Nullable idTokenValidity; /**

The date the user pool client was last modified.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate; /**

A list of allowed logout URLs for the IdPs.

*/ @property (nonatomic, strong) NSArray * _Nullable logoutURLs; /**

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.

Valid values include:

  • ENABLED - This prevents user existence-related errors.

  • LEGACY - This represents the old behavior of Amazon Cognito where user existence related errors aren't prevented.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderPreventUserExistenceErrorTypes preventUserExistenceErrors; /**

The Read-only attributes.

*/ @property (nonatomic, strong) NSArray * _Nullable readAttributes; /**

The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

*/ @property (nonatomic, strong) NSNumber * _Nullable refreshTokenValidity; /**

A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and the names of your own SAML and OIDC providers.

*/ @property (nonatomic, strong) NSArray * _Nullable supportedIdentityProviders; /**

The time units used to specify the token validity times of each token type: ID, access, and refresh.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderTokenValidityUnitsType * _Nullable tokenValidityUnits; /**

The user pool ID for the user pool client.

*/ @property (nonatomic, strong) NSString * _Nullable userPoolId; /**

The writeable attributes.

*/ @property (nonatomic, strong) NSArray * _Nullable writeAttributes; @end /**

A user pool description.

*/ @interface AWSCognitoIdentityProviderUserPoolDescriptionType : AWSModel /**

The date the user pool description was created.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

The ID in a user pool description.

*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**

The Lambda configuration information in a user pool description.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType * _Nullable lambdaConfig; /**

The date the user pool description was last modified.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate; /**

The name in a user pool description.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The user pool status in a user pool description.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderStatusType status; @end /**

The policy associated with a user pool.

*/ @interface AWSCognitoIdentityProviderUserPoolPolicyType : AWSModel /**

The password policy.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderPasswordPolicyType * _Nullable passwordPolicy; @end /**

A container for information about the user pool.

*/ @interface AWSCognitoIdentityProviderUserPoolType : AWSModel /**

The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAccountRecoverySettingType * _Nullable accountRecoverySetting; /**

The configuration for AdminCreateUser requests.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderAdminCreateUserConfigType * _Nullable adminCreateUserConfig; /**

The attributes that are aliased in a user pool.

*/ @property (nonatomic, strong) NSArray * _Nullable aliasAttributes; /**

The Amazon Resource Name (ARN) for the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable arn; /**

The attributes that are auto-verified in a user pool.

*/ @property (nonatomic, strong) NSArray * _Nullable autoVerifiedAttributes; /**

The date the user pool was created.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

*/ @property (nonatomic, strong) NSString * _Nullable customDomain; /**

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderDeletionProtectionType deletionProtection; /**

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

 */ @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceConfigurationType * _Nullable deviceConfiguration; /**

The domain prefix, if the user pool has a domain associated with it.

*/ @property (nonatomic, strong) NSString * _Nullable domain; /**

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user pool.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderEmailConfigurationType * _Nullable emailConfiguration; /**

Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.

*/ @property (nonatomic, strong) NSString * _Nullable emailConfigurationFailure; /**

This parameter is no longer used. See VerificationMessageTemplateType.

*/ @property (nonatomic, strong) NSString * _Nullable emailVerificationMessage; /**

This parameter is no longer used. See VerificationMessageTemplateType.

*/ @property (nonatomic, strong) NSString * _Nullable emailVerificationSubject; /**

A number estimating the size of the user pool.

*/ @property (nonatomic, strong) NSNumber * _Nullable estimatedNumberOfUsers; /**

The ID of the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**

The Lambda triggers associated with the user pool.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType * _Nullable lambdaConfig; /**

The date the user pool was last modified.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate; /**

Can be one of the following values:

  • OFF - MFA tokens aren't required and can't be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool.

  • OPTIONAL - Users have the option when registering to create an MFA token.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration; /**

The name of the user pool.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The policies associated with the user pool.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolPolicyType * _Nullable policies; /**

A container with the schema attributes of a user pool.

*/ @property (nonatomic, strong) NSArray * _Nullable schemaAttributes; /**

The contents of the SMS authentication message.

*/ @property (nonatomic, strong) NSString * _Nullable smsAuthenticationMessage; /**

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType * _Nullable smsConfiguration; /**

The reason why the SMS configuration can't send the messages to your users.

This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.

InvalidSmsRoleAccessPolicyException

The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.

SNSSandbox

The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

*/ @property (nonatomic, strong) NSString * _Nullable smsConfigurationFailure; /**

This parameter is no longer used. See VerificationMessageTemplateType.

*/ @property (nonatomic, strong) NSString * _Nullable smsVerificationMessage; /**

The status of a user pool.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderStatusType status; /**

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserAttributeUpdateSettingsType * _Nullable userAttributeUpdateSettings; /**

The user pool add-ons.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolAddOnsType * _Nullable userPoolAddOns; /**

The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

*/ @property (nonatomic, strong) NSDictionary * _Nullable userPoolTags; /**

Specifies whether a user can use an email address or phone number as a username when they sign up.

*/ @property (nonatomic, strong) NSArray * _Nullable usernameAttributes; /**

Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderUsernameConfigurationType * _Nullable usernameConfiguration; /**

The template for verification messages.

*/ @property (nonatomic, strong) AWSCognitoIdentityProviderVerificationMessageTemplateType * _Nullable verificationMessageTemplate; @end /**

A user profile in a Amazon Cognito user pool.

*/ @interface AWSCognitoIdentityProviderUserType : AWSModel /**

A container with information about the user type attributes.

*/ @property (nonatomic, strong) NSArray * _Nullable attributes; /**

Specifies whether the user is enabled.

*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**

The MFA options for the user.

*/ @property (nonatomic, strong) NSArray * _Nullable MFAOptions; /**

The creation date of the user.

*/ @property (nonatomic, strong) NSDate * _Nullable userCreateDate; /**

The last modified date of the user.

*/ @property (nonatomic, strong) NSDate * _Nullable userLastModifiedDate; /**

The user status. This can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • EXTERNAL_PROVIDER - User signed in with a third-party IdP.

  • ARCHIVED - User is no longer active.

  • UNKNOWN - User status isn't known.

  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

  • FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderUserStatusType userStatus; /**

The user name of the user you want to describe.

*/ @property (nonatomic, strong) NSString * _Nullable username; @end /**

The username configuration type.

Required parameters: [CaseSensitive] */ @interface AWSCognitoIdentityProviderUsernameConfigurationType : AWSModel /**

Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.

Valid values include:

True

Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.

False

Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using either "username" or "Username". This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

*/ @property (nonatomic, strong) NSNumber * _Nullable caseSensitive; @end /**

The template for verification messages.

*/ @interface AWSCognitoIdentityProviderVerificationMessageTemplateType : AWSModel /**

The default email option.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderDefaultEmailOptionType defaultEmailOption; /**

The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

*/ @property (nonatomic, strong) NSString * _Nullable emailMessage; /**

The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

*/ @property (nonatomic, strong) NSString * _Nullable emailMessageByLink; /**

The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

*/ @property (nonatomic, strong) NSString * _Nullable emailSubject; /**

The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

*/ @property (nonatomic, strong) NSString * _Nullable emailSubjectByLink; /**

The template for SMS messages that Amazon Cognito sends to your users.

*/ @property (nonatomic, strong) NSString * _Nullable smsMessage; @end /** */ @interface AWSCognitoIdentityProviderVerifySoftwareTokenRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The friendly device name.

*/ @property (nonatomic, strong) NSString * _Nullable friendlyDeviceName; /**

The session that should be passed both ways in challenge-response calls to the service.

*/ @property (nonatomic, strong) NSString * _Nullable session; /**

The one- time password computed using the secret code returned by AssociateSoftwareToken.

*/ @property (nonatomic, strong) NSString * _Nullable userCode; @end /** */ @interface AWSCognitoIdentityProviderVerifySoftwareTokenResponse : AWSModel /**

The session that should be passed both ways in challenge-response calls to the service.

*/ @property (nonatomic, strong) NSString * _Nullable session; /**

The status of the verify software token.

*/ @property (nonatomic, assign) AWSCognitoIdentityProviderVerifySoftwareTokenResponseType status; @end /**

Represents the request to verify user attributes.

Required parameters: [AccessToken, AttributeName, Code] */ @interface AWSCognitoIdentityProviderVerifyUserAttributeRequest : AWSRequest /**

A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.

*/ @property (nonatomic, strong) NSString * _Nullable accessToken; /**

The attribute name in the request to verify user attributes.

*/ @property (nonatomic, strong) NSString * _Nullable attributeName; /**

The verification code in the request to verify user attributes.

*/ @property (nonatomic, strong) NSString * _Nullable code; @end /**

A container representing the response from the server from the request to verify user attributes.

*/ @interface AWSCognitoIdentityProviderVerifyUserAttributeResponse : AWSModel @end NS_ASSUME_NONNULL_END