Nenhuma descrição

AWSCognitoIdentityProviderModel.h 198KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046
  1. //
  2. // Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  3. //
  4. // Licensed under the Apache License, Version 2.0 (the "License").
  5. // You may not use this file except in compliance with the License.
  6. // A copy of the License is located at
  7. //
  8. // http://aws.amazon.com/apache2.0
  9. //
  10. // or in the "license" file accompanying this file. This file is distributed
  11. // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  12. // express or implied. See the License for the specific language governing
  13. // permissions and limitations under the License.
  14. //
  15. #import <Foundation/Foundation.h>
  16. #import <AWSCore/AWSNetworking.h>
  17. #import <AWSCore/AWSModel.h>
  18. NS_ASSUME_NONNULL_BEGIN
  19. FOUNDATION_EXPORT NSString *const AWSCognitoIdentityProviderErrorDomain;
  20. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderErrorType) {
  21. AWSCognitoIdentityProviderErrorUnknown,
  22. AWSCognitoIdentityProviderErrorAliasExists,
  23. AWSCognitoIdentityProviderErrorCodeDeliveryFailure,
  24. AWSCognitoIdentityProviderErrorCodeMismatch,
  25. AWSCognitoIdentityProviderErrorConcurrentModification,
  26. AWSCognitoIdentityProviderErrorDuplicateProvider,
  27. AWSCognitoIdentityProviderErrorEnableSoftwareTokenMFA,
  28. AWSCognitoIdentityProviderErrorExpiredCode,
  29. AWSCognitoIdentityProviderErrorGroupExists,
  30. AWSCognitoIdentityProviderErrorInternalError,
  31. AWSCognitoIdentityProviderErrorInvalidEmailRoleAccessPolicy,
  32. AWSCognitoIdentityProviderErrorInvalidLambdaResponse,
  33. AWSCognitoIdentityProviderErrorInvalidOAuthFlow,
  34. AWSCognitoIdentityProviderErrorInvalidParameter,
  35. AWSCognitoIdentityProviderErrorInvalidPassword,
  36. AWSCognitoIdentityProviderErrorInvalidSmsRoleAccessPolicy,
  37. AWSCognitoIdentityProviderErrorInvalidSmsRoleTrustRelationship,
  38. AWSCognitoIdentityProviderErrorInvalidUserPoolConfiguration,
  39. AWSCognitoIdentityProviderErrorLimitExceeded,
  40. AWSCognitoIdentityProviderErrorMFAMethodNotFound,
  41. AWSCognitoIdentityProviderErrorNotAuthorized,
  42. AWSCognitoIdentityProviderErrorPasswordResetRequired,
  43. AWSCognitoIdentityProviderErrorPreconditionNotMet,
  44. AWSCognitoIdentityProviderErrorResourceNotFound,
  45. AWSCognitoIdentityProviderErrorScopeDoesNotExist,
  46. AWSCognitoIdentityProviderErrorSoftwareTokenMFANotFound,
  47. AWSCognitoIdentityProviderErrorTooManyFailedAttempts,
  48. AWSCognitoIdentityProviderErrorTooManyRequests,
  49. AWSCognitoIdentityProviderErrorUnexpectedLambda,
  50. AWSCognitoIdentityProviderErrorUnsupportedIdentityProvider,
  51. AWSCognitoIdentityProviderErrorUnsupportedUserState,
  52. AWSCognitoIdentityProviderErrorUserImportInProgress,
  53. AWSCognitoIdentityProviderErrorUserLambdaValidation,
  54. AWSCognitoIdentityProviderErrorUserNotConfirmed,
  55. AWSCognitoIdentityProviderErrorUserNotFound,
  56. AWSCognitoIdentityProviderErrorUserPoolAddOnNotEnabled,
  57. AWSCognitoIdentityProviderErrorUserPoolTagging,
  58. AWSCognitoIdentityProviderErrorUsernameExists,
  59. };
  60. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderAccountTakeoverEventActionType) {
  61. AWSCognitoIdentityProviderAccountTakeoverEventActionTypeUnknown,
  62. AWSCognitoIdentityProviderAccountTakeoverEventActionTypeBlock,
  63. AWSCognitoIdentityProviderAccountTakeoverEventActionTypeMfaIfConfigured,
  64. AWSCognitoIdentityProviderAccountTakeoverEventActionTypeMfaRequired,
  65. AWSCognitoIdentityProviderAccountTakeoverEventActionTypeNoAction,
  66. };
  67. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderAdvancedSecurityModeType) {
  68. AWSCognitoIdentityProviderAdvancedSecurityModeTypeUnknown,
  69. AWSCognitoIdentityProviderAdvancedSecurityModeTypeOff,
  70. AWSCognitoIdentityProviderAdvancedSecurityModeTypeAudit,
  71. AWSCognitoIdentityProviderAdvancedSecurityModeTypeEnforced,
  72. };
  73. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderAliasAttributeType) {
  74. AWSCognitoIdentityProviderAliasAttributeTypeUnknown,
  75. AWSCognitoIdentityProviderAliasAttributeTypePhoneNumber,
  76. AWSCognitoIdentityProviderAliasAttributeTypeEmail,
  77. AWSCognitoIdentityProviderAliasAttributeTypePreferredUsername,
  78. };
  79. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderAttributeDataType) {
  80. AWSCognitoIdentityProviderAttributeDataTypeUnknown,
  81. AWSCognitoIdentityProviderAttributeDataTypeString,
  82. AWSCognitoIdentityProviderAttributeDataTypeNumber,
  83. AWSCognitoIdentityProviderAttributeDataTypeDateTime,
  84. AWSCognitoIdentityProviderAttributeDataTypeBoolean,
  85. };
  86. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderAuthFlowType) {
  87. AWSCognitoIdentityProviderAuthFlowTypeUnknown,
  88. AWSCognitoIdentityProviderAuthFlowTypeUserSrpAuth,
  89. AWSCognitoIdentityProviderAuthFlowTypeRefreshTokenAuth,
  90. AWSCognitoIdentityProviderAuthFlowTypeRefreshToken,
  91. AWSCognitoIdentityProviderAuthFlowTypeCustomAuth,
  92. AWSCognitoIdentityProviderAuthFlowTypeAdminNoSrpAuth,
  93. AWSCognitoIdentityProviderAuthFlowTypeUserPasswordAuth,
  94. };
  95. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderChallengeName) {
  96. AWSCognitoIdentityProviderChallengeNameUnknown,
  97. AWSCognitoIdentityProviderChallengeNamePassword,
  98. AWSCognitoIdentityProviderChallengeNameMfa,
  99. };
  100. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderChallengeNameType) {
  101. AWSCognitoIdentityProviderChallengeNameTypeUnknown,
  102. AWSCognitoIdentityProviderChallengeNameTypeSmsMfa,
  103. AWSCognitoIdentityProviderChallengeNameTypeSoftwareTokenMfa,
  104. AWSCognitoIdentityProviderChallengeNameTypeSelectMfaType,
  105. AWSCognitoIdentityProviderChallengeNameTypeMfaSetup,
  106. AWSCognitoIdentityProviderChallengeNameTypePasswordVerifier,
  107. AWSCognitoIdentityProviderChallengeNameTypeCustomChallenge,
  108. AWSCognitoIdentityProviderChallengeNameTypeDeviceSrpAuth,
  109. AWSCognitoIdentityProviderChallengeNameTypeDevicePasswordVerifier,
  110. AWSCognitoIdentityProviderChallengeNameTypeAdminNoSrpAuth,
  111. AWSCognitoIdentityProviderChallengeNameTypeNewPasswordRequired,
  112. };
  113. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderChallengeResponse) {
  114. AWSCognitoIdentityProviderChallengeResponseUnknown,
  115. AWSCognitoIdentityProviderChallengeResponseSuccess,
  116. AWSCognitoIdentityProviderChallengeResponseFailure,
  117. };
  118. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderCompromisedCredentialsEventActionType) {
  119. AWSCognitoIdentityProviderCompromisedCredentialsEventActionTypeUnknown,
  120. AWSCognitoIdentityProviderCompromisedCredentialsEventActionTypeBlock,
  121. AWSCognitoIdentityProviderCompromisedCredentialsEventActionTypeNoAction,
  122. };
  123. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderDefaultEmailOptionType) {
  124. AWSCognitoIdentityProviderDefaultEmailOptionTypeUnknown,
  125. AWSCognitoIdentityProviderDefaultEmailOptionTypeConfirmWithLink,
  126. AWSCognitoIdentityProviderDefaultEmailOptionTypeConfirmWithCode,
  127. };
  128. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderDeliveryMediumType) {
  129. AWSCognitoIdentityProviderDeliveryMediumTypeUnknown,
  130. AWSCognitoIdentityProviderDeliveryMediumTypeSms,
  131. AWSCognitoIdentityProviderDeliveryMediumTypeEmail,
  132. };
  133. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderDeviceRememberedStatusType) {
  134. AWSCognitoIdentityProviderDeviceRememberedStatusTypeUnknown,
  135. AWSCognitoIdentityProviderDeviceRememberedStatusTypeRemembered,
  136. AWSCognitoIdentityProviderDeviceRememberedStatusTypeNotRemembered,
  137. };
  138. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderDomainStatusType) {
  139. AWSCognitoIdentityProviderDomainStatusTypeUnknown,
  140. AWSCognitoIdentityProviderDomainStatusTypeCreating,
  141. AWSCognitoIdentityProviderDomainStatusTypeDeleting,
  142. AWSCognitoIdentityProviderDomainStatusTypeUpdating,
  143. AWSCognitoIdentityProviderDomainStatusTypeActive,
  144. AWSCognitoIdentityProviderDomainStatusTypeFailed,
  145. };
  146. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderEventFilterType) {
  147. AWSCognitoIdentityProviderEventFilterTypeUnknown,
  148. AWSCognitoIdentityProviderEventFilterTypeSignIn,
  149. AWSCognitoIdentityProviderEventFilterTypePasswordChange,
  150. AWSCognitoIdentityProviderEventFilterTypeSignUp,
  151. };
  152. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderEventResponseType) {
  153. AWSCognitoIdentityProviderEventResponseTypeUnknown,
  154. AWSCognitoIdentityProviderEventResponseTypeSuccess,
  155. AWSCognitoIdentityProviderEventResponseTypeFailure,
  156. };
  157. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderEventType) {
  158. AWSCognitoIdentityProviderEventTypeUnknown,
  159. AWSCognitoIdentityProviderEventTypeSignIn,
  160. AWSCognitoIdentityProviderEventTypeSignUp,
  161. AWSCognitoIdentityProviderEventTypeForgotPassword,
  162. };
  163. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderExplicitAuthFlowsType) {
  164. AWSCognitoIdentityProviderExplicitAuthFlowsTypeUnknown,
  165. AWSCognitoIdentityProviderExplicitAuthFlowsTypeAdminNoSrpAuth,
  166. AWSCognitoIdentityProviderExplicitAuthFlowsTypeCustomAuthFlowOnly,
  167. AWSCognitoIdentityProviderExplicitAuthFlowsTypeUserPasswordAuth,
  168. };
  169. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderFeedbackValueType) {
  170. AWSCognitoIdentityProviderFeedbackValueTypeUnknown,
  171. AWSCognitoIdentityProviderFeedbackValueTypeValid,
  172. AWSCognitoIdentityProviderFeedbackValueTypeInvalid,
  173. };
  174. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderIdentityProviderTypeType) {
  175. AWSCognitoIdentityProviderIdentityProviderTypeTypeUnknown,
  176. AWSCognitoIdentityProviderIdentityProviderTypeTypeSaml,
  177. AWSCognitoIdentityProviderIdentityProviderTypeTypeFacebook,
  178. AWSCognitoIdentityProviderIdentityProviderTypeTypeGoogle,
  179. AWSCognitoIdentityProviderIdentityProviderTypeTypeLoginWithAmazon,
  180. AWSCognitoIdentityProviderIdentityProviderTypeTypeOidc,
  181. };
  182. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderMessageActionType) {
  183. AWSCognitoIdentityProviderMessageActionTypeUnknown,
  184. AWSCognitoIdentityProviderMessageActionTypeResend,
  185. AWSCognitoIdentityProviderMessageActionTypeSuppress,
  186. };
  187. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderOAuthFlowType) {
  188. AWSCognitoIdentityProviderOAuthFlowTypeUnknown,
  189. AWSCognitoIdentityProviderOAuthFlowTypeCode,
  190. AWSCognitoIdentityProviderOAuthFlowTypeImplicit,
  191. AWSCognitoIdentityProviderOAuthFlowTypeClientCredentials,
  192. };
  193. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderRiskDecisionType) {
  194. AWSCognitoIdentityProviderRiskDecisionTypeUnknown,
  195. AWSCognitoIdentityProviderRiskDecisionTypeNoRisk,
  196. AWSCognitoIdentityProviderRiskDecisionTypeAccountTakeover,
  197. AWSCognitoIdentityProviderRiskDecisionTypeBlock,
  198. };
  199. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderRiskLevelType) {
  200. AWSCognitoIdentityProviderRiskLevelTypeUnknown,
  201. AWSCognitoIdentityProviderRiskLevelTypeLow,
  202. AWSCognitoIdentityProviderRiskLevelTypeMedium,
  203. AWSCognitoIdentityProviderRiskLevelTypeHigh,
  204. };
  205. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderStatusType) {
  206. AWSCognitoIdentityProviderStatusTypeUnknown,
  207. AWSCognitoIdentityProviderStatusTypeEnabled,
  208. AWSCognitoIdentityProviderStatusTypeDisabled,
  209. };
  210. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderUserImportJobStatusType) {
  211. AWSCognitoIdentityProviderUserImportJobStatusTypeUnknown,
  212. AWSCognitoIdentityProviderUserImportJobStatusTypeCreated,
  213. AWSCognitoIdentityProviderUserImportJobStatusTypePending,
  214. AWSCognitoIdentityProviderUserImportJobStatusTypeInProgress,
  215. AWSCognitoIdentityProviderUserImportJobStatusTypeStopping,
  216. AWSCognitoIdentityProviderUserImportJobStatusTypeExpired,
  217. AWSCognitoIdentityProviderUserImportJobStatusTypeStopped,
  218. AWSCognitoIdentityProviderUserImportJobStatusTypeFailed,
  219. AWSCognitoIdentityProviderUserImportJobStatusTypeSucceeded,
  220. };
  221. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderUserPoolMfaType) {
  222. AWSCognitoIdentityProviderUserPoolMfaTypeUnknown,
  223. AWSCognitoIdentityProviderUserPoolMfaTypeOff,
  224. AWSCognitoIdentityProviderUserPoolMfaTypeOn,
  225. AWSCognitoIdentityProviderUserPoolMfaTypeOptional,
  226. };
  227. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderUserStatusType) {
  228. AWSCognitoIdentityProviderUserStatusTypeUnknown,
  229. AWSCognitoIdentityProviderUserStatusTypeUnconfirmed,
  230. AWSCognitoIdentityProviderUserStatusTypeConfirmed,
  231. AWSCognitoIdentityProviderUserStatusTypeArchived,
  232. AWSCognitoIdentityProviderUserStatusTypeCompromised,
  233. AWSCognitoIdentityProviderUserStatusTypeResetRequired,
  234. AWSCognitoIdentityProviderUserStatusTypeForceChangePassword,
  235. };
  236. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderUsernameAttributeType) {
  237. AWSCognitoIdentityProviderUsernameAttributeTypeUnknown,
  238. AWSCognitoIdentityProviderUsernameAttributeTypePhoneNumber,
  239. AWSCognitoIdentityProviderUsernameAttributeTypeEmail,
  240. };
  241. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderVerifiedAttributeType) {
  242. AWSCognitoIdentityProviderVerifiedAttributeTypeUnknown,
  243. AWSCognitoIdentityProviderVerifiedAttributeTypePhoneNumber,
  244. AWSCognitoIdentityProviderVerifiedAttributeTypeEmail,
  245. };
  246. typedef NS_ENUM(NSInteger, AWSCognitoIdentityProviderVerifySoftwareTokenResponseType) {
  247. AWSCognitoIdentityProviderVerifySoftwareTokenResponseTypeUnknown,
  248. AWSCognitoIdentityProviderVerifySoftwareTokenResponseTypeSuccess,
  249. AWSCognitoIdentityProviderVerifySoftwareTokenResponseTypeError,
  250. };
  251. @class AWSCognitoIdentityProviderAccountTakeoverActionType;
  252. @class AWSCognitoIdentityProviderAccountTakeoverActionsType;
  253. @class AWSCognitoIdentityProviderAccountTakeoverRiskConfigurationType;
  254. @class AWSCognitoIdentityProviderAddCustomAttributesRequest;
  255. @class AWSCognitoIdentityProviderAddCustomAttributesResponse;
  256. @class AWSCognitoIdentityProviderAdminAddUserToGroupRequest;
  257. @class AWSCognitoIdentityProviderAdminConfirmSignUpRequest;
  258. @class AWSCognitoIdentityProviderAdminConfirmSignUpResponse;
  259. @class AWSCognitoIdentityProviderAdminCreateUserConfigType;
  260. @class AWSCognitoIdentityProviderAdminCreateUserRequest;
  261. @class AWSCognitoIdentityProviderAdminCreateUserResponse;
  262. @class AWSCognitoIdentityProviderAdminDeleteUserAttributesRequest;
  263. @class AWSCognitoIdentityProviderAdminDeleteUserAttributesResponse;
  264. @class AWSCognitoIdentityProviderAdminDeleteUserRequest;
  265. @class AWSCognitoIdentityProviderAdminDisableProviderForUserRequest;
  266. @class AWSCognitoIdentityProviderAdminDisableProviderForUserResponse;
  267. @class AWSCognitoIdentityProviderAdminDisableUserRequest;
  268. @class AWSCognitoIdentityProviderAdminDisableUserResponse;
  269. @class AWSCognitoIdentityProviderAdminEnableUserRequest;
  270. @class AWSCognitoIdentityProviderAdminEnableUserResponse;
  271. @class AWSCognitoIdentityProviderAdminForgetDeviceRequest;
  272. @class AWSCognitoIdentityProviderAdminGetDeviceRequest;
  273. @class AWSCognitoIdentityProviderAdminGetDeviceResponse;
  274. @class AWSCognitoIdentityProviderAdminGetUserRequest;
  275. @class AWSCognitoIdentityProviderAdminGetUserResponse;
  276. @class AWSCognitoIdentityProviderAdminInitiateAuthRequest;
  277. @class AWSCognitoIdentityProviderAdminInitiateAuthResponse;
  278. @class AWSCognitoIdentityProviderAdminLinkProviderForUserRequest;
  279. @class AWSCognitoIdentityProviderAdminLinkProviderForUserResponse;
  280. @class AWSCognitoIdentityProviderAdminListDevicesRequest;
  281. @class AWSCognitoIdentityProviderAdminListDevicesResponse;
  282. @class AWSCognitoIdentityProviderAdminListGroupsForUserRequest;
  283. @class AWSCognitoIdentityProviderAdminListGroupsForUserResponse;
  284. @class AWSCognitoIdentityProviderAdminListUserAuthEventsRequest;
  285. @class AWSCognitoIdentityProviderAdminListUserAuthEventsResponse;
  286. @class AWSCognitoIdentityProviderAdminRemoveUserFromGroupRequest;
  287. @class AWSCognitoIdentityProviderAdminResetUserPasswordRequest;
  288. @class AWSCognitoIdentityProviderAdminResetUserPasswordResponse;
  289. @class AWSCognitoIdentityProviderAdminRespondToAuthChallengeRequest;
  290. @class AWSCognitoIdentityProviderAdminRespondToAuthChallengeResponse;
  291. @class AWSCognitoIdentityProviderAdminSetUserMFAPreferenceRequest;
  292. @class AWSCognitoIdentityProviderAdminSetUserMFAPreferenceResponse;
  293. @class AWSCognitoIdentityProviderAdminSetUserSettingsRequest;
  294. @class AWSCognitoIdentityProviderAdminSetUserSettingsResponse;
  295. @class AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackRequest;
  296. @class AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackResponse;
  297. @class AWSCognitoIdentityProviderAdminUpdateDeviceStatusRequest;
  298. @class AWSCognitoIdentityProviderAdminUpdateDeviceStatusResponse;
  299. @class AWSCognitoIdentityProviderAdminUpdateUserAttributesRequest;
  300. @class AWSCognitoIdentityProviderAdminUpdateUserAttributesResponse;
  301. @class AWSCognitoIdentityProviderAdminUserGlobalSignOutRequest;
  302. @class AWSCognitoIdentityProviderAdminUserGlobalSignOutResponse;
  303. @class AWSCognitoIdentityProviderAnalyticsConfigurationType;
  304. @class AWSCognitoIdentityProviderAnalyticsMetadataType;
  305. @class AWSCognitoIdentityProviderAssociateSoftwareTokenRequest;
  306. @class AWSCognitoIdentityProviderAssociateSoftwareTokenResponse;
  307. @class AWSCognitoIdentityProviderAttributeType;
  308. @class AWSCognitoIdentityProviderAuthEventType;
  309. @class AWSCognitoIdentityProviderAuthenticationResultType;
  310. @class AWSCognitoIdentityProviderChallengeResponseType;
  311. @class AWSCognitoIdentityProviderChangePasswordRequest;
  312. @class AWSCognitoIdentityProviderChangePasswordResponse;
  313. @class AWSCognitoIdentityProviderCodeDeliveryDetailsType;
  314. @class AWSCognitoIdentityProviderCompromisedCredentialsActionsType;
  315. @class AWSCognitoIdentityProviderCompromisedCredentialsRiskConfigurationType;
  316. @class AWSCognitoIdentityProviderConfirmDeviceRequest;
  317. @class AWSCognitoIdentityProviderConfirmDeviceResponse;
  318. @class AWSCognitoIdentityProviderConfirmForgotPasswordRequest;
  319. @class AWSCognitoIdentityProviderConfirmForgotPasswordResponse;
  320. @class AWSCognitoIdentityProviderConfirmSignUpRequest;
  321. @class AWSCognitoIdentityProviderConfirmSignUpResponse;
  322. @class AWSCognitoIdentityProviderContextDataType;
  323. @class AWSCognitoIdentityProviderCreateGroupRequest;
  324. @class AWSCognitoIdentityProviderCreateGroupResponse;
  325. @class AWSCognitoIdentityProviderCreateIdentityProviderRequest;
  326. @class AWSCognitoIdentityProviderCreateIdentityProviderResponse;
  327. @class AWSCognitoIdentityProviderCreateResourceServerRequest;
  328. @class AWSCognitoIdentityProviderCreateResourceServerResponse;
  329. @class AWSCognitoIdentityProviderCreateUserImportJobRequest;
  330. @class AWSCognitoIdentityProviderCreateUserImportJobResponse;
  331. @class AWSCognitoIdentityProviderCreateUserPoolClientRequest;
  332. @class AWSCognitoIdentityProviderCreateUserPoolClientResponse;
  333. @class AWSCognitoIdentityProviderCreateUserPoolDomainRequest;
  334. @class AWSCognitoIdentityProviderCreateUserPoolDomainResponse;
  335. @class AWSCognitoIdentityProviderCreateUserPoolRequest;
  336. @class AWSCognitoIdentityProviderCreateUserPoolResponse;
  337. @class AWSCognitoIdentityProviderCustomDomainConfigType;
  338. @class AWSCognitoIdentityProviderDeleteGroupRequest;
  339. @class AWSCognitoIdentityProviderDeleteIdentityProviderRequest;
  340. @class AWSCognitoIdentityProviderDeleteResourceServerRequest;
  341. @class AWSCognitoIdentityProviderDeleteUserAttributesRequest;
  342. @class AWSCognitoIdentityProviderDeleteUserAttributesResponse;
  343. @class AWSCognitoIdentityProviderDeleteUserPoolClientRequest;
  344. @class AWSCognitoIdentityProviderDeleteUserPoolDomainRequest;
  345. @class AWSCognitoIdentityProviderDeleteUserPoolDomainResponse;
  346. @class AWSCognitoIdentityProviderDeleteUserPoolRequest;
  347. @class AWSCognitoIdentityProviderDeleteUserRequest;
  348. @class AWSCognitoIdentityProviderDescribeIdentityProviderRequest;
  349. @class AWSCognitoIdentityProviderDescribeIdentityProviderResponse;
  350. @class AWSCognitoIdentityProviderDescribeResourceServerRequest;
  351. @class AWSCognitoIdentityProviderDescribeResourceServerResponse;
  352. @class AWSCognitoIdentityProviderDescribeRiskConfigurationRequest;
  353. @class AWSCognitoIdentityProviderDescribeRiskConfigurationResponse;
  354. @class AWSCognitoIdentityProviderDescribeUserImportJobRequest;
  355. @class AWSCognitoIdentityProviderDescribeUserImportJobResponse;
  356. @class AWSCognitoIdentityProviderDescribeUserPoolClientRequest;
  357. @class AWSCognitoIdentityProviderDescribeUserPoolClientResponse;
  358. @class AWSCognitoIdentityProviderDescribeUserPoolDomainRequest;
  359. @class AWSCognitoIdentityProviderDescribeUserPoolDomainResponse;
  360. @class AWSCognitoIdentityProviderDescribeUserPoolRequest;
  361. @class AWSCognitoIdentityProviderDescribeUserPoolResponse;
  362. @class AWSCognitoIdentityProviderDeviceConfigurationType;
  363. @class AWSCognitoIdentityProviderDeviceSecretVerifierConfigType;
  364. @class AWSCognitoIdentityProviderDeviceType;
  365. @class AWSCognitoIdentityProviderDomainDescriptionType;
  366. @class AWSCognitoIdentityProviderEmailConfigurationType;
  367. @class AWSCognitoIdentityProviderEventContextDataType;
  368. @class AWSCognitoIdentityProviderEventFeedbackType;
  369. @class AWSCognitoIdentityProviderEventRiskType;
  370. @class AWSCognitoIdentityProviderForgetDeviceRequest;
  371. @class AWSCognitoIdentityProviderForgotPasswordRequest;
  372. @class AWSCognitoIdentityProviderForgotPasswordResponse;
  373. @class AWSCognitoIdentityProviderGetCSVHeaderRequest;
  374. @class AWSCognitoIdentityProviderGetCSVHeaderResponse;
  375. @class AWSCognitoIdentityProviderGetDeviceRequest;
  376. @class AWSCognitoIdentityProviderGetDeviceResponse;
  377. @class AWSCognitoIdentityProviderGetGroupRequest;
  378. @class AWSCognitoIdentityProviderGetGroupResponse;
  379. @class AWSCognitoIdentityProviderGetIdentityProviderByIdentifierRequest;
  380. @class AWSCognitoIdentityProviderGetIdentityProviderByIdentifierResponse;
  381. @class AWSCognitoIdentityProviderGetSigningCertificateRequest;
  382. @class AWSCognitoIdentityProviderGetSigningCertificateResponse;
  383. @class AWSCognitoIdentityProviderGetUICustomizationRequest;
  384. @class AWSCognitoIdentityProviderGetUICustomizationResponse;
  385. @class AWSCognitoIdentityProviderGetUserAttributeVerificationCodeRequest;
  386. @class AWSCognitoIdentityProviderGetUserAttributeVerificationCodeResponse;
  387. @class AWSCognitoIdentityProviderGetUserPoolMfaConfigRequest;
  388. @class AWSCognitoIdentityProviderGetUserPoolMfaConfigResponse;
  389. @class AWSCognitoIdentityProviderGetUserRequest;
  390. @class AWSCognitoIdentityProviderGetUserResponse;
  391. @class AWSCognitoIdentityProviderGlobalSignOutRequest;
  392. @class AWSCognitoIdentityProviderGlobalSignOutResponse;
  393. @class AWSCognitoIdentityProviderGroupType;
  394. @class AWSCognitoIdentityProviderHttpHeader;
  395. @class AWSCognitoIdentityProviderIdentityProviderType;
  396. @class AWSCognitoIdentityProviderInitiateAuthRequest;
  397. @class AWSCognitoIdentityProviderInitiateAuthResponse;
  398. @class AWSCognitoIdentityProviderLambdaConfigType;
  399. @class AWSCognitoIdentityProviderListDevicesRequest;
  400. @class AWSCognitoIdentityProviderListDevicesResponse;
  401. @class AWSCognitoIdentityProviderListGroupsRequest;
  402. @class AWSCognitoIdentityProviderListGroupsResponse;
  403. @class AWSCognitoIdentityProviderListIdentityProvidersRequest;
  404. @class AWSCognitoIdentityProviderListIdentityProvidersResponse;
  405. @class AWSCognitoIdentityProviderListResourceServersRequest;
  406. @class AWSCognitoIdentityProviderListResourceServersResponse;
  407. @class AWSCognitoIdentityProviderListUserImportJobsRequest;
  408. @class AWSCognitoIdentityProviderListUserImportJobsResponse;
  409. @class AWSCognitoIdentityProviderListUserPoolClientsRequest;
  410. @class AWSCognitoIdentityProviderListUserPoolClientsResponse;
  411. @class AWSCognitoIdentityProviderListUserPoolsRequest;
  412. @class AWSCognitoIdentityProviderListUserPoolsResponse;
  413. @class AWSCognitoIdentityProviderListUsersInGroupRequest;
  414. @class AWSCognitoIdentityProviderListUsersInGroupResponse;
  415. @class AWSCognitoIdentityProviderListUsersRequest;
  416. @class AWSCognitoIdentityProviderListUsersResponse;
  417. @class AWSCognitoIdentityProviderMFAOptionType;
  418. @class AWSCognitoIdentityProviderMessageTemplateType;
  419. @class AWSCognitoIdentityProviderLatestDeviceMetadataType;
  420. @class AWSCognitoIdentityProviderNotifyConfigurationType;
  421. @class AWSCognitoIdentityProviderNotifyEmailType;
  422. @class AWSCognitoIdentityProviderNumberAttributeConstraintsType;
  423. @class AWSCognitoIdentityProviderPasswordPolicyType;
  424. @class AWSCognitoIdentityProviderProviderDescription;
  425. @class AWSCognitoIdentityProviderProviderUserIdentifierType;
  426. @class AWSCognitoIdentityProviderResendConfirmationCodeRequest;
  427. @class AWSCognitoIdentityProviderResendConfirmationCodeResponse;
  428. @class AWSCognitoIdentityProviderResourceServerScopeType;
  429. @class AWSCognitoIdentityProviderResourceServerType;
  430. @class AWSCognitoIdentityProviderRespondToAuthChallengeRequest;
  431. @class AWSCognitoIdentityProviderRespondToAuthChallengeResponse;
  432. @class AWSCognitoIdentityProviderRiskConfigurationType;
  433. @class AWSCognitoIdentityProviderRiskExceptionConfigurationType;
  434. @class AWSCognitoIdentityProviderSMSMfaSettingsType;
  435. @class AWSCognitoIdentityProviderSchemaAttributeType;
  436. @class AWSCognitoIdentityProviderSetRiskConfigurationRequest;
  437. @class AWSCognitoIdentityProviderSetRiskConfigurationResponse;
  438. @class AWSCognitoIdentityProviderSetUICustomizationRequest;
  439. @class AWSCognitoIdentityProviderSetUICustomizationResponse;
  440. @class AWSCognitoIdentityProviderSetUserMFAPreferenceRequest;
  441. @class AWSCognitoIdentityProviderSetUserMFAPreferenceResponse;
  442. @class AWSCognitoIdentityProviderSetUserPoolMfaConfigRequest;
  443. @class AWSCognitoIdentityProviderSetUserPoolMfaConfigResponse;
  444. @class AWSCognitoIdentityProviderSetUserSettingsRequest;
  445. @class AWSCognitoIdentityProviderSetUserSettingsResponse;
  446. @class AWSCognitoIdentityProviderSignUpRequest;
  447. @class AWSCognitoIdentityProviderSignUpResponse;
  448. @class AWSCognitoIdentityProviderSmsConfigurationType;
  449. @class AWSCognitoIdentityProviderSmsMfaConfigType;
  450. @class AWSCognitoIdentityProviderSoftwareTokenMfaConfigType;
  451. @class AWSCognitoIdentityProviderSoftwareTokenMfaSettingsType;
  452. @class AWSCognitoIdentityProviderStartUserImportJobRequest;
  453. @class AWSCognitoIdentityProviderStartUserImportJobResponse;
  454. @class AWSCognitoIdentityProviderStopUserImportJobRequest;
  455. @class AWSCognitoIdentityProviderStopUserImportJobResponse;
  456. @class AWSCognitoIdentityProviderStringAttributeConstraintsType;
  457. @class AWSCognitoIdentityProviderUICustomizationType;
  458. @class AWSCognitoIdentityProviderUpdateAuthEventFeedbackRequest;
  459. @class AWSCognitoIdentityProviderUpdateAuthEventFeedbackResponse;
  460. @class AWSCognitoIdentityProviderUpdateDeviceStatusRequest;
  461. @class AWSCognitoIdentityProviderUpdateDeviceStatusResponse;
  462. @class AWSCognitoIdentityProviderUpdateGroupRequest;
  463. @class AWSCognitoIdentityProviderUpdateGroupResponse;
  464. @class AWSCognitoIdentityProviderUpdateIdentityProviderRequest;
  465. @class AWSCognitoIdentityProviderUpdateIdentityProviderResponse;
  466. @class AWSCognitoIdentityProviderUpdateResourceServerRequest;
  467. @class AWSCognitoIdentityProviderUpdateResourceServerResponse;
  468. @class AWSCognitoIdentityProviderUpdateUserAttributesRequest;
  469. @class AWSCognitoIdentityProviderUpdateUserAttributesResponse;
  470. @class AWSCognitoIdentityProviderUpdateUserPoolClientRequest;
  471. @class AWSCognitoIdentityProviderUpdateUserPoolClientResponse;
  472. @class AWSCognitoIdentityProviderUpdateUserPoolRequest;
  473. @class AWSCognitoIdentityProviderUpdateUserPoolResponse;
  474. @class AWSCognitoIdentityProviderUserContextDataType;
  475. @class AWSCognitoIdentityProviderUserImportJobType;
  476. @class AWSCognitoIdentityProviderUserPoolAddOnsType;
  477. @class AWSCognitoIdentityProviderUserPoolClientDescription;
  478. @class AWSCognitoIdentityProviderUserPoolClientType;
  479. @class AWSCognitoIdentityProviderUserPoolDescriptionType;
  480. @class AWSCognitoIdentityProviderUserPoolPolicyType;
  481. @class AWSCognitoIdentityProviderUserPoolType;
  482. @class AWSCognitoIdentityProviderUserType;
  483. @class AWSCognitoIdentityProviderVerificationMessageTemplateType;
  484. @class AWSCognitoIdentityProviderVerifySoftwareTokenRequest;
  485. @class AWSCognitoIdentityProviderVerifySoftwareTokenResponse;
  486. @class AWSCognitoIdentityProviderVerifyUserAttributeRequest;
  487. @class AWSCognitoIdentityProviderVerifyUserAttributeResponse;
  488. /**
  489. <p>Account takeover action type.</p>
  490. Required parameters: [Notify, EventAction]
  491. */
  492. @interface AWSCognitoIdentityProviderAccountTakeoverActionType : AWSModel
  493. /**
  494. <p>The event action.</p><ul><li><p><code>BLOCK</code> Choosing this action will block the request.</p></li><li><p><code>MFA_IF_CONFIGURED</code> Throw MFA challenge if user has configured it, else allow the request.</p></li><li><p><code>MFA_REQUIRED</code> Throw MFA challenge if user has configured it, else block the request.</p></li><li><p><code>NO_ACTION</code> Allow the user sign-in.</p></li></ul>
  495. */
  496. @property (nonatomic, assign) AWSCognitoIdentityProviderAccountTakeoverEventActionType eventAction;
  497. /**
  498. <p>Flag specifying whether to send a notification.</p>
  499. */
  500. @property (nonatomic, strong) NSNumber * _Nullable notify;
  501. @end
  502. /**
  503. <p>Account takeover actions type.</p>
  504. */
  505. @interface AWSCognitoIdentityProviderAccountTakeoverActionsType : AWSModel
  506. /**
  507. <p>Action to take for a high risk.</p>
  508. */
  509. @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverActionType * _Nullable highAction;
  510. /**
  511. <p>Action to take for a low risk.</p>
  512. */
  513. @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverActionType * _Nullable lowAction;
  514. /**
  515. <p>Action to take for a medium risk.</p>
  516. */
  517. @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverActionType * _Nullable mediumAction;
  518. @end
  519. /**
  520. <p>Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.</p>
  521. Required parameters: [Actions]
  522. */
  523. @interface AWSCognitoIdentityProviderAccountTakeoverRiskConfigurationType : AWSModel
  524. /**
  525. <p>Account takeover risk configuration actions</p>
  526. */
  527. @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverActionsType * _Nullable actions;
  528. /**
  529. <p>The notify configuration used to construct email notifications.</p>
  530. */
  531. @property (nonatomic, strong) AWSCognitoIdentityProviderNotifyConfigurationType * _Nullable notifyConfiguration;
  532. @end
  533. /**
  534. <p>Represents the request to add custom attributes.</p>
  535. Required parameters: [UserPoolId, CustomAttributes]
  536. */
  537. @interface AWSCognitoIdentityProviderAddCustomAttributesRequest : AWSRequest
  538. /**
  539. <p>An array of custom attributes, such as Mutable and Name.</p>
  540. */
  541. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderSchemaAttributeType *> * _Nullable customAttributes;
  542. /**
  543. <p>The user pool ID for the user pool where you want to add custom attributes.</p>
  544. */
  545. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  546. @end
  547. /**
  548. <p>Represents the response from the server for the request to add custom attributes.</p>
  549. */
  550. @interface AWSCognitoIdentityProviderAddCustomAttributesResponse : AWSModel
  551. @end
  552. /**
  553. */
  554. @interface AWSCognitoIdentityProviderAdminAddUserToGroupRequest : AWSRequest
  555. /**
  556. <p>The group name.</p>
  557. */
  558. @property (nonatomic, strong) NSString * _Nullable groupName;
  559. /**
  560. <p>The user pool ID for the user pool.</p>
  561. */
  562. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  563. /**
  564. <p>The username for the user.</p>
  565. */
  566. @property (nonatomic, strong) NSString * _Nullable username;
  567. @end
  568. /**
  569. <p>Represents the request to confirm user registration.</p>
  570. Required parameters: [UserPoolId, Username]
  571. */
  572. @interface AWSCognitoIdentityProviderAdminConfirmSignUpRequest : AWSRequest
  573. /**
  574. <p>The user pool ID for which you want to confirm user registration.</p>
  575. */
  576. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  577. /**
  578. <p>The user name for which you want to confirm user registration.</p>
  579. */
  580. @property (nonatomic, strong) NSString * _Nullable username;
  581. @end
  582. /**
  583. <p>Represents the response from the server for the request to confirm registration.</p>
  584. */
  585. @interface AWSCognitoIdentityProviderAdminConfirmSignUpResponse : AWSModel
  586. @end
  587. /**
  588. <p>The configuration for creating a new user profile.</p>
  589. */
  590. @interface AWSCognitoIdentityProviderAdminCreateUserConfigType : AWSModel
  591. /**
  592. <p>Set to <code>True</code> if only the administrator is allowed to create user profiles. Set to <code>False</code> if users can sign themselves up via an app.</p>
  593. */
  594. @property (nonatomic, strong) NSNumber * _Nullable allowAdminCreateUserOnly;
  595. /**
  596. <p>The message template to be used for the welcome message to new users.</p><p>See also <a href="http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization">Customizing User Invitation Messages</a>.</p>
  597. */
  598. @property (nonatomic, strong) AWSCognitoIdentityProviderMessageTemplateType * _Nullable inviteMessageTemplate;
  599. /**
  600. <p>The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call <code>AdminCreateUser</code> again, specifying <code>"RESEND"</code> for the <code>MessageAction</code> parameter. The default value for this parameter is 7.</p>
  601. */
  602. @property (nonatomic, strong) NSNumber * _Nullable unusedAccountValidityDays;
  603. @end
  604. /**
  605. <p>Represents the request to create a user in the specified user pool.</p>
  606. Required parameters: [UserPoolId, Username]
  607. */
  608. @interface AWSCognitoIdentityProviderAdminCreateUserRequest : AWSRequest
  609. /**
  610. <p>Specify <code>"EMAIL"</code> if email will be used to send the welcome message. Specify <code>"SMS"</code> if the phone number will be used. The default value is <code>"SMS"</code>. More than one value can be specified.</p>
  611. */
  612. @property (nonatomic, strong) NSArray<NSString *> * _Nullable desiredDeliveryMediums;
  613. /**
  614. <p>This parameter is only used if the <code>phone_number_verified</code> or <code>email_verified</code> attribute is set to <code>True</code>. Otherwise, it is ignored.</p><p>If this parameter is set to <code>True</code> 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.</p><p>If this parameter is set to <code>False</code>, the API throws an <code>AliasExistsException</code> error if the alias already exists. The default value is <code>False</code>.</p>
  615. */
  616. @property (nonatomic, strong) NSNumber * _Nullable forceAliasCreation;
  617. /**
  618. <p>Set to <code>"RESEND"</code> to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to <code>"SUPPRESS"</code> to suppress sending the message. Only one value can be specified.</p>
  619. */
  620. @property (nonatomic, assign) AWSCognitoIdentityProviderMessageActionType messageAction;
  621. /**
  622. <p>The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.</p><p>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.</p><p>This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.</p><p>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 <code>AdminCreateUser</code> again, specifying <code>"RESEND"</code> for the <code>MessageAction</code> parameter.</p>
  623. */
  624. @property (nonatomic, strong) NSString * _Nullable temporaryPassword;
  625. /**
  626. <p>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 <code>Username</code>. However, any attributes that you specify as required (in or in the <b>Attributes</b> tab of the console) must be supplied either by you (in your call to <code>AdminCreateUser</code>) or by the user (when he or she signs up in response to your welcome message).</p><p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p><p>To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the <b>Users</b> tab of the Amazon Cognito console for managing your user pools.</p><p>In your call to <code>AdminCreateUser</code>, you can set the <code>email_verified</code> attribute to <code>True</code>, and you can set the <code>phone_number_verified</code> attribute to <code>True</code>. (You can also do this by calling .)</p><ul><li><p><b>email</b>: The email address of the user to whom the message that contains the code and username will be sent. Required if the <code>email_verified</code> attribute is set to <code>True</code>, or if <code>"EMAIL"</code> is specified in the <code>DesiredDeliveryMediums</code> parameter.</p></li><li><p><b>phone_number</b>: The phone number of the user to whom the message that contains the code and username will be sent. Required if the <code>phone_number_verified</code> attribute is set to <code>True</code>, or if <code>"SMS"</code> is specified in the <code>DesiredDeliveryMediums</code> parameter.</p></li></ul>
  627. */
  628. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType *> * _Nullable userAttributes;
  629. /**
  630. <p>The user pool ID for the user pool where the user will be created.</p>
  631. */
  632. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  633. /**
  634. <p>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 cannot be changed.</p>
  635. */
  636. @property (nonatomic, strong) NSString * _Nullable username;
  637. /**
  638. <p>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.</p><p>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.</p><p>The user's validation data is not persisted.</p>
  639. */
  640. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType *> * _Nullable validationData;
  641. @end
  642. /**
  643. <p>Represents the response from the server to the request to create the user.</p>
  644. */
  645. @interface AWSCognitoIdentityProviderAdminCreateUserResponse : AWSModel
  646. /**
  647. <p>The newly created user.</p>
  648. */
  649. @property (nonatomic, strong) AWSCognitoIdentityProviderUserType * _Nullable user;
  650. @end
  651. /**
  652. <p>Represents the request to delete user attributes as an administrator.</p>
  653. Required parameters: [UserPoolId, Username, UserAttributeNames]
  654. */
  655. @interface AWSCognitoIdentityProviderAdminDeleteUserAttributesRequest : AWSRequest
  656. /**
  657. <p>An array of strings representing the user attribute names you wish to delete.</p><p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
  658. */
  659. @property (nonatomic, strong) NSArray<NSString *> * _Nullable userAttributeNames;
  660. /**
  661. <p>The user pool ID for the user pool where you want to delete user attributes.</p>
  662. */
  663. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  664. /**
  665. <p>The user name of the user from which you would like to delete attributes.</p>
  666. */
  667. @property (nonatomic, strong) NSString * _Nullable username;
  668. @end
  669. /**
  670. <p>Represents the response received from the server for a request to delete user attributes.</p>
  671. */
  672. @interface AWSCognitoIdentityProviderAdminDeleteUserAttributesResponse : AWSModel
  673. @end
  674. /**
  675. <p>Represents the request to delete a user as an administrator.</p>
  676. Required parameters: [UserPoolId, Username]
  677. */
  678. @interface AWSCognitoIdentityProviderAdminDeleteUserRequest : AWSRequest
  679. /**
  680. <p>The user pool ID for the user pool where you want to delete the user.</p>
  681. */
  682. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  683. /**
  684. <p>The user name of the user you wish to delete.</p>
  685. */
  686. @property (nonatomic, strong) NSString * _Nullable username;
  687. @end
  688. /**
  689. */
  690. @interface AWSCognitoIdentityProviderAdminDisableProviderForUserRequest : AWSRequest
  691. /**
  692. <p>The user to be disabled.</p>
  693. */
  694. @property (nonatomic, strong) AWSCognitoIdentityProviderProviderUserIdentifierType * _Nullable user;
  695. /**
  696. <p>The user pool ID for the user pool.</p>
  697. */
  698. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  699. @end
  700. /**
  701. */
  702. @interface AWSCognitoIdentityProviderAdminDisableProviderForUserResponse : AWSModel
  703. @end
  704. /**
  705. <p>Represents the request to disable any user as an administrator.</p>
  706. Required parameters: [UserPoolId, Username]
  707. */
  708. @interface AWSCognitoIdentityProviderAdminDisableUserRequest : AWSRequest
  709. /**
  710. <p>The user pool ID for the user pool where you want to disable the user.</p>
  711. */
  712. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  713. /**
  714. <p>The user name of the user you wish to disable.</p>
  715. */
  716. @property (nonatomic, strong) NSString * _Nullable username;
  717. @end
  718. /**
  719. <p>Represents the response received from the server to disable the user as an administrator.</p>
  720. */
  721. @interface AWSCognitoIdentityProviderAdminDisableUserResponse : AWSModel
  722. @end
  723. /**
  724. <p>Represents the request that enables the user as an administrator.</p>
  725. Required parameters: [UserPoolId, Username]
  726. */
  727. @interface AWSCognitoIdentityProviderAdminEnableUserRequest : AWSRequest
  728. /**
  729. <p>The user pool ID for the user pool where you want to enable the user.</p>
  730. */
  731. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  732. /**
  733. <p>The user name of the user you wish to enable.</p>
  734. */
  735. @property (nonatomic, strong) NSString * _Nullable username;
  736. @end
  737. /**
  738. <p>Represents the response from the server for the request to enable a user as an administrator.</p>
  739. */
  740. @interface AWSCognitoIdentityProviderAdminEnableUserResponse : AWSModel
  741. @end
  742. /**
  743. <p>Sends the forgot device request, as an administrator.</p>
  744. Required parameters: [UserPoolId, Username, DeviceKey]
  745. */
  746. @interface AWSCognitoIdentityProviderAdminForgetDeviceRequest : AWSRequest
  747. /**
  748. <p>The device key.</p>
  749. */
  750. @property (nonatomic, strong) NSString * _Nullable deviceKey;
  751. /**
  752. <p>The user pool ID.</p>
  753. */
  754. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  755. /**
  756. <p>The user name.</p>
  757. */
  758. @property (nonatomic, strong) NSString * _Nullable username;
  759. @end
  760. /**
  761. <p>Represents the request to get the device, as an administrator.</p>
  762. Required parameters: [DeviceKey, UserPoolId, Username]
  763. */
  764. @interface AWSCognitoIdentityProviderAdminGetDeviceRequest : AWSRequest
  765. /**
  766. <p>The device key.</p>
  767. */
  768. @property (nonatomic, strong) NSString * _Nullable deviceKey;
  769. /**
  770. <p>The user pool ID.</p>
  771. */
  772. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  773. /**
  774. <p>The user name.</p>
  775. */
  776. @property (nonatomic, strong) NSString * _Nullable username;
  777. @end
  778. /**
  779. <p>Gets the device response, as an administrator.</p>
  780. Required parameters: [Device]
  781. */
  782. @interface AWSCognitoIdentityProviderAdminGetDeviceResponse : AWSModel
  783. /**
  784. <p>The device.</p>
  785. */
  786. @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceType * _Nullable device;
  787. @end
  788. /**
  789. <p>Represents the request to get the specified user as an administrator.</p>
  790. Required parameters: [UserPoolId, Username]
  791. */
  792. @interface AWSCognitoIdentityProviderAdminGetUserRequest : AWSRequest
  793. /**
  794. <p>The user pool ID for the user pool where you want to get information about the user.</p>
  795. */
  796. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  797. /**
  798. <p>The user name of the user you wish to retrieve.</p>
  799. */
  800. @property (nonatomic, strong) NSString * _Nullable username;
  801. @end
  802. /**
  803. <p>Represents the response from the server from the request to get the specified user as an administrator.</p>
  804. Required parameters: [Username]
  805. */
  806. @interface AWSCognitoIdentityProviderAdminGetUserResponse : AWSModel
  807. /**
  808. <p>Indicates that the status is enabled.</p>
  809. */
  810. @property (nonatomic, strong) NSNumber * _Nullable enabled;
  811. /**
  812. <p>Specifies the options for MFA (e.g., email or phone number).</p>
  813. */
  814. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderMFAOptionType *> * _Nullable MFAOptions;
  815. /**
  816. <p>The user's preferred MFA setting.</p>
  817. */
  818. @property (nonatomic, strong) NSString * _Nullable preferredMfaSetting;
  819. /**
  820. <p>An array of name-value pairs representing user attributes.</p>
  821. */
  822. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType *> * _Nullable userAttributes;
  823. /**
  824. <p>The date the user was created.</p>
  825. */
  826. @property (nonatomic, strong) NSDate * _Nullable userCreateDate;
  827. /**
  828. <p>The date the user was last modified.</p>
  829. */
  830. @property (nonatomic, strong) NSDate * _Nullable userLastModifiedDate;
  831. /**
  832. <p>The list of the user's MFA settings.</p>
  833. */
  834. @property (nonatomic, strong) NSArray<NSString *> * _Nullable userMFASettingList;
  835. /**
  836. <p>The user status. Can be one of the following:</p><ul><li><p>UNCONFIRMED - User has been created but not confirmed.</p></li><li><p>CONFIRMED - User has been confirmed.</p></li><li><p>ARCHIVED - User is no longer active.</p></li><li><p>COMPROMISED - User is disabled due to a potential security threat.</p></li><li><p>UNKNOWN - User status is not known.</p></li></ul>
  837. */
  838. @property (nonatomic, assign) AWSCognitoIdentityProviderUserStatusType userStatus;
  839. /**
  840. <p>The user name of the user about whom you are receiving information.</p>
  841. */
  842. @property (nonatomic, strong) NSString * _Nullable username;
  843. @end
  844. /**
  845. <p>Initiates the authorization request, as an administrator.</p>
  846. Required parameters: [UserPoolId, ClientId, AuthFlow]
  847. */
  848. @interface AWSCognitoIdentityProviderAdminInitiateAuthRequest : AWSRequest
  849. /**
  850. <p>The analytics metadata for collecting Amazon Pinpoint metrics for <code>AdminInitiateAuth</code> calls.</p>
  851. */
  852. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata;
  853. /**
  854. <p>The authentication flow for this call to execute. The API action will depend on this value. For example:</p><ul><li><p><code>REFRESH_TOKEN_AUTH</code> will take in a valid refresh token and return new tokens.</p></li><li><p><code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and <code>SRP_A</code> and return the SRP variables to be used for next challenge execution.</p></li><li><p><code>USER_PASSWORD_AUTH</code> will take in <code>USERNAME</code> and <code>PASSWORD</code> and return the next challenge or tokens.</p></li></ul><p>Valid values include:</p><ul><li><p><code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password (SRP) protocol.</p></li><li><p><code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.</p></li><li><p><code>CUSTOM_AUTH</code>: Custom authentication flow.</p></li><li><p><code>ADMIN_NO_SRP_AUTH</code>: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.</p></li><li><p><code>USER_PASSWORD_AUTH</code>: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool. </p></li></ul>
  855. */
  856. @property (nonatomic, assign) AWSCognitoIdentityProviderAuthFlowType authFlow;
  857. /**
  858. <p>The authentication parameters. These are inputs corresponding to the <code>AuthFlow</code> that you are invoking. The required values depend on the value of <code>AuthFlow</code>:</p><ul><li><p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SRP_A</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code></p></li><li><p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code></p></li><li><p>For <code>ADMIN_NO_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>PASSWORD</code> (required), <code>DEVICE_KEY</code></p></li><li><p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>DEVICE_KEY</code></p></li></ul>
  859. */
  860. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable authParameters;
  861. /**
  862. <p>The app client ID.</p>
  863. */
  864. @property (nonatomic, strong) NSString * _Nullable clientId;
  865. /**
  866. <p>This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.</p>
  867. */
  868. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable clientMetadata;
  869. /**
  870. <p>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.</p>
  871. */
  872. @property (nonatomic, strong) AWSCognitoIdentityProviderContextDataType * _Nullable contextData;
  873. /**
  874. <p>The ID of the Amazon Cognito user pool.</p>
  875. */
  876. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  877. @end
  878. /**
  879. <p>Initiates the authentication response, as an administrator.</p>
  880. */
  881. @interface AWSCognitoIdentityProviderAdminInitiateAuthResponse : AWSModel
  882. /**
  883. <p>The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, <code>ChallengeName</code>, <code>ChallengeParameters</code>, and <code>Session</code> are returned.</p>
  884. */
  885. @property (nonatomic, strong) AWSCognitoIdentityProviderAuthenticationResultType * _Nullable authenticationResult;
  886. /**
  887. <p>The name of the challenge which you are responding to with this call. This is returned to you in the <code>AdminInitiateAuth</code> response if you need to pass another challenge.</p><ul><li><p><code>MFA_SETUP</code>: If MFA is required, users who do not have at least one of the MFA methods set up are presented with an <code>MFA_SETUP</code> challenge. The user must set up at least one MFA type to continue to authenticate.</p></li><li><p><code>SELECT_MFA_TYPE</code>: Selects the MFA type. Valid MFA options are <code>SMS_MFA</code> for text SMS MFA, and <code>SOFTWARE_TOKEN_MFA</code> for TOTP software token MFA.</p></li><li><p><code>SMS_MFA</code>: Next challenge is to supply an <code>SMS_MFA_CODE</code>, delivered via SMS.</p></li><li><p><code>PASSWORD_VERIFIER</code>: Next challenge is to supply <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after the client-side SRP calculations.</p></li><li><p><code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.</p></li><li><p><code>DEVICE_SRP_AUTH</code>: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.</p></li><li><p><code>DEVICE_PASSWORD_VERIFIER</code>: Similar to <code>PASSWORD_VERIFIER</code>, but for devices only.</p></li><li><p><code>ADMIN_NO_SRP_AUTH</code>: This is returned if you need to authenticate with <code>USERNAME</code> and <code>PASSWORD</code> directly. An app client must be enabled to use this flow.</p></li><li><p><code>NEW_PASSWORD_REQUIRED</code>: For users which are required to change their passwords after successful first login. This challenge should be passed with <code>NEW_PASSWORD</code> and any other required attributes.</p></li></ul>
  888. */
  889. @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName;
  890. /**
  891. <p>The challenge parameters. These are returned to you in the <code>AdminInitiateAuth</code> response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (<code>AdminRespondToAuthChallenge</code>).</p><p>All challenges require <code>USERNAME</code> and <code>SECRET_HASH</code> (if applicable).</p><p>The value of the <code>USER_ID_FOR_SRP</code> attribute will be 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 <code>AdminInitiateAuth</code>. This is because, in the <code>AdminRespondToAuthChallenge</code> API <code>ChallengeResponses</code>, the <code>USERNAME</code> attribute cannot be an alias.</p>
  892. */
  893. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable challengeParameters;
  894. /**
  895. <p>The session which should be passed both ways in challenge-response calls to the service. If <code>AdminInitiateAuth</code> or <code>AdminRespondToAuthChallenge</code> API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>AdminRespondToAuthChallenge</code> API call.</p>
  896. */
  897. @property (nonatomic, strong) NSString * _Nullable session;
  898. @end
  899. /**
  900. */
  901. @interface AWSCognitoIdentityProviderAdminLinkProviderForUserRequest : AWSRequest
  902. /**
  903. <p>The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider attribute) signs in.</p><p>For a native username + password user, the <code>ProviderAttributeValue</code> for the <code>DestinationUser</code> should be the username in the user pool. For a federated user, it should be the provider-specific <code>user_id</code>.</p><p>The <code>ProviderAttributeName</code> of the <code>DestinationUser</code> is ignored.</p><p>The <code>ProviderName</code> should be set to <code>Cognito</code> for users in Cognito user pools.</p>
  904. */
  905. @property (nonatomic, strong) AWSCognitoIdentityProviderProviderUserIdentifierType * _Nullable destinationUser;
  906. /**
  907. <p>An external identity provider account for a user who does not currently exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.</p><p>If the <code>SourceUser</code> is a federated social identity provider user (Facebook, Google, or Login with Amazon), you must set the <code>ProviderAttributeName</code> to <code>Cognito_Subject</code>. For social identity providers, the <code>ProviderName</code> will be <code>Facebook</code>, <code>Google</code>, or <code>LoginWithAmazon</code>, and Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for <code>id</code>, <code>sub</code>, and <code>user_id</code>, respectively. The <code>ProviderAttributeValue</code> for the user must be the same value as the <code>id</code>, <code>sub</code>, or <code>user_id</code> value found in the social identity provider token.</p><p/><p>For SAML, the <code>ProviderAttributeName</code> can be any value that matches a claim in the SAML assertion. If you wish to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML identity provider and submit that claim name as the <code>ProviderAttributeName</code>. If you set <code>ProviderAttributeName</code> to <code>Cognito_Subject</code>, Cognito will automatically parse the default unique identifier found in the subject from the SAML token.</p>
  908. */
  909. @property (nonatomic, strong) AWSCognitoIdentityProviderProviderUserIdentifierType * _Nullable sourceUser;
  910. /**
  911. <p>The user pool ID for the user pool.</p>
  912. */
  913. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  914. @end
  915. /**
  916. */
  917. @interface AWSCognitoIdentityProviderAdminLinkProviderForUserResponse : AWSModel
  918. @end
  919. /**
  920. <p>Represents the request to list devices, as an administrator.</p>
  921. Required parameters: [UserPoolId, Username]
  922. */
  923. @interface AWSCognitoIdentityProviderAdminListDevicesRequest : AWSRequest
  924. /**
  925. <p>The limit of the devices request.</p>
  926. */
  927. @property (nonatomic, strong) NSNumber * _Nullable limit;
  928. /**
  929. <p>The pagination token.</p>
  930. */
  931. @property (nonatomic, strong) NSString * _Nullable paginationToken;
  932. /**
  933. <p>The user pool ID.</p>
  934. */
  935. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  936. /**
  937. <p>The user name.</p>
  938. */
  939. @property (nonatomic, strong) NSString * _Nullable username;
  940. @end
  941. /**
  942. <p>Lists the device's response, as an administrator.</p>
  943. */
  944. @interface AWSCognitoIdentityProviderAdminListDevicesResponse : AWSModel
  945. /**
  946. <p>The devices in the list of devices response.</p>
  947. */
  948. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderDeviceType *> * _Nullable devices;
  949. /**
  950. <p>The pagination token.</p>
  951. */
  952. @property (nonatomic, strong) NSString * _Nullable paginationToken;
  953. @end
  954. /**
  955. */
  956. @interface AWSCognitoIdentityProviderAdminListGroupsForUserRequest : AWSRequest
  957. /**
  958. <p>The limit of the request to list groups.</p>
  959. */
  960. @property (nonatomic, strong) NSNumber * _Nullable limit;
  961. /**
  962. <p>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.</p>
  963. */
  964. @property (nonatomic, strong) NSString * _Nullable nextToken;
  965. /**
  966. <p>The user pool ID for the user pool.</p>
  967. */
  968. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  969. /**
  970. <p>The username for the user.</p>
  971. */
  972. @property (nonatomic, strong) NSString * _Nullable username;
  973. @end
  974. /**
  975. */
  976. @interface AWSCognitoIdentityProviderAdminListGroupsForUserResponse : AWSModel
  977. /**
  978. <p>The groups that the user belongs to.</p>
  979. */
  980. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderGroupType *> * _Nullable groups;
  981. /**
  982. <p>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.</p>
  983. */
  984. @property (nonatomic, strong) NSString * _Nullable nextToken;
  985. @end
  986. /**
  987. */
  988. @interface AWSCognitoIdentityProviderAdminListUserAuthEventsRequest : AWSRequest
  989. /**
  990. <p>The maximum number of authentication events to return.</p>
  991. */
  992. @property (nonatomic, strong) NSNumber * _Nullable maxResults;
  993. /**
  994. <p>A pagination token.</p>
  995. */
  996. @property (nonatomic, strong) NSString * _Nullable nextToken;
  997. /**
  998. <p>The user pool ID.</p>
  999. */
  1000. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1001. /**
  1002. <p>The user pool username or an alias.</p>
  1003. */
  1004. @property (nonatomic, strong) NSString * _Nullable username;
  1005. @end
  1006. /**
  1007. */
  1008. @interface AWSCognitoIdentityProviderAdminListUserAuthEventsResponse : AWSModel
  1009. /**
  1010. <p>The response object. It includes the <code>EventID</code>, <code>EventType</code>, <code>CreationDate</code>, <code>EventRisk</code>, and <code>EventResponse</code>.</p>
  1011. */
  1012. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAuthEventType *> * _Nullable authEvents;
  1013. /**
  1014. <p>A pagination token.</p>
  1015. */
  1016. @property (nonatomic, strong) NSString * _Nullable nextToken;
  1017. @end
  1018. /**
  1019. */
  1020. @interface AWSCognitoIdentityProviderAdminRemoveUserFromGroupRequest : AWSRequest
  1021. /**
  1022. <p>The group name.</p>
  1023. */
  1024. @property (nonatomic, strong) NSString * _Nullable groupName;
  1025. /**
  1026. <p>The user pool ID for the user pool.</p>
  1027. */
  1028. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1029. /**
  1030. <p>The username for the user.</p>
  1031. */
  1032. @property (nonatomic, strong) NSString * _Nullable username;
  1033. @end
  1034. /**
  1035. <p>Represents the request to reset a user's password as an administrator.</p>
  1036. Required parameters: [UserPoolId, Username]
  1037. */
  1038. @interface AWSCognitoIdentityProviderAdminResetUserPasswordRequest : AWSRequest
  1039. /**
  1040. <p>The user pool ID for the user pool where you want to reset the user's password.</p>
  1041. */
  1042. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1043. /**
  1044. <p>The user name of the user whose password you wish to reset.</p>
  1045. */
  1046. @property (nonatomic, strong) NSString * _Nullable username;
  1047. @end
  1048. /**
  1049. <p>Represents the response from the server to reset a user password as an administrator.</p>
  1050. */
  1051. @interface AWSCognitoIdentityProviderAdminResetUserPasswordResponse : AWSModel
  1052. @end
  1053. /**
  1054. <p>The request to respond to the authentication challenge, as an administrator.</p>
  1055. Required parameters: [UserPoolId, ClientId, ChallengeName]
  1056. */
  1057. @interface AWSCognitoIdentityProviderAdminRespondToAuthChallengeRequest : AWSRequest
  1058. /**
  1059. <p>The analytics metadata for collecting Amazon Pinpoint metrics for <code>AdminRespondToAuthChallenge</code> calls.</p>
  1060. */
  1061. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata;
  1062. /**
  1063. <p>The challenge name. For more information, see .</p>
  1064. */
  1065. @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName;
  1066. /**
  1067. <p>The challenge responses. These are inputs corresponding to the value of <code>ChallengeName</code>, for example:</p><ul><li><p><code>SMS_MFA</code>: <code>SMS_MFA_CODE</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p></li><li><p><code>PASSWORD_VERIFIER</code>: <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, <code>TIMESTAMP</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p></li><li><p><code>ADMIN_NO_SRP_AUTH</code>: <code>PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). </p></li><li><p><code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>, any other required attributes, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). </p></li></ul><p>The value of the <code>USERNAME</code> attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the <code>AdminInitiateAuth</code> response includes the actual username value in the <code>USERNAMEUSER_ID_FOR_SRP</code> attribute, even if you specified an alias in your call to <code>AdminInitiateAuth</code>.</p>
  1068. */
  1069. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable challengeResponses;
  1070. /**
  1071. <p>The app client ID.</p>
  1072. */
  1073. @property (nonatomic, strong) NSString * _Nullable clientId;
  1074. /**
  1075. <p>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.</p>
  1076. */
  1077. @property (nonatomic, strong) AWSCognitoIdentityProviderContextDataType * _Nullable contextData;
  1078. /**
  1079. <p>The session which should be passed both ways in challenge-response calls to the service. If <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
  1080. */
  1081. @property (nonatomic, strong) NSString * _Nullable session;
  1082. /**
  1083. <p>The ID of the Amazon Cognito user pool.</p>
  1084. */
  1085. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1086. @end
  1087. /**
  1088. <p>Responds to the authentication challenge, as an administrator.</p>
  1089. */
  1090. @interface AWSCognitoIdentityProviderAdminRespondToAuthChallengeResponse : AWSModel
  1091. /**
  1092. <p>The result returned by the server in response to the authentication request.</p>
  1093. */
  1094. @property (nonatomic, strong) AWSCognitoIdentityProviderAuthenticationResultType * _Nullable authenticationResult;
  1095. /**
  1096. <p>The name of the challenge. For more information, see .</p>
  1097. */
  1098. @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName;
  1099. /**
  1100. <p>The challenge parameters. For more information, see .</p>
  1101. */
  1102. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable challengeParameters;
  1103. /**
  1104. <p>The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
  1105. */
  1106. @property (nonatomic, strong) NSString * _Nullable session;
  1107. @end
  1108. /**
  1109. */
  1110. @interface AWSCognitoIdentityProviderAdminSetUserMFAPreferenceRequest : AWSRequest
  1111. /**
  1112. <p>The SMS text message MFA settings.</p>
  1113. */
  1114. @property (nonatomic, strong) AWSCognitoIdentityProviderSMSMfaSettingsType * _Nullable SMSMfaSettings;
  1115. /**
  1116. <p>The time-based one-time password software token MFA settings.</p>
  1117. */
  1118. @property (nonatomic, strong) AWSCognitoIdentityProviderSoftwareTokenMfaSettingsType * _Nullable softwareTokenMfaSettings;
  1119. /**
  1120. <p>The user pool ID.</p>
  1121. */
  1122. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1123. /**
  1124. <p>The user pool username or alias.</p>
  1125. */
  1126. @property (nonatomic, strong) NSString * _Nullable username;
  1127. @end
  1128. /**
  1129. */
  1130. @interface AWSCognitoIdentityProviderAdminSetUserMFAPreferenceResponse : AWSModel
  1131. @end
  1132. /**
  1133. <p>Represents the request to set user settings as an administrator.</p>
  1134. Required parameters: [UserPoolId, Username, MFAOptions]
  1135. */
  1136. @interface AWSCognitoIdentityProviderAdminSetUserSettingsRequest : AWSRequest
  1137. /**
  1138. <p>Specifies the options for MFA (e.g., email or phone number).</p>
  1139. */
  1140. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderMFAOptionType *> * _Nullable MFAOptions;
  1141. /**
  1142. <p>The user pool ID for the user pool where you want to set the user's settings, such as MFA options.</p>
  1143. */
  1144. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1145. /**
  1146. <p>The user name of the user for whom you wish to set user settings.</p>
  1147. */
  1148. @property (nonatomic, strong) NSString * _Nullable username;
  1149. @end
  1150. /**
  1151. <p>Represents the response from the server to set user settings as an administrator.</p>
  1152. */
  1153. @interface AWSCognitoIdentityProviderAdminSetUserSettingsResponse : AWSModel
  1154. @end
  1155. /**
  1156. */
  1157. @interface AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackRequest : AWSRequest
  1158. /**
  1159. <p>The authentication event ID.</p>
  1160. */
  1161. @property (nonatomic, strong) NSString * _Nullable eventId;
  1162. /**
  1163. <p>The authentication event feedback value.</p>
  1164. */
  1165. @property (nonatomic, assign) AWSCognitoIdentityProviderFeedbackValueType feedbackValue;
  1166. /**
  1167. <p>The user pool ID.</p>
  1168. */
  1169. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1170. /**
  1171. <p>The user pool username.</p>
  1172. */
  1173. @property (nonatomic, strong) NSString * _Nullable username;
  1174. @end
  1175. /**
  1176. */
  1177. @interface AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackResponse : AWSModel
  1178. @end
  1179. /**
  1180. <p>The request to update the device status, as an administrator.</p>
  1181. Required parameters: [UserPoolId, Username, DeviceKey]
  1182. */
  1183. @interface AWSCognitoIdentityProviderAdminUpdateDeviceStatusRequest : AWSRequest
  1184. /**
  1185. <p>The device key.</p>
  1186. */
  1187. @property (nonatomic, strong) NSString * _Nullable deviceKey;
  1188. /**
  1189. <p>The status indicating whether a device has been remembered or not.</p>
  1190. */
  1191. @property (nonatomic, assign) AWSCognitoIdentityProviderDeviceRememberedStatusType deviceRememberedStatus;
  1192. /**
  1193. <p>The user pool ID.</p>
  1194. */
  1195. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1196. /**
  1197. <p>The user name.</p>
  1198. */
  1199. @property (nonatomic, strong) NSString * _Nullable username;
  1200. @end
  1201. /**
  1202. <p>The status response from the request to update the device, as an administrator.</p>
  1203. */
  1204. @interface AWSCognitoIdentityProviderAdminUpdateDeviceStatusResponse : AWSModel
  1205. @end
  1206. /**
  1207. <p>Represents the request to update the user's attributes as an administrator.</p>
  1208. Required parameters: [UserPoolId, Username, UserAttributes]
  1209. */
  1210. @interface AWSCognitoIdentityProviderAdminUpdateUserAttributesRequest : AWSRequest
  1211. /**
  1212. <p>An array of name-value pairs representing user attributes.</p><p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
  1213. */
  1214. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType *> * _Nullable userAttributes;
  1215. /**
  1216. <p>The user pool ID for the user pool where you want to update user attributes.</p>
  1217. */
  1218. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1219. /**
  1220. <p>The user name of the user for whom you want to update user attributes.</p>
  1221. */
  1222. @property (nonatomic, strong) NSString * _Nullable username;
  1223. @end
  1224. /**
  1225. <p>Represents the response from the server for the request to update user attributes as an administrator.</p>
  1226. */
  1227. @interface AWSCognitoIdentityProviderAdminUpdateUserAttributesResponse : AWSModel
  1228. @end
  1229. /**
  1230. <p>The request to sign out of all devices, as an administrator.</p>
  1231. Required parameters: [UserPoolId, Username]
  1232. */
  1233. @interface AWSCognitoIdentityProviderAdminUserGlobalSignOutRequest : AWSRequest
  1234. /**
  1235. <p>The user pool ID.</p>
  1236. */
  1237. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1238. /**
  1239. <p>The user name.</p>
  1240. */
  1241. @property (nonatomic, strong) NSString * _Nullable username;
  1242. @end
  1243. /**
  1244. <p>The global sign-out response, as an administrator.</p>
  1245. */
  1246. @interface AWSCognitoIdentityProviderAdminUserGlobalSignOutResponse : AWSModel
  1247. @end
  1248. /**
  1249. <p>The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.</p>
  1250. Required parameters: [ApplicationId, RoleArn, ExternalId]
  1251. */
  1252. @interface AWSCognitoIdentityProviderAnalyticsConfigurationType : AWSModel
  1253. /**
  1254. <p>The application ID for an Amazon Pinpoint application.</p>
  1255. */
  1256. @property (nonatomic, strong) NSString * _Nullable applicationId;
  1257. /**
  1258. <p>The external ID.</p>
  1259. */
  1260. @property (nonatomic, strong) NSString * _Nullable externalId;
  1261. /**
  1262. <p>The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.</p>
  1263. */
  1264. @property (nonatomic, strong) NSString * _Nullable roleArn;
  1265. /**
  1266. <p>If <code>UserDataShared</code> is <code>true</code>, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.</p>
  1267. */
  1268. @property (nonatomic, strong) NSNumber * _Nullable userDataShared;
  1269. @end
  1270. /**
  1271. <p>An Amazon Pinpoint analytics endpoint.</p><p>An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.</p>
  1272. */
  1273. @interface AWSCognitoIdentityProviderAnalyticsMetadataType : AWSModel
  1274. /**
  1275. <p>The endpoint ID.</p>
  1276. */
  1277. @property (nonatomic, strong) NSString * _Nullable analyticsEndpointId;
  1278. @end
  1279. /**
  1280. */
  1281. @interface AWSCognitoIdentityProviderAssociateSoftwareTokenRequest : AWSRequest
  1282. /**
  1283. <p>The access token.</p>
  1284. */
  1285. @property (nonatomic, strong) NSString * _Nullable accessToken;
  1286. /**
  1287. <p>The session which 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.</p>
  1288. */
  1289. @property (nonatomic, strong) NSString * _Nullable session;
  1290. @end
  1291. /**
  1292. */
  1293. @interface AWSCognitoIdentityProviderAssociateSoftwareTokenResponse : AWSModel
  1294. /**
  1295. <p>A unique generated shared secret code that is used in the TOTP algorithm to generate a one time code.</p>
  1296. */
  1297. @property (nonatomic, strong) NSString * _Nullable secretCode;
  1298. /**
  1299. <p>The session which 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.</p>
  1300. */
  1301. @property (nonatomic, strong) NSString * _Nullable session;
  1302. @end
  1303. /**
  1304. <p>Specifies whether the attribute is standard or custom.</p>
  1305. Required parameters: [Name]
  1306. */
  1307. @interface AWSCognitoIdentityProviderAttributeType : AWSModel
  1308. /**
  1309. <p>The name of the attribute.</p>
  1310. */
  1311. @property (nonatomic, strong) NSString * _Nullable name;
  1312. /**
  1313. <p>The value of the attribute.</p>
  1314. */
  1315. @property (nonatomic, strong) NSString * _Nullable value;
  1316. @end
  1317. /**
  1318. <p>The authentication event type.</p>
  1319. */
  1320. @interface AWSCognitoIdentityProviderAuthEventType : AWSModel
  1321. /**
  1322. <p>The challenge responses.</p>
  1323. */
  1324. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderChallengeResponseType *> * _Nullable challengeResponses;
  1325. /**
  1326. <p>The creation date</p>
  1327. */
  1328. @property (nonatomic, strong) NSDate * _Nullable creationDate;
  1329. /**
  1330. <p>The user context data captured at the time of an event request. It provides additional information about the client from which event the request is received.</p>
  1331. */
  1332. @property (nonatomic, strong) AWSCognitoIdentityProviderEventContextDataType * _Nullable eventContextData;
  1333. /**
  1334. <p>A flag specifying the user feedback captured at the time of an event request is good or bad. </p>
  1335. */
  1336. @property (nonatomic, strong) AWSCognitoIdentityProviderEventFeedbackType * _Nullable eventFeedback;
  1337. /**
  1338. <p>The event ID.</p>
  1339. */
  1340. @property (nonatomic, strong) NSString * _Nullable eventId;
  1341. /**
  1342. <p>The event response.</p>
  1343. */
  1344. @property (nonatomic, assign) AWSCognitoIdentityProviderEventResponseType eventResponse;
  1345. /**
  1346. <p>The event risk.</p>
  1347. */
  1348. @property (nonatomic, strong) AWSCognitoIdentityProviderEventRiskType * _Nullable eventRisk;
  1349. /**
  1350. <p>The event type.</p>
  1351. */
  1352. @property (nonatomic, assign) AWSCognitoIdentityProviderEventType eventType;
  1353. @end
  1354. /**
  1355. <p>The authentication result.</p>
  1356. */
  1357. @interface AWSCognitoIdentityProviderAuthenticationResultType : AWSModel
  1358. /**
  1359. <p>The access token.</p>
  1360. */
  1361. @property (nonatomic, strong) NSString * _Nullable accessToken;
  1362. /**
  1363. <p>The expiration period of the authentication result in seconds.</p>
  1364. */
  1365. @property (nonatomic, strong) NSNumber * _Nullable expiresIn;
  1366. /**
  1367. <p>The ID token.</p>
  1368. */
  1369. @property (nonatomic, strong) NSString * _Nullable idToken;
  1370. /**
  1371. <p>The new device metadata from an authentication result.</p>
  1372. */
  1373. @property (nonatomic, strong) AWSCognitoIdentityProviderLatestDeviceMetadataType * _Nullable latestDeviceMetadata;
  1374. /**
  1375. <p>The refresh token.</p>
  1376. */
  1377. @property (nonatomic, strong) NSString * _Nullable refreshToken;
  1378. /**
  1379. <p>The token type.</p>
  1380. */
  1381. @property (nonatomic, strong) NSString * _Nullable tokenType;
  1382. @end
  1383. /**
  1384. <p>The challenge response type.</p>
  1385. */
  1386. @interface AWSCognitoIdentityProviderChallengeResponseType : AWSModel
  1387. /**
  1388. <p>The challenge name</p>
  1389. */
  1390. @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeName challengeName;
  1391. /**
  1392. <p>The challenge response.</p>
  1393. */
  1394. @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeResponse challengeResponse;
  1395. @end
  1396. /**
  1397. <p>Represents the request to change a user password.</p>
  1398. Required parameters: [PreviousPassword, ProposedPassword, AccessToken]
  1399. */
  1400. @interface AWSCognitoIdentityProviderChangePasswordRequest : AWSRequest
  1401. /**
  1402. <p>The access token.</p>
  1403. */
  1404. @property (nonatomic, strong) NSString * _Nullable accessToken;
  1405. /**
  1406. <p>The old password.</p>
  1407. */
  1408. @property (nonatomic, strong) NSString * _Nullable previousPassword;
  1409. /**
  1410. <p>The new password.</p>
  1411. */
  1412. @property (nonatomic, strong) NSString * _Nullable proposedPassword;
  1413. @end
  1414. /**
  1415. <p>The response from the server to the change password request.</p>
  1416. */
  1417. @interface AWSCognitoIdentityProviderChangePasswordResponse : AWSModel
  1418. @end
  1419. /**
  1420. <p>The code delivery details being returned from the server.</p>
  1421. */
  1422. @interface AWSCognitoIdentityProviderCodeDeliveryDetailsType : AWSModel
  1423. /**
  1424. <p>The attribute name.</p>
  1425. */
  1426. @property (nonatomic, strong) NSString * _Nullable attributeName;
  1427. /**
  1428. <p>The delivery medium (email message or phone number).</p>
  1429. */
  1430. @property (nonatomic, assign) AWSCognitoIdentityProviderDeliveryMediumType deliveryMedium;
  1431. /**
  1432. <p>The destination for the code delivery details.</p>
  1433. */
  1434. @property (nonatomic, strong) NSString * _Nullable destination;
  1435. @end
  1436. /**
  1437. <p>The compromised credentials actions type</p>
  1438. Required parameters: [EventAction]
  1439. */
  1440. @interface AWSCognitoIdentityProviderCompromisedCredentialsActionsType : AWSModel
  1441. /**
  1442. <p>The event action.</p>
  1443. */
  1444. @property (nonatomic, assign) AWSCognitoIdentityProviderCompromisedCredentialsEventActionType eventAction;
  1445. @end
  1446. /**
  1447. <p>The compromised credentials risk configuration type.</p>
  1448. Required parameters: [Actions]
  1449. */
  1450. @interface AWSCognitoIdentityProviderCompromisedCredentialsRiskConfigurationType : AWSModel
  1451. /**
  1452. <p>The compromised credentials risk configuration actions.</p>
  1453. */
  1454. @property (nonatomic, strong) AWSCognitoIdentityProviderCompromisedCredentialsActionsType * _Nullable actions;
  1455. /**
  1456. <p>Perform the action for these events. The default is to perform all events if no event filter is specified.</p>
  1457. */
  1458. @property (nonatomic, strong) NSArray<NSString *> * _Nullable eventFilter;
  1459. @end
  1460. /**
  1461. <p>Confirms the device request.</p>
  1462. Required parameters: [AccessToken, DeviceKey]
  1463. */
  1464. @interface AWSCognitoIdentityProviderConfirmDeviceRequest : AWSRequest
  1465. /**
  1466. <p>The access token.</p>
  1467. */
  1468. @property (nonatomic, strong) NSString * _Nullable accessToken;
  1469. /**
  1470. <p>The device key.</p>
  1471. */
  1472. @property (nonatomic, strong) NSString * _Nullable deviceKey;
  1473. /**
  1474. <p>The device name.</p>
  1475. */
  1476. @property (nonatomic, strong) NSString * _Nullable deviceName;
  1477. /**
  1478. <p>The configuration of the device secret verifier.</p>
  1479. */
  1480. @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceSecretVerifierConfigType * _Nullable deviceSecretVerifierConfig;
  1481. @end
  1482. /**
  1483. <p>Confirms the device response.</p>
  1484. */
  1485. @interface AWSCognitoIdentityProviderConfirmDeviceResponse : AWSModel
  1486. /**
  1487. <p>Indicates whether the user confirmation is necessary to confirm the device response.</p>
  1488. */
  1489. @property (nonatomic, strong) NSNumber * _Nullable userConfirmationNecessary;
  1490. @end
  1491. /**
  1492. <p>The request representing the confirmation for a password reset.</p>
  1493. Required parameters: [ClientId, Username, ConfirmationCode, Password]
  1494. */
  1495. @interface AWSCognitoIdentityProviderConfirmForgotPasswordRequest : AWSRequest
  1496. /**
  1497. <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ConfirmForgotPassword</code> calls.</p>
  1498. */
  1499. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata;
  1500. /**
  1501. <p>The app client ID of the app associated with the user pool.</p>
  1502. */
  1503. @property (nonatomic, strong) NSString * _Nullable clientId;
  1504. /**
  1505. <p>The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see </p>
  1506. */
  1507. @property (nonatomic, strong) NSString * _Nullable confirmationCode;
  1508. /**
  1509. <p>The password sent by a user's request to retrieve a forgotten password.</p>
  1510. */
  1511. @property (nonatomic, strong) NSString * _Nullable password;
  1512. /**
  1513. <p>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.</p>
  1514. */
  1515. @property (nonatomic, strong) NSString * _Nullable secretHash;
  1516. /**
  1517. <p>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.</p>
  1518. */
  1519. @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData;
  1520. /**
  1521. <p>The user name of the user for whom you want to enter a code to retrieve a forgotten password.</p>
  1522. */
  1523. @property (nonatomic, strong) NSString * _Nullable username;
  1524. @end
  1525. /**
  1526. <p>The response from the server that results from a user's request to retrieve a forgotten password.</p>
  1527. */
  1528. @interface AWSCognitoIdentityProviderConfirmForgotPasswordResponse : AWSModel
  1529. @end
  1530. /**
  1531. <p>Represents the request to confirm registration of a user.</p>
  1532. Required parameters: [ClientId, Username, ConfirmationCode]
  1533. */
  1534. @interface AWSCognitoIdentityProviderConfirmSignUpRequest : AWSRequest
  1535. /**
  1536. <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ConfirmSignUp</code> calls.</p>
  1537. */
  1538. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata;
  1539. /**
  1540. <p>The ID of the app client associated with the user pool.</p>
  1541. */
  1542. @property (nonatomic, strong) NSString * _Nullable clientId;
  1543. /**
  1544. <p>The confirmation code sent by a user's request to confirm registration.</p>
  1545. */
  1546. @property (nonatomic, strong) NSString * _Nullable confirmationCode;
  1547. /**
  1548. <p>Boolean to be specified to force user confirmation irrespective of existing alias. By default set to <code>False</code>. If this parameter is set to <code>True</code> 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 <code>False</code>, the API will throw an <b>AliasExistsException</b> error.</p>
  1549. */
  1550. @property (nonatomic, strong) NSNumber * _Nullable forceAliasCreation;
  1551. /**
  1552. <p>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.</p>
  1553. */
  1554. @property (nonatomic, strong) NSString * _Nullable secretHash;
  1555. /**
  1556. <p>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.</p>
  1557. */
  1558. @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData;
  1559. /**
  1560. <p>The user name of the user whose registration you wish to confirm.</p>
  1561. */
  1562. @property (nonatomic, strong) NSString * _Nullable username;
  1563. @end
  1564. /**
  1565. <p>Represents the response from the server for the registration confirmation.</p>
  1566. */
  1567. @interface AWSCognitoIdentityProviderConfirmSignUpResponse : AWSModel
  1568. @end
  1569. /**
  1570. <p>Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
  1571. Required parameters: [IpAddress, ServerName, ServerPath, HttpHeaders]
  1572. */
  1573. @interface AWSCognitoIdentityProviderContextDataType : AWSModel
  1574. /**
  1575. <p>Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.</p>
  1576. */
  1577. @property (nonatomic, strong) NSString * _Nullable encodedData;
  1578. /**
  1579. <p>HttpHeaders received on your server in same order.</p>
  1580. */
  1581. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderHttpHeader *> * _Nullable httpHeaders;
  1582. /**
  1583. <p>Source IP address of your user.</p>
  1584. */
  1585. @property (nonatomic, strong) NSString * _Nullable ipAddress;
  1586. /**
  1587. <p>Your server endpoint where this API is invoked.</p>
  1588. */
  1589. @property (nonatomic, strong) NSString * _Nullable serverName;
  1590. /**
  1591. <p>Your server path where this API is invoked. </p>
  1592. */
  1593. @property (nonatomic, strong) NSString * _Nullable serverPath;
  1594. @end
  1595. /**
  1596. */
  1597. @interface AWSCognitoIdentityProviderCreateGroupRequest : AWSRequest
  1598. /**
  1599. <p>A string containing the description of the group.</p>
  1600. */
  1601. @property (nonatomic, strong) NSString * _Nullable detail;
  1602. /**
  1603. <p>The name of the group. Must be unique.</p>
  1604. */
  1605. @property (nonatomic, strong) NSString * _Nullable groupName;
  1606. /**
  1607. <p>A nonnegative 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 <code>Precedence</code> values take precedence over groups with higher or null <code>Precedence</code> values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims in the user's tokens.</p><p>Two groups can have the same <code>Precedence</code> value. If this happens, neither group takes precedence over the other. If two groups with the same <code>Precedence</code> have the same role ARN, that role is used in the <code>cognito:preferred_role</code> claim in tokens for users in each group. If the two groups have different role ARNs, the <code>cognito:preferred_role</code> claim is not set in users' tokens.</p><p>The default <code>Precedence</code> value is null.</p>
  1608. */
  1609. @property (nonatomic, strong) NSNumber * _Nullable precedence;
  1610. /**
  1611. <p>The role ARN for the group.</p>
  1612. */
  1613. @property (nonatomic, strong) NSString * _Nullable roleArn;
  1614. /**
  1615. <p>The user pool ID for the user pool.</p>
  1616. */
  1617. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1618. @end
  1619. /**
  1620. */
  1621. @interface AWSCognitoIdentityProviderCreateGroupResponse : AWSModel
  1622. /**
  1623. <p>The group object for the group.</p>
  1624. */
  1625. @property (nonatomic, strong) AWSCognitoIdentityProviderGroupType * _Nullable group;
  1626. @end
  1627. /**
  1628. */
  1629. @interface AWSCognitoIdentityProviderCreateIdentityProviderRequest : AWSRequest
  1630. /**
  1631. <p>A mapping of identity provider attributes to standard and custom user pool attributes.</p>
  1632. */
  1633. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable attributeMapping;
  1634. /**
  1635. <p>A list of identity provider identifiers.</p>
  1636. */
  1637. @property (nonatomic, strong) NSArray<NSString *> * _Nullable idpIdentifiers;
  1638. /**
  1639. <p>The identity provider details, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>
  1640. */
  1641. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable providerDetails;
  1642. /**
  1643. <p>The identity provider name.</p>
  1644. */
  1645. @property (nonatomic, strong) NSString * _Nullable providerName;
  1646. /**
  1647. <p>The identity provider type.</p>
  1648. */
  1649. @property (nonatomic, assign) AWSCognitoIdentityProviderIdentityProviderTypeType providerType;
  1650. /**
  1651. <p>The user pool ID.</p>
  1652. */
  1653. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1654. @end
  1655. /**
  1656. */
  1657. @interface AWSCognitoIdentityProviderCreateIdentityProviderResponse : AWSModel
  1658. /**
  1659. <p>The newly created identity provider object.</p>
  1660. */
  1661. @property (nonatomic, strong) AWSCognitoIdentityProviderIdentityProviderType * _Nullable identityProvider;
  1662. @end
  1663. /**
  1664. */
  1665. @interface AWSCognitoIdentityProviderCreateResourceServerRequest : AWSRequest
  1666. /**
  1667. <p>A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, <code>https://my-weather-api.example.com</code>.</p>
  1668. */
  1669. @property (nonatomic, strong) NSString * _Nullable identifier;
  1670. /**
  1671. <p>A friendly name for the resource server.</p>
  1672. */
  1673. @property (nonatomic, strong) NSString * _Nullable name;
  1674. /**
  1675. <p>A list of scopes. Each scope is map, where the keys are <code>name</code> and <code>description</code>.</p>
  1676. */
  1677. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderResourceServerScopeType *> * _Nullable scopes;
  1678. /**
  1679. <p>The user pool ID for the user pool.</p>
  1680. */
  1681. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1682. @end
  1683. /**
  1684. */
  1685. @interface AWSCognitoIdentityProviderCreateResourceServerResponse : AWSModel
  1686. /**
  1687. <p>The newly created resource server.</p>
  1688. */
  1689. @property (nonatomic, strong) AWSCognitoIdentityProviderResourceServerType * _Nullable resourceServer;
  1690. @end
  1691. /**
  1692. <p>Represents the request to create the user import job.</p>
  1693. Required parameters: [JobName, UserPoolId, CloudWatchLogsRoleArn]
  1694. */
  1695. @interface AWSCognitoIdentityProviderCreateUserImportJobRequest : AWSRequest
  1696. /**
  1697. <p>The role ARN for the Amazon CloudWatch Logging role for the user import job.</p>
  1698. */
  1699. @property (nonatomic, strong) NSString * _Nullable cloudWatchLogsRoleArn;
  1700. /**
  1701. <p>The job name for the user import job.</p>
  1702. */
  1703. @property (nonatomic, strong) NSString * _Nullable jobName;
  1704. /**
  1705. <p>The user pool ID for the user pool that the users are being imported into.</p>
  1706. */
  1707. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1708. @end
  1709. /**
  1710. <p>Represents the response from the server to the request to create the user import job.</p>
  1711. */
  1712. @interface AWSCognitoIdentityProviderCreateUserImportJobResponse : AWSModel
  1713. /**
  1714. <p>The job object that represents the user import job.</p>
  1715. */
  1716. @property (nonatomic, strong) AWSCognitoIdentityProviderUserImportJobType * _Nullable userImportJob;
  1717. @end
  1718. /**
  1719. <p>Represents the request to create a user pool client.</p>
  1720. Required parameters: [UserPoolId, ClientName]
  1721. */
  1722. @interface AWSCognitoIdentityProviderCreateUserPoolClientRequest : AWSRequest
  1723. /**
  1724. <p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p><p>Set to <code>token</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p>
  1725. */
  1726. @property (nonatomic, strong) NSArray<NSString *> * _Nullable allowedOAuthFlows;
  1727. /**
  1728. <p>Set to <code>True</code> if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>
  1729. */
  1730. @property (nonatomic, strong) NSNumber * _Nullable allowedOAuthFlowsUserPoolClient;
  1731. /**
  1732. <p>A list of allowed <code>OAuth</code> scopes. Currently supported values are <code>"phone"</code>, <code>"email"</code>, <code>"openid"</code>, and <code>"Cognito"</code>.</p>
  1733. */
  1734. @property (nonatomic, strong) NSArray<NSString *> * _Nullable allowedOAuthScopes;
  1735. /**
  1736. <p>The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.</p>
  1737. */
  1738. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsConfigurationType * _Nullable analyticsConfiguration;
  1739. /**
  1740. <p>A list of allowed redirect (callback) URLs for the identity providers.</p><p>A redirect URI must:</p><ul><li><p>Be an absolute URI.</p></li><li><p>Be registered with the authorization server.</p></li><li><p>Not include a fragment component.</p></li></ul><p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p><p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p><p>App callback URLs such as myapp://example are also supported.</p>
  1741. */
  1742. @property (nonatomic, strong) NSArray<NSString *> * _Nullable callbackURLs;
  1743. /**
  1744. <p>The client name for the user pool client you would like to create.</p>
  1745. */
  1746. @property (nonatomic, strong) NSString * _Nullable clientName;
  1747. /**
  1748. <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p><p>A redirect URI must:</p><ul><li><p>Be an absolute URI.</p></li><li><p>Be registered with the authorization server.</p></li><li><p>Not include a fragment component.</p></li></ul><p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p><p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p><p>App callback URLs such as myapp://example are also supported.</p>
  1749. */
  1750. @property (nonatomic, strong) NSString * _Nullable defaultRedirectURI;
  1751. /**
  1752. <p>The explicit authentication flows.</p>
  1753. */
  1754. @property (nonatomic, strong) NSArray<NSString *> * _Nullable explicitAuthFlows;
  1755. /**
  1756. <p>Boolean to specify whether you want to generate a secret for the user pool client being created.</p>
  1757. */
  1758. @property (nonatomic, strong) NSNumber * _Nullable generateSecret;
  1759. /**
  1760. <p>A list of allowed logout URLs for the identity providers.</p>
  1761. */
  1762. @property (nonatomic, strong) NSArray<NSString *> * _Nullable logoutURLs;
  1763. /**
  1764. <p>The read attributes.</p>
  1765. */
  1766. @property (nonatomic, strong) NSArray<NSString *> * _Nullable readAttributes;
  1767. /**
  1768. <p>The time limit, in days, after which the refresh token is no longer valid and cannot be used.</p>
  1769. */
  1770. @property (nonatomic, strong) NSNumber * _Nullable refreshTokenValidity;
  1771. /**
  1772. <p>A list of provider names for the identity providers that are supported on this client.</p>
  1773. */
  1774. @property (nonatomic, strong) NSArray<NSString *> * _Nullable supportedIdentityProviders;
  1775. /**
  1776. <p>The user pool ID for the user pool where you want to create a user pool client.</p>
  1777. */
  1778. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1779. /**
  1780. <p>The write attributes.</p>
  1781. */
  1782. @property (nonatomic, strong) NSArray<NSString *> * _Nullable writeAttributes;
  1783. @end
  1784. /**
  1785. <p>Represents the response from the server to create a user pool client.</p>
  1786. */
  1787. @interface AWSCognitoIdentityProviderCreateUserPoolClientResponse : AWSModel
  1788. /**
  1789. <p>The user pool client that was just created.</p>
  1790. */
  1791. @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolClientType * _Nullable userPoolClient;
  1792. @end
  1793. /**
  1794. */
  1795. @interface AWSCognitoIdentityProviderCreateUserPoolDomainRequest : AWSRequest
  1796. /**
  1797. <p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.</p><p>Provide this parameter only if you want to use own custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.</p><p>For more information about the hosted domain and custom domains, see <a href="http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html">Configuring a User Pool Domain</a>.</p>
  1798. */
  1799. @property (nonatomic, strong) AWSCognitoIdentityProviderCustomDomainConfigType * _Nullable customDomainConfig;
  1800. /**
  1801. <p>The domain string.</p>
  1802. */
  1803. @property (nonatomic, strong) NSString * _Nullable domain;
  1804. /**
  1805. <p>The user pool ID.</p>
  1806. */
  1807. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1808. @end
  1809. /**
  1810. */
  1811. @interface AWSCognitoIdentityProviderCreateUserPoolDomainResponse : AWSModel
  1812. /**
  1813. <p>The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.</p>
  1814. */
  1815. @property (nonatomic, strong) NSString * _Nullable cloudFrontDomain;
  1816. @end
  1817. /**
  1818. <p>Represents the request to create a user pool.</p>
  1819. Required parameters: [PoolName]
  1820. */
  1821. @interface AWSCognitoIdentityProviderCreateUserPoolRequest : AWSRequest
  1822. /**
  1823. <p>The configuration for <code>AdminCreateUser</code> requests.</p>
  1824. */
  1825. @property (nonatomic, strong) AWSCognitoIdentityProviderAdminCreateUserConfigType * _Nullable adminCreateUserConfig;
  1826. /**
  1827. <p>Attributes supported as an alias for this user pool. Possible values: <b>phone_number</b>, <b>email</b>, or <b>preferred_username</b>.</p>
  1828. */
  1829. @property (nonatomic, strong) NSArray<NSString *> * _Nullable aliasAttributes;
  1830. /**
  1831. <p>The attributes to be auto-verified. Possible values: <b>email</b>, <b>phone_number</b>.</p>
  1832. */
  1833. @property (nonatomic, strong) NSArray<NSString *> * _Nullable autoVerifiedAttributes;
  1834. /**
  1835. <p>The device configuration.</p>
  1836. */
  1837. @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceConfigurationType * _Nullable deviceConfiguration;
  1838. /**
  1839. <p>The email configuration.</p>
  1840. */
  1841. @property (nonatomic, strong) AWSCognitoIdentityProviderEmailConfigurationType * _Nullable emailConfiguration;
  1842. /**
  1843. <p>A string representing the email verification message.</p>
  1844. */
  1845. @property (nonatomic, strong) NSString * _Nullable emailVerificationMessage;
  1846. /**
  1847. <p>A string representing the email verification subject.</p>
  1848. */
  1849. @property (nonatomic, strong) NSString * _Nullable emailVerificationSubject;
  1850. /**
  1851. <p>The Lambda trigger configuration information for the new user pool.</p><note><p>In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.</p><p/><p>For more information on using the Lambda API to add permission, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html"> AddPermission </a>. </p><p>For adding permission using the AWS CLI, see <a href="https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html"> add-permission </a>.</p></note>
  1852. */
  1853. @property (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType * _Nullable lambdaConfig;
  1854. /**
  1855. <p>Specifies MFA configuration details.</p>
  1856. */
  1857. @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration;
  1858. /**
  1859. <p>The policies associated with the new user pool.</p>
  1860. */
  1861. @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolPolicyType * _Nullable policies;
  1862. /**
  1863. <p>A string used to name the user pool.</p>
  1864. */
  1865. @property (nonatomic, strong) NSString * _Nullable poolName;
  1866. /**
  1867. <p>An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.</p>
  1868. */
  1869. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderSchemaAttributeType *> * _Nullable schema;
  1870. /**
  1871. <p>A string representing the SMS authentication message.</p>
  1872. */
  1873. @property (nonatomic, strong) NSString * _Nullable smsAuthenticationMessage;
  1874. /**
  1875. <p>The SMS configuration.</p>
  1876. */
  1877. @property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType * _Nullable smsConfiguration;
  1878. /**
  1879. <p>A string representing the SMS verification message.</p>
  1880. */
  1881. @property (nonatomic, strong) NSString * _Nullable smsVerificationMessage;
  1882. /**
  1883. <p>Used to enable advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
  1884. */
  1885. @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolAddOnsType * _Nullable userPoolAddOns;
  1886. /**
  1887. <p>The cost allocation tags for the user pool. For more information, see <a href="http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-cost-allocation-tagging.html">Adding Cost Allocation Tags to Your User Pool</a></p>
  1888. */
  1889. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable userPoolTags;
  1890. /**
  1891. <p>Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.</p>
  1892. */
  1893. @property (nonatomic, strong) NSArray<NSString *> * _Nullable usernameAttributes;
  1894. /**
  1895. <p>The template for the verification message that the user sees when the app requests permission to access the user's information.</p>
  1896. */
  1897. @property (nonatomic, strong) AWSCognitoIdentityProviderVerificationMessageTemplateType * _Nullable verificationMessageTemplate;
  1898. @end
  1899. /**
  1900. <p>Represents the response from the server for the request to create a user pool.</p>
  1901. */
  1902. @interface AWSCognitoIdentityProviderCreateUserPoolResponse : AWSModel
  1903. /**
  1904. <p>A container for the user pool details.</p>
  1905. */
  1906. @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolType * _Nullable userPool;
  1907. @end
  1908. /**
  1909. <p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.</p>
  1910. Required parameters: [CertificateArn]
  1911. */
  1912. @interface AWSCognitoIdentityProviderCustomDomainConfigType : AWSModel
  1913. /**
  1914. <p>The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.</p>
  1915. */
  1916. @property (nonatomic, strong) NSString * _Nullable certificateArn;
  1917. @end
  1918. /**
  1919. */
  1920. @interface AWSCognitoIdentityProviderDeleteGroupRequest : AWSRequest
  1921. /**
  1922. <p>The name of the group.</p>
  1923. */
  1924. @property (nonatomic, strong) NSString * _Nullable groupName;
  1925. /**
  1926. <p>The user pool ID for the user pool.</p>
  1927. */
  1928. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1929. @end
  1930. /**
  1931. */
  1932. @interface AWSCognitoIdentityProviderDeleteIdentityProviderRequest : AWSRequest
  1933. /**
  1934. <p>The identity provider name.</p>
  1935. */
  1936. @property (nonatomic, strong) NSString * _Nullable providerName;
  1937. /**
  1938. <p>The user pool ID.</p>
  1939. */
  1940. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1941. @end
  1942. /**
  1943. */
  1944. @interface AWSCognitoIdentityProviderDeleteResourceServerRequest : AWSRequest
  1945. /**
  1946. <p>The identifier for the resource server.</p>
  1947. */
  1948. @property (nonatomic, strong) NSString * _Nullable identifier;
  1949. /**
  1950. <p>The user pool ID for the user pool that hosts the resource server.</p>
  1951. */
  1952. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1953. @end
  1954. /**
  1955. <p>Represents the request to delete user attributes.</p>
  1956. Required parameters: [UserAttributeNames, AccessToken]
  1957. */
  1958. @interface AWSCognitoIdentityProviderDeleteUserAttributesRequest : AWSRequest
  1959. /**
  1960. <p>The access token used in the request to delete user attributes.</p>
  1961. */
  1962. @property (nonatomic, strong) NSString * _Nullable accessToken;
  1963. /**
  1964. <p>An array of strings representing the user attribute names you wish to delete.</p><p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
  1965. */
  1966. @property (nonatomic, strong) NSArray<NSString *> * _Nullable userAttributeNames;
  1967. @end
  1968. /**
  1969. <p>Represents the response from the server to delete user attributes.</p>
  1970. */
  1971. @interface AWSCognitoIdentityProviderDeleteUserAttributesResponse : AWSModel
  1972. @end
  1973. /**
  1974. <p>Represents the request to delete a user pool client.</p>
  1975. Required parameters: [UserPoolId, ClientId]
  1976. */
  1977. @interface AWSCognitoIdentityProviderDeleteUserPoolClientRequest : AWSRequest
  1978. /**
  1979. <p>The app client ID of the app associated with the user pool.</p>
  1980. */
  1981. @property (nonatomic, strong) NSString * _Nullable clientId;
  1982. /**
  1983. <p>The user pool ID for the user pool where you want to delete the client.</p>
  1984. */
  1985. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1986. @end
  1987. /**
  1988. */
  1989. @interface AWSCognitoIdentityProviderDeleteUserPoolDomainRequest : AWSRequest
  1990. /**
  1991. <p>The domain string.</p>
  1992. */
  1993. @property (nonatomic, strong) NSString * _Nullable domain;
  1994. /**
  1995. <p>The user pool ID.</p>
  1996. */
  1997. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  1998. @end
  1999. /**
  2000. */
  2001. @interface AWSCognitoIdentityProviderDeleteUserPoolDomainResponse : AWSModel
  2002. @end
  2003. /**
  2004. <p>Represents the request to delete a user pool.</p>
  2005. Required parameters: [UserPoolId]
  2006. */
  2007. @interface AWSCognitoIdentityProviderDeleteUserPoolRequest : AWSRequest
  2008. /**
  2009. <p>The user pool ID for the user pool you want to delete.</p>
  2010. */
  2011. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2012. @end
  2013. /**
  2014. <p>Represents the request to delete a user.</p>
  2015. Required parameters: [AccessToken]
  2016. */
  2017. @interface AWSCognitoIdentityProviderDeleteUserRequest : AWSRequest
  2018. /**
  2019. <p>The access token from a request to delete a user.</p>
  2020. */
  2021. @property (nonatomic, strong) NSString * _Nullable accessToken;
  2022. @end
  2023. /**
  2024. */
  2025. @interface AWSCognitoIdentityProviderDescribeIdentityProviderRequest : AWSRequest
  2026. /**
  2027. <p>The identity provider name.</p>
  2028. */
  2029. @property (nonatomic, strong) NSString * _Nullable providerName;
  2030. /**
  2031. <p>The user pool ID.</p>
  2032. */
  2033. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2034. @end
  2035. /**
  2036. */
  2037. @interface AWSCognitoIdentityProviderDescribeIdentityProviderResponse : AWSModel
  2038. /**
  2039. <p>The identity provider that was deleted.</p>
  2040. */
  2041. @property (nonatomic, strong) AWSCognitoIdentityProviderIdentityProviderType * _Nullable identityProvider;
  2042. @end
  2043. /**
  2044. */
  2045. @interface AWSCognitoIdentityProviderDescribeResourceServerRequest : AWSRequest
  2046. /**
  2047. <p>The identifier for the resource server</p>
  2048. */
  2049. @property (nonatomic, strong) NSString * _Nullable identifier;
  2050. /**
  2051. <p>The user pool ID for the user pool that hosts the resource server.</p>
  2052. */
  2053. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2054. @end
  2055. /**
  2056. */
  2057. @interface AWSCognitoIdentityProviderDescribeResourceServerResponse : AWSModel
  2058. /**
  2059. <p>The resource server.</p>
  2060. */
  2061. @property (nonatomic, strong) AWSCognitoIdentityProviderResourceServerType * _Nullable resourceServer;
  2062. @end
  2063. /**
  2064. */
  2065. @interface AWSCognitoIdentityProviderDescribeRiskConfigurationRequest : AWSRequest
  2066. /**
  2067. <p>The app client ID.</p>
  2068. */
  2069. @property (nonatomic, strong) NSString * _Nullable clientId;
  2070. /**
  2071. <p>The user pool ID.</p>
  2072. */
  2073. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2074. @end
  2075. /**
  2076. */
  2077. @interface AWSCognitoIdentityProviderDescribeRiskConfigurationResponse : AWSModel
  2078. /**
  2079. <p>The risk configuration.</p>
  2080. */
  2081. @property (nonatomic, strong) AWSCognitoIdentityProviderRiskConfigurationType * _Nullable riskConfiguration;
  2082. @end
  2083. /**
  2084. <p>Represents the request to describe the user import job.</p>
  2085. Required parameters: [UserPoolId, JobId]
  2086. */
  2087. @interface AWSCognitoIdentityProviderDescribeUserImportJobRequest : AWSRequest
  2088. /**
  2089. <p>The job ID for the user import job.</p>
  2090. */
  2091. @property (nonatomic, strong) NSString * _Nullable jobId;
  2092. /**
  2093. <p>The user pool ID for the user pool that the users are being imported into.</p>
  2094. */
  2095. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2096. @end
  2097. /**
  2098. <p>Represents the response from the server to the request to describe the user import job.</p>
  2099. */
  2100. @interface AWSCognitoIdentityProviderDescribeUserImportJobResponse : AWSModel
  2101. /**
  2102. <p>The job object that represents the user import job.</p>
  2103. */
  2104. @property (nonatomic, strong) AWSCognitoIdentityProviderUserImportJobType * _Nullable userImportJob;
  2105. @end
  2106. /**
  2107. <p>Represents the request to describe a user pool client.</p>
  2108. Required parameters: [UserPoolId, ClientId]
  2109. */
  2110. @interface AWSCognitoIdentityProviderDescribeUserPoolClientRequest : AWSRequest
  2111. /**
  2112. <p>The app client ID of the app associated with the user pool.</p>
  2113. */
  2114. @property (nonatomic, strong) NSString * _Nullable clientId;
  2115. /**
  2116. <p>The user pool ID for the user pool you want to describe.</p>
  2117. */
  2118. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2119. @end
  2120. /**
  2121. <p>Represents the response from the server from a request to describe the user pool client.</p>
  2122. */
  2123. @interface AWSCognitoIdentityProviderDescribeUserPoolClientResponse : AWSModel
  2124. /**
  2125. <p>The user pool client from a server response to describe the user pool client.</p>
  2126. */
  2127. @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolClientType * _Nullable userPoolClient;
  2128. @end
  2129. /**
  2130. */
  2131. @interface AWSCognitoIdentityProviderDescribeUserPoolDomainRequest : AWSRequest
  2132. /**
  2133. <p>The domain string.</p>
  2134. */
  2135. @property (nonatomic, strong) NSString * _Nullable domain;
  2136. @end
  2137. /**
  2138. */
  2139. @interface AWSCognitoIdentityProviderDescribeUserPoolDomainResponse : AWSModel
  2140. /**
  2141. <p>A domain description object containing information about the domain.</p>
  2142. */
  2143. @property (nonatomic, strong) AWSCognitoIdentityProviderDomainDescriptionType * _Nullable domainDescription;
  2144. @end
  2145. /**
  2146. <p>Represents the request to describe the user pool.</p>
  2147. Required parameters: [UserPoolId]
  2148. */
  2149. @interface AWSCognitoIdentityProviderDescribeUserPoolRequest : AWSRequest
  2150. /**
  2151. <p>The user pool ID for the user pool you want to describe.</p>
  2152. */
  2153. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2154. @end
  2155. /**
  2156. <p>Represents the response to describe the user pool.</p>
  2157. */
  2158. @interface AWSCognitoIdentityProviderDescribeUserPoolResponse : AWSModel
  2159. /**
  2160. <p>The container of metadata returned by the server to describe the pool.</p>
  2161. */
  2162. @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolType * _Nullable userPool;
  2163. @end
  2164. /**
  2165. <p>The configuration for the user pool's device tracking.</p>
  2166. */
  2167. @interface AWSCognitoIdentityProviderDeviceConfigurationType : AWSModel
  2168. /**
  2169. <p>Indicates whether a challenge is required on a new device. Only applicable to a new device.</p>
  2170. */
  2171. @property (nonatomic, strong) NSNumber * _Nullable challengeRequiredOnNewDevice;
  2172. /**
  2173. <p>If true, a device is only remembered on user prompt.</p>
  2174. */
  2175. @property (nonatomic, strong) NSNumber * _Nullable deviceOnlyRememberedOnUserPrompt;
  2176. @end
  2177. /**
  2178. <p>The device verifier against which it will be authenticated.</p>
  2179. */
  2180. @interface AWSCognitoIdentityProviderDeviceSecretVerifierConfigType : AWSModel
  2181. /**
  2182. <p>The password verifier.</p>
  2183. */
  2184. @property (nonatomic, strong) NSString * _Nullable passwordVerifier;
  2185. /**
  2186. <p>The salt.</p>
  2187. */
  2188. @property (nonatomic, strong) NSString * _Nullable salt;
  2189. @end
  2190. /**
  2191. <p>The device type.</p>
  2192. */
  2193. @interface AWSCognitoIdentityProviderDeviceType : AWSModel
  2194. /**
  2195. <p>The device attributes.</p>
  2196. */
  2197. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType *> * _Nullable deviceAttributes;
  2198. /**
  2199. <p>The creation date of the device.</p>
  2200. */
  2201. @property (nonatomic, strong) NSDate * _Nullable deviceCreateDate;
  2202. /**
  2203. <p>The device key.</p>
  2204. */
  2205. @property (nonatomic, strong) NSString * _Nullable deviceKey;
  2206. /**
  2207. <p>The date in which the device was last authenticated.</p>
  2208. */
  2209. @property (nonatomic, strong) NSDate * _Nullable deviceLastAuthenticatedDate;
  2210. /**
  2211. <p>The last modified date of the device.</p>
  2212. */
  2213. @property (nonatomic, strong) NSDate * _Nullable deviceLastModifiedDate;
  2214. @end
  2215. /**
  2216. <p>A container for information about a domain.</p>
  2217. */
  2218. @interface AWSCognitoIdentityProviderDomainDescriptionType : AWSModel
  2219. /**
  2220. <p>The AWS account ID for the user pool owner.</p>
  2221. */
  2222. @property (nonatomic, strong) NSString * _Nullable AWSAccountId;
  2223. /**
  2224. <p>The ARN of the CloudFront distribution.</p>
  2225. */
  2226. @property (nonatomic, strong) NSString * _Nullable cloudFrontDistribution;
  2227. /**
  2228. <p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.</p>
  2229. */
  2230. @property (nonatomic, strong) AWSCognitoIdentityProviderCustomDomainConfigType * _Nullable customDomainConfig;
  2231. /**
  2232. <p>The domain string.</p>
  2233. */
  2234. @property (nonatomic, strong) NSString * _Nullable domain;
  2235. /**
  2236. <p>The S3 bucket where the static files for this domain are stored.</p>
  2237. */
  2238. @property (nonatomic, strong) NSString * _Nullable s3Bucket;
  2239. /**
  2240. <p>The domain status.</p>
  2241. */
  2242. @property (nonatomic, assign) AWSCognitoIdentityProviderDomainStatusType status;
  2243. /**
  2244. <p>The user pool ID.</p>
  2245. */
  2246. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2247. /**
  2248. <p>The app version.</p>
  2249. */
  2250. @property (nonatomic, strong) NSString * _Nullable version;
  2251. @end
  2252. /**
  2253. <p>The email configuration type.</p>
  2254. */
  2255. @interface AWSCognitoIdentityProviderEmailConfigurationType : AWSModel
  2256. /**
  2257. <p>The destination to which the receiver of the email should reply to.</p>
  2258. */
  2259. @property (nonatomic, strong) NSString * _Nullable replyToEmailAddress;
  2260. /**
  2261. <p>The Amazon Resource Name (ARN) of the email source.</p>
  2262. */
  2263. @property (nonatomic, strong) NSString * _Nullable sourceArn;
  2264. @end
  2265. /**
  2266. <p>Specifies the user context data captured at the time of an event request.</p>
  2267. */
  2268. @interface AWSCognitoIdentityProviderEventContextDataType : AWSModel
  2269. /**
  2270. <p>The user's city.</p>
  2271. */
  2272. @property (nonatomic, strong) NSString * _Nullable city;
  2273. /**
  2274. <p>The user's country.</p>
  2275. */
  2276. @property (nonatomic, strong) NSString * _Nullable country;
  2277. /**
  2278. <p>The user's device name.</p>
  2279. */
  2280. @property (nonatomic, strong) NSString * _Nullable deviceName;
  2281. /**
  2282. <p>The user's IP address.</p>
  2283. */
  2284. @property (nonatomic, strong) NSString * _Nullable ipAddress;
  2285. /**
  2286. <p>The user's time zone.</p>
  2287. */
  2288. @property (nonatomic, strong) NSString * _Nullable timezone;
  2289. @end
  2290. /**
  2291. <p>Specifies the event feedback type.</p>
  2292. Required parameters: [FeedbackValue, Provider]
  2293. */
  2294. @interface AWSCognitoIdentityProviderEventFeedbackType : AWSModel
  2295. /**
  2296. <p>The event feedback date.</p>
  2297. */
  2298. @property (nonatomic, strong) NSDate * _Nullable feedbackDate;
  2299. /**
  2300. <p>The event feedback value.</p>
  2301. */
  2302. @property (nonatomic, assign) AWSCognitoIdentityProviderFeedbackValueType feedbackValue;
  2303. /**
  2304. <p>The provider.</p>
  2305. */
  2306. @property (nonatomic, strong) NSString * _Nullable provider;
  2307. @end
  2308. /**
  2309. <p>The event risk type.</p>
  2310. */
  2311. @interface AWSCognitoIdentityProviderEventRiskType : AWSModel
  2312. /**
  2313. <p>The risk decision.</p>
  2314. */
  2315. @property (nonatomic, assign) AWSCognitoIdentityProviderRiskDecisionType riskDecision;
  2316. /**
  2317. <p>The risk level.</p>
  2318. */
  2319. @property (nonatomic, assign) AWSCognitoIdentityProviderRiskLevelType riskLevel;
  2320. @end
  2321. /**
  2322. <p>Represents the request to forget the device.</p>
  2323. Required parameters: [DeviceKey]
  2324. */
  2325. @interface AWSCognitoIdentityProviderForgetDeviceRequest : AWSRequest
  2326. /**
  2327. <p>The access token for the forgotten device request.</p>
  2328. */
  2329. @property (nonatomic, strong) NSString * _Nullable accessToken;
  2330. /**
  2331. <p>The device key.</p>
  2332. */
  2333. @property (nonatomic, strong) NSString * _Nullable deviceKey;
  2334. @end
  2335. /**
  2336. <p>Represents the request to reset a user's password.</p>
  2337. Required parameters: [ClientId, Username]
  2338. */
  2339. @interface AWSCognitoIdentityProviderForgotPasswordRequest : AWSRequest
  2340. /**
  2341. <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ForgotPassword</code> calls.</p>
  2342. */
  2343. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata;
  2344. /**
  2345. <p>The ID of the client associated with the user pool.</p>
  2346. */
  2347. @property (nonatomic, strong) NSString * _Nullable clientId;
  2348. /**
  2349. <p>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.</p>
  2350. */
  2351. @property (nonatomic, strong) NSString * _Nullable secretHash;
  2352. /**
  2353. <p>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.</p>
  2354. */
  2355. @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData;
  2356. /**
  2357. <p>The user name of the user for whom you want to enter a code to reset a forgotten password.</p>
  2358. */
  2359. @property (nonatomic, strong) NSString * _Nullable username;
  2360. @end
  2361. /**
  2362. <p>Respresents the response from the server regarding the request to reset a password.</p>
  2363. */
  2364. @interface AWSCognitoIdentityProviderForgotPasswordResponse : AWSModel
  2365. /**
  2366. <p>The code delivery details returned by the server in response to the request to reset a password.</p>
  2367. */
  2368. @property (nonatomic, strong) AWSCognitoIdentityProviderCodeDeliveryDetailsType * _Nullable codeDeliveryDetails;
  2369. @end
  2370. /**
  2371. <p>Represents the request to get the header information for the .csv file for the user import job.</p>
  2372. Required parameters: [UserPoolId]
  2373. */
  2374. @interface AWSCognitoIdentityProviderGetCSVHeaderRequest : AWSRequest
  2375. /**
  2376. <p>The user pool ID for the user pool that the users are to be imported into.</p>
  2377. */
  2378. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2379. @end
  2380. /**
  2381. <p>Represents the response from the server to the request to get the header information for the .csv file for the user import job.</p>
  2382. */
  2383. @interface AWSCognitoIdentityProviderGetCSVHeaderResponse : AWSModel
  2384. /**
  2385. <p>The header information for the .csv file for the user import job.</p>
  2386. */
  2387. @property (nonatomic, strong) NSArray<NSString *> * _Nullable CSVHeader;
  2388. /**
  2389. <p>The user pool ID for the user pool that the users are to be imported into.</p>
  2390. */
  2391. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2392. @end
  2393. /**
  2394. <p>Represents the request to get the device.</p>
  2395. Required parameters: [DeviceKey]
  2396. */
  2397. @interface AWSCognitoIdentityProviderGetDeviceRequest : AWSRequest
  2398. /**
  2399. <p>The access token.</p>
  2400. */
  2401. @property (nonatomic, strong) NSString * _Nullable accessToken;
  2402. /**
  2403. <p>The device key.</p>
  2404. */
  2405. @property (nonatomic, strong) NSString * _Nullable deviceKey;
  2406. @end
  2407. /**
  2408. <p>Gets the device response.</p>
  2409. Required parameters: [Device]
  2410. */
  2411. @interface AWSCognitoIdentityProviderGetDeviceResponse : AWSModel
  2412. /**
  2413. <p>The device.</p>
  2414. */
  2415. @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceType * _Nullable device;
  2416. @end
  2417. /**
  2418. */
  2419. @interface AWSCognitoIdentityProviderGetGroupRequest : AWSRequest
  2420. /**
  2421. <p>The name of the group.</p>
  2422. */
  2423. @property (nonatomic, strong) NSString * _Nullable groupName;
  2424. /**
  2425. <p>The user pool ID for the user pool.</p>
  2426. */
  2427. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2428. @end
  2429. /**
  2430. */
  2431. @interface AWSCognitoIdentityProviderGetGroupResponse : AWSModel
  2432. /**
  2433. <p>The group object for the group.</p>
  2434. */
  2435. @property (nonatomic, strong) AWSCognitoIdentityProviderGroupType * _Nullable group;
  2436. @end
  2437. /**
  2438. */
  2439. @interface AWSCognitoIdentityProviderGetIdentityProviderByIdentifierRequest : AWSRequest
  2440. /**
  2441. <p>The identity provider ID.</p>
  2442. */
  2443. @property (nonatomic, strong) NSString * _Nullable idpIdentifier;
  2444. /**
  2445. <p>The user pool ID.</p>
  2446. */
  2447. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2448. @end
  2449. /**
  2450. */
  2451. @interface AWSCognitoIdentityProviderGetIdentityProviderByIdentifierResponse : AWSModel
  2452. /**
  2453. <p>The identity provider object.</p>
  2454. */
  2455. @property (nonatomic, strong) AWSCognitoIdentityProviderIdentityProviderType * _Nullable identityProvider;
  2456. @end
  2457. /**
  2458. <p>Request to get a signing certificate from Cognito.</p>
  2459. Required parameters: [UserPoolId]
  2460. */
  2461. @interface AWSCognitoIdentityProviderGetSigningCertificateRequest : AWSRequest
  2462. /**
  2463. <p>The user pool ID.</p>
  2464. */
  2465. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2466. @end
  2467. /**
  2468. <p>Response from Cognito for a signing certificate request.</p>
  2469. */
  2470. @interface AWSCognitoIdentityProviderGetSigningCertificateResponse : AWSModel
  2471. /**
  2472. <p>The signing certificate.</p>
  2473. */
  2474. @property (nonatomic, strong) NSString * _Nullable certificate;
  2475. @end
  2476. /**
  2477. */
  2478. @interface AWSCognitoIdentityProviderGetUICustomizationRequest : AWSRequest
  2479. /**
  2480. <p>The client ID for the client app.</p>
  2481. */
  2482. @property (nonatomic, strong) NSString * _Nullable clientId;
  2483. /**
  2484. <p>The user pool ID for the user pool.</p>
  2485. */
  2486. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2487. @end
  2488. /**
  2489. */
  2490. @interface AWSCognitoIdentityProviderGetUICustomizationResponse : AWSModel
  2491. /**
  2492. <p>The UI customization information.</p>
  2493. */
  2494. @property (nonatomic, strong) AWSCognitoIdentityProviderUICustomizationType * _Nullable UICustomization;
  2495. @end
  2496. /**
  2497. <p>Represents the request to get user attribute verification.</p>
  2498. Required parameters: [AccessToken, AttributeName]
  2499. */
  2500. @interface AWSCognitoIdentityProviderGetUserAttributeVerificationCodeRequest : AWSRequest
  2501. /**
  2502. <p>The access token returned by the server response to get the user attribute verification code.</p>
  2503. */
  2504. @property (nonatomic, strong) NSString * _Nullable accessToken;
  2505. /**
  2506. <p>The attribute name returned by the server response to get the user attribute verification code.</p>
  2507. */
  2508. @property (nonatomic, strong) NSString * _Nullable attributeName;
  2509. @end
  2510. /**
  2511. <p>The verification code response returned by the server response to get the user attribute verification code.</p>
  2512. */
  2513. @interface AWSCognitoIdentityProviderGetUserAttributeVerificationCodeResponse : AWSModel
  2514. /**
  2515. <p>The code delivery details returned by the server in response to the request to get the user attribute verification code.</p>
  2516. */
  2517. @property (nonatomic, strong) AWSCognitoIdentityProviderCodeDeliveryDetailsType * _Nullable codeDeliveryDetails;
  2518. @end
  2519. /**
  2520. */
  2521. @interface AWSCognitoIdentityProviderGetUserPoolMfaConfigRequest : AWSRequest
  2522. /**
  2523. <p>The user pool ID.</p>
  2524. */
  2525. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2526. @end
  2527. /**
  2528. */
  2529. @interface AWSCognitoIdentityProviderGetUserPoolMfaConfigResponse : AWSModel
  2530. /**
  2531. <p>The multi-factor (MFA) configuration.</p>
  2532. */
  2533. @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration;
  2534. /**
  2535. <p>The SMS text message multi-factor (MFA) configuration.</p>
  2536. */
  2537. @property (nonatomic, strong) AWSCognitoIdentityProviderSmsMfaConfigType * _Nullable smsMfaConfiguration;
  2538. /**
  2539. <p>The software token multi-factor (MFA) configuration.</p>
  2540. */
  2541. @property (nonatomic, strong) AWSCognitoIdentityProviderSoftwareTokenMfaConfigType * _Nullable softwareTokenMfaConfiguration;
  2542. @end
  2543. /**
  2544. <p>Represents the request to get information about the user.</p>
  2545. Required parameters: [AccessToken]
  2546. */
  2547. @interface AWSCognitoIdentityProviderGetUserRequest : AWSRequest
  2548. /**
  2549. <p>The access token returned by the server response to get information about the user.</p>
  2550. */
  2551. @property (nonatomic, strong) NSString * _Nullable accessToken;
  2552. @end
  2553. /**
  2554. <p>Represents the response from the server from the request to get information about the user.</p>
  2555. Required parameters: [Username, UserAttributes]
  2556. */
  2557. @interface AWSCognitoIdentityProviderGetUserResponse : AWSModel
  2558. /**
  2559. <p>Specifies the options for MFA (e.g., email or phone number).</p>
  2560. */
  2561. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderMFAOptionType *> * _Nullable MFAOptions;
  2562. /**
  2563. <p>The user's preferred MFA setting.</p>
  2564. */
  2565. @property (nonatomic, strong) NSString * _Nullable preferredMfaSetting;
  2566. /**
  2567. <p>An array of name-value pairs representing user attributes.</p><p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
  2568. */
  2569. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType *> * _Nullable userAttributes;
  2570. /**
  2571. <p>The list of the user's MFA settings.</p>
  2572. */
  2573. @property (nonatomic, strong) NSArray<NSString *> * _Nullable userMFASettingList;
  2574. /**
  2575. <p>The user name of the user you wish to retrieve from the get user request.</p>
  2576. */
  2577. @property (nonatomic, strong) NSString * _Nullable username;
  2578. @end
  2579. /**
  2580. <p>Represents the request to sign out all devices.</p>
  2581. Required parameters: [AccessToken]
  2582. */
  2583. @interface AWSCognitoIdentityProviderGlobalSignOutRequest : AWSRequest
  2584. /**
  2585. <p>The access token.</p>
  2586. */
  2587. @property (nonatomic, strong) NSString * _Nullable accessToken;
  2588. @end
  2589. /**
  2590. <p>The response to the request to sign out all devices.</p>
  2591. */
  2592. @interface AWSCognitoIdentityProviderGlobalSignOutResponse : AWSModel
  2593. @end
  2594. /**
  2595. <p>The group type.</p>
  2596. */
  2597. @interface AWSCognitoIdentityProviderGroupType : AWSModel
  2598. /**
  2599. <p>The date the group was created.</p>
  2600. */
  2601. @property (nonatomic, strong) NSDate * _Nullable creationDate;
  2602. /**
  2603. <p>A string containing the description of the group.</p>
  2604. */
  2605. @property (nonatomic, strong) NSString * _Nullable detail;
  2606. /**
  2607. <p>The name of the group.</p>
  2608. */
  2609. @property (nonatomic, strong) NSString * _Nullable groupName;
  2610. /**
  2611. <p>The date the group was last modified.</p>
  2612. */
  2613. @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate;
  2614. /**
  2615. <p>A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims in the user's tokens. Groups with higher <code>Precedence</code> values take precedence over groups with lower <code>Precedence</code> values or with null <code>Precedence</code> values.</p><p>Two groups can have the same <code>Precedence</code> value. If this happens, neither group takes precedence over the other. If two groups with the same <code>Precedence</code> have the same role ARN, that role is used in the <code>cognito:preferred_role</code> claim in tokens for users in each group. If the two groups have different role ARNs, the <code>cognito:preferred_role</code> claim is not set in users' tokens.</p><p>The default <code>Precedence</code> value is null.</p>
  2616. */
  2617. @property (nonatomic, strong) NSNumber * _Nullable precedence;
  2618. /**
  2619. <p>The role ARN for the group.</p>
  2620. */
  2621. @property (nonatomic, strong) NSString * _Nullable roleArn;
  2622. /**
  2623. <p>The user pool ID for the user pool.</p>
  2624. */
  2625. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2626. @end
  2627. /**
  2628. <p>The HTTP header.</p>
  2629. */
  2630. @interface AWSCognitoIdentityProviderHttpHeader : AWSModel
  2631. /**
  2632. <p>The header name</p>
  2633. */
  2634. @property (nonatomic, strong) NSString * _Nullable headerName;
  2635. /**
  2636. <p>The header value.</p>
  2637. */
  2638. @property (nonatomic, strong) NSString * _Nullable headerValue;
  2639. @end
  2640. /**
  2641. <p>A container for information about an identity provider.</p>
  2642. */
  2643. @interface AWSCognitoIdentityProviderIdentityProviderType : AWSModel
  2644. /**
  2645. <p>A mapping of identity provider attributes to standard and custom user pool attributes.</p>
  2646. */
  2647. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable attributeMapping;
  2648. /**
  2649. <p>The date the identity provider was created.</p>
  2650. */
  2651. @property (nonatomic, strong) NSDate * _Nullable creationDate;
  2652. /**
  2653. <p>A list of identity provider identifiers.</p>
  2654. */
  2655. @property (nonatomic, strong) NSArray<NSString *> * _Nullable idpIdentifiers;
  2656. /**
  2657. <p>The date the identity provider was last modified.</p>
  2658. */
  2659. @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate;
  2660. /**
  2661. <p>The identity provider details, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>
  2662. */
  2663. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable providerDetails;
  2664. /**
  2665. <p>The identity provider name.</p>
  2666. */
  2667. @property (nonatomic, strong) NSString * _Nullable providerName;
  2668. /**
  2669. <p>The identity provider type.</p>
  2670. */
  2671. @property (nonatomic, assign) AWSCognitoIdentityProviderIdentityProviderTypeType providerType;
  2672. /**
  2673. <p>The user pool ID.</p>
  2674. */
  2675. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2676. @end
  2677. /**
  2678. <p>Initiates the authentication request.</p>
  2679. Required parameters: [AuthFlow, ClientId]
  2680. */
  2681. @interface AWSCognitoIdentityProviderInitiateAuthRequest : AWSRequest
  2682. /**
  2683. <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>InitiateAuth</code> calls.</p>
  2684. */
  2685. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata;
  2686. /**
  2687. <p>The authentication flow for this call to execute. The API action will depend on this value. For example: </p><ul><li><p><code>REFRESH_TOKEN_AUTH</code> will take in a valid refresh token and return new tokens.</p></li><li><p><code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and <code>SRP_A</code> and return the SRP variables to be used for next challenge execution.</p></li><li><p><code>USER_PASSWORD_AUTH</code> will take in <code>USERNAME</code> and <code>PASSWORD</code> and return the next challenge or tokens.</p></li></ul><p>Valid values include:</p><ul><li><p><code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password (SRP) protocol.</p></li><li><p><code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.</p></li><li><p><code>CUSTOM_AUTH</code>: Custom authentication flow.</p></li><li><p><code>USER_PASSWORD_AUTH</code>: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool. </p></li></ul><p><code>ADMIN_NO_SRP_AUTH</code> is not a valid value.</p>
  2688. */
  2689. @property (nonatomic, assign) AWSCognitoIdentityProviderAuthFlowType authFlow;
  2690. /**
  2691. <p>The authentication parameters. These are inputs corresponding to the <code>AuthFlow</code> that you are invoking. The required values depend on the value of <code>AuthFlow</code>:</p><ul><li><p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SRP_A</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code></p></li><li><p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code></p></li><li><p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>DEVICE_KEY</code></p></li></ul>
  2692. */
  2693. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable authParameters;
  2694. /**
  2695. <p>The app client ID.</p>
  2696. */
  2697. @property (nonatomic, strong) NSString * _Nullable clientId;
  2698. /**
  2699. <p>This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.</p>
  2700. */
  2701. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable clientMetadata;
  2702. /**
  2703. <p>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.</p>
  2704. */
  2705. @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData;
  2706. @end
  2707. /**
  2708. <p>Initiates the authentication response.</p>
  2709. */
  2710. @interface AWSCognitoIdentityProviderInitiateAuthResponse : AWSModel
  2711. /**
  2712. <p>The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, <code>ChallengeName</code>, <code>ChallengeParameters</code>, and <code>Session</code> are returned.</p>
  2713. */
  2714. @property (nonatomic, strong) AWSCognitoIdentityProviderAuthenticationResultType * _Nullable authenticationResult;
  2715. /**
  2716. <p>The name of the challenge which you are responding to with this call. This is returned to you in the <code>AdminInitiateAuth</code> response if you need to pass another challenge.</p><p>Valid values include the following. Note that all of these challenges require <code>USERNAME</code> and <code>SECRET_HASH</code> (if applicable) in the parameters.</p><ul><li><p><code>SMS_MFA</code>: Next challenge is to supply an <code>SMS_MFA_CODE</code>, delivered via SMS.</p></li><li><p><code>PASSWORD_VERIFIER</code>: Next challenge is to supply <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after the client-side SRP calculations.</p></li><li><p><code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.</p></li><li><p><code>DEVICE_SRP_AUTH</code>: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.</p></li><li><p><code>DEVICE_PASSWORD_VERIFIER</code>: Similar to <code>PASSWORD_VERIFIER</code>, but for devices only.</p></li><li><p><code>NEW_PASSWORD_REQUIRED</code>: For users which are required to change their passwords after successful first login. This challenge should be passed with <code>NEW_PASSWORD</code> and any other required attributes.</p></li></ul>
  2717. */
  2718. @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName;
  2719. /**
  2720. <p>The challenge parameters. These are returned to you in the <code>InitiateAuth</code> response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (<code>RespondToAuthChallenge</code>). </p><p>All challenges require <code>USERNAME</code> and <code>SECRET_HASH</code> (if applicable).</p>
  2721. */
  2722. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable challengeParameters;
  2723. /**
  2724. <p>The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
  2725. */
  2726. @property (nonatomic, strong) NSString * _Nullable session;
  2727. @end
  2728. /**
  2729. <p>Specifies the configuration for AWS Lambda triggers.</p>
  2730. */
  2731. @interface AWSCognitoIdentityProviderLambdaConfigType : AWSModel
  2732. /**
  2733. <p>Creates an authentication challenge.</p>
  2734. */
  2735. @property (nonatomic, strong) NSString * _Nullable createAuthChallenge;
  2736. /**
  2737. <p>A custom Message AWS Lambda trigger.</p>
  2738. */
  2739. @property (nonatomic, strong) NSString * _Nullable customMessage;
  2740. /**
  2741. <p>Defines the authentication challenge.</p>
  2742. */
  2743. @property (nonatomic, strong) NSString * _Nullable defineAuthChallenge;
  2744. /**
  2745. <p>A post-authentication AWS Lambda trigger.</p>
  2746. */
  2747. @property (nonatomic, strong) NSString * _Nullable postAuthentication;
  2748. /**
  2749. <p>A post-confirmation AWS Lambda trigger.</p>
  2750. */
  2751. @property (nonatomic, strong) NSString * _Nullable postConfirmation;
  2752. /**
  2753. <p>A pre-authentication AWS Lambda trigger.</p>
  2754. */
  2755. @property (nonatomic, strong) NSString * _Nullable preAuthentication;
  2756. /**
  2757. <p>A pre-registration AWS Lambda trigger.</p>
  2758. */
  2759. @property (nonatomic, strong) NSString * _Nullable preSignUp;
  2760. /**
  2761. <p>A Lambda trigger that is invoked before token generation.</p>
  2762. */
  2763. @property (nonatomic, strong) NSString * _Nullable preTokenGeneration;
  2764. /**
  2765. <p>The user migration Lambda config type.</p>
  2766. */
  2767. @property (nonatomic, strong) NSString * _Nullable userMigration;
  2768. /**
  2769. <p>Verifies the authentication challenge response.</p>
  2770. */
  2771. @property (nonatomic, strong) NSString * _Nullable verifyAuthChallengeResponse;
  2772. @end
  2773. /**
  2774. <p>Represents the request to list the devices.</p>
  2775. Required parameters: [AccessToken]
  2776. */
  2777. @interface AWSCognitoIdentityProviderListDevicesRequest : AWSRequest
  2778. /**
  2779. <p>The access tokens for the request to list devices.</p>
  2780. */
  2781. @property (nonatomic, strong) NSString * _Nullable accessToken;
  2782. /**
  2783. <p>The limit of the device request.</p>
  2784. */
  2785. @property (nonatomic, strong) NSNumber * _Nullable limit;
  2786. /**
  2787. <p>The pagination token for the list request.</p>
  2788. */
  2789. @property (nonatomic, strong) NSString * _Nullable paginationToken;
  2790. @end
  2791. /**
  2792. <p>Represents the response to list devices.</p>
  2793. */
  2794. @interface AWSCognitoIdentityProviderListDevicesResponse : AWSModel
  2795. /**
  2796. <p>The devices returned in the list devices response.</p>
  2797. */
  2798. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderDeviceType *> * _Nullable devices;
  2799. /**
  2800. <p>The pagination token for the list device response.</p>
  2801. */
  2802. @property (nonatomic, strong) NSString * _Nullable paginationToken;
  2803. @end
  2804. /**
  2805. */
  2806. @interface AWSCognitoIdentityProviderListGroupsRequest : AWSRequest
  2807. /**
  2808. <p>The limit of the request to list groups.</p>
  2809. */
  2810. @property (nonatomic, strong) NSNumber * _Nullable limit;
  2811. /**
  2812. <p>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.</p>
  2813. */
  2814. @property (nonatomic, strong) NSString * _Nullable nextToken;
  2815. /**
  2816. <p>The user pool ID for the user pool.</p>
  2817. */
  2818. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2819. @end
  2820. /**
  2821. */
  2822. @interface AWSCognitoIdentityProviderListGroupsResponse : AWSModel
  2823. /**
  2824. <p>The group objects for the groups.</p>
  2825. */
  2826. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderGroupType *> * _Nullable groups;
  2827. /**
  2828. <p>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.</p>
  2829. */
  2830. @property (nonatomic, strong) NSString * _Nullable nextToken;
  2831. @end
  2832. /**
  2833. */
  2834. @interface AWSCognitoIdentityProviderListIdentityProvidersRequest : AWSRequest
  2835. /**
  2836. <p>The maximum number of identity providers to return.</p>
  2837. */
  2838. @property (nonatomic, strong) NSNumber * _Nullable maxResults;
  2839. /**
  2840. <p>A pagination token.</p>
  2841. */
  2842. @property (nonatomic, strong) NSString * _Nullable nextToken;
  2843. /**
  2844. <p>The user pool ID.</p>
  2845. */
  2846. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2847. @end
  2848. /**
  2849. */
  2850. @interface AWSCognitoIdentityProviderListIdentityProvidersResponse : AWSModel
  2851. /**
  2852. <p>A pagination token.</p>
  2853. */
  2854. @property (nonatomic, strong) NSString * _Nullable nextToken;
  2855. /**
  2856. <p>A list of identity provider objects.</p>
  2857. */
  2858. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderProviderDescription *> * _Nullable providers;
  2859. @end
  2860. /**
  2861. */
  2862. @interface AWSCognitoIdentityProviderListResourceServersRequest : AWSRequest
  2863. /**
  2864. <p>The maximum number of resource servers to return.</p>
  2865. */
  2866. @property (nonatomic, strong) NSNumber * _Nullable maxResults;
  2867. /**
  2868. <p>A pagination token.</p>
  2869. */
  2870. @property (nonatomic, strong) NSString * _Nullable nextToken;
  2871. /**
  2872. <p>The user pool ID for the user pool.</p>
  2873. */
  2874. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2875. @end
  2876. /**
  2877. */
  2878. @interface AWSCognitoIdentityProviderListResourceServersResponse : AWSModel
  2879. /**
  2880. <p>A pagination token.</p>
  2881. */
  2882. @property (nonatomic, strong) NSString * _Nullable nextToken;
  2883. /**
  2884. <p>The resource servers.</p>
  2885. */
  2886. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderResourceServerType *> * _Nullable resourceServers;
  2887. @end
  2888. /**
  2889. <p>Represents the request to list the user import jobs.</p>
  2890. Required parameters: [UserPoolId, MaxResults]
  2891. */
  2892. @interface AWSCognitoIdentityProviderListUserImportJobsRequest : AWSRequest
  2893. /**
  2894. <p>The maximum number of import jobs you want the request to return.</p>
  2895. */
  2896. @property (nonatomic, strong) NSNumber * _Nullable maxResults;
  2897. /**
  2898. <p>An identifier that was returned from the previous call to <code>ListUserImportJobs</code>, which can be used to return the next set of import jobs in the list.</p>
  2899. */
  2900. @property (nonatomic, strong) NSString * _Nullable paginationToken;
  2901. /**
  2902. <p>The user pool ID for the user pool that the users are being imported into.</p>
  2903. */
  2904. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2905. @end
  2906. /**
  2907. <p>Represents the response from the server to the request to list the user import jobs.</p>
  2908. */
  2909. @interface AWSCognitoIdentityProviderListUserImportJobsResponse : AWSModel
  2910. /**
  2911. <p>An identifier that can be used to return the next set of user import jobs in the list.</p>
  2912. */
  2913. @property (nonatomic, strong) NSString * _Nullable paginationToken;
  2914. /**
  2915. <p>The user import jobs.</p>
  2916. */
  2917. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderUserImportJobType *> * _Nullable userImportJobs;
  2918. @end
  2919. /**
  2920. <p>Represents the request to list the user pool clients.</p>
  2921. Required parameters: [UserPoolId]
  2922. */
  2923. @interface AWSCognitoIdentityProviderListUserPoolClientsRequest : AWSRequest
  2924. /**
  2925. <p>The maximum number of results you want the request to return when listing the user pool clients.</p>
  2926. */
  2927. @property (nonatomic, strong) NSNumber * _Nullable maxResults;
  2928. /**
  2929. <p>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.</p>
  2930. */
  2931. @property (nonatomic, strong) NSString * _Nullable nextToken;
  2932. /**
  2933. <p>The user pool ID for the user pool where you want to list user pool clients.</p>
  2934. */
  2935. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2936. @end
  2937. /**
  2938. <p>Represents the response from the server that lists user pool clients.</p>
  2939. */
  2940. @interface AWSCognitoIdentityProviderListUserPoolClientsResponse : AWSModel
  2941. /**
  2942. <p>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.</p>
  2943. */
  2944. @property (nonatomic, strong) NSString * _Nullable nextToken;
  2945. /**
  2946. <p>The user pool clients in the response that lists user pool clients.</p>
  2947. */
  2948. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderUserPoolClientDescription *> * _Nullable userPoolClients;
  2949. @end
  2950. /**
  2951. <p>Represents the request to list user pools.</p>
  2952. Required parameters: [MaxResults]
  2953. */
  2954. @interface AWSCognitoIdentityProviderListUserPoolsRequest : AWSRequest
  2955. /**
  2956. <p>The maximum number of results you want the request to return when listing the user pools.</p>
  2957. */
  2958. @property (nonatomic, strong) NSNumber * _Nullable maxResults;
  2959. /**
  2960. <p>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.</p>
  2961. */
  2962. @property (nonatomic, strong) NSString * _Nullable nextToken;
  2963. @end
  2964. /**
  2965. <p>Represents the response to list user pools.</p>
  2966. */
  2967. @interface AWSCognitoIdentityProviderListUserPoolsResponse : AWSModel
  2968. /**
  2969. <p>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.</p>
  2970. */
  2971. @property (nonatomic, strong) NSString * _Nullable nextToken;
  2972. /**
  2973. <p>The user pools from the response to list users.</p>
  2974. */
  2975. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderUserPoolDescriptionType *> * _Nullable userPools;
  2976. @end
  2977. /**
  2978. */
  2979. @interface AWSCognitoIdentityProviderListUsersInGroupRequest : AWSRequest
  2980. /**
  2981. <p>The name of the group.</p>
  2982. */
  2983. @property (nonatomic, strong) NSString * _Nullable groupName;
  2984. /**
  2985. <p>The limit of the request to list users.</p>
  2986. */
  2987. @property (nonatomic, strong) NSNumber * _Nullable limit;
  2988. /**
  2989. <p>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.</p>
  2990. */
  2991. @property (nonatomic, strong) NSString * _Nullable nextToken;
  2992. /**
  2993. <p>The user pool ID for the user pool.</p>
  2994. */
  2995. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  2996. @end
  2997. /**
  2998. */
  2999. @interface AWSCognitoIdentityProviderListUsersInGroupResponse : AWSModel
  3000. /**
  3001. <p>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.</p>
  3002. */
  3003. @property (nonatomic, strong) NSString * _Nullable nextToken;
  3004. /**
  3005. <p>The users returned in the request to list users.</p>
  3006. */
  3007. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderUserType *> * _Nullable users;
  3008. @end
  3009. /**
  3010. <p>Represents the request to list users.</p>
  3011. Required parameters: [UserPoolId]
  3012. */
  3013. @interface AWSCognitoIdentityProviderListUsersRequest : AWSRequest
  3014. /**
  3015. <p>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.</p>
  3016. */
  3017. @property (nonatomic, strong) NSArray<NSString *> * _Nullable attributesToGet;
  3018. /**
  3019. <p>A filter string of the form "<i>AttributeName</i><i>Filter-Type</i> "<i>AttributeValue</i>"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "<code>family_name</code> = \"Reddy\"".</p><ul><li><p><i>AttributeName</i>: The name of the attribute to search for. You can only search for one attribute at a time.</p></li><li><p><i>Filter-Type</i>: For an exact match, use =, for example, "<code>given_name</code> = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "<code>given_name</code> ^= \"Jon\"". </p></li><li><p><i>AttributeValue</i>: The attribute value that must be matched for each user.</p></li></ul><p>If the filter string is empty, <code>ListUsers</code> returns all users in the user pool.</p><p>You can only search for the following standard attributes:</p><ul><li><p><code>username</code> (case-sensitive)</p></li><li><p><code>email</code></p></li><li><p><code>phone_number</code></p></li><li><p><code>name</code></p></li><li><p><code>given_name</code></p></li><li><p><code>family_name</code></p></li><li><p><code>preferred_username</code></p></li><li><p><code>cognito:user_status</code> (called <b>Status</b> in the Console) (case-insensitive)</p></li><li><p><code>status (called <b>Enabled</b> in the Console) (case-sensitive)</code></p></li><li><p><code>sub</code></p></li></ul><p>Custom attributes are not searchable.</p><p>For more information, see <a href="http://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api">Searching for Users Using the ListUsers API</a> and <a href="http://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples">Examples of Using the ListUsers API</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
  3020. */
  3021. @property (nonatomic, strong) NSString * _Nullable filter;
  3022. /**
  3023. <p>Maximum number of users to be returned.</p>
  3024. */
  3025. @property (nonatomic, strong) NSNumber * _Nullable limit;
  3026. /**
  3027. <p>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.</p>
  3028. */
  3029. @property (nonatomic, strong) NSString * _Nullable paginationToken;
  3030. /**
  3031. <p>The user pool ID for the user pool on which the search should be performed.</p>
  3032. */
  3033. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3034. @end
  3035. /**
  3036. <p>The response from the request to list users.</p>
  3037. */
  3038. @interface AWSCognitoIdentityProviderListUsersResponse : AWSModel
  3039. /**
  3040. <p>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.</p>
  3041. */
  3042. @property (nonatomic, strong) NSString * _Nullable paginationToken;
  3043. /**
  3044. <p>The users returned in the request to list users.</p>
  3045. */
  3046. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderUserType *> * _Nullable users;
  3047. @end
  3048. /**
  3049. <p>Specifies the different settings for multi-factor authentication (MFA).</p>
  3050. */
  3051. @interface AWSCognitoIdentityProviderMFAOptionType : AWSModel
  3052. /**
  3053. <p>The attribute name of the MFA option type.</p>
  3054. */
  3055. @property (nonatomic, strong) NSString * _Nullable attributeName;
  3056. /**
  3057. <p>The delivery medium (email message or SMS message) to send the MFA code.</p>
  3058. */
  3059. @property (nonatomic, assign) AWSCognitoIdentityProviderDeliveryMediumType deliveryMedium;
  3060. @end
  3061. /**
  3062. <p>The message template structure.</p>
  3063. */
  3064. @interface AWSCognitoIdentityProviderMessageTemplateType : AWSModel
  3065. /**
  3066. <p>The message template for email messages.</p>
  3067. */
  3068. @property (nonatomic, strong) NSString * _Nullable emailMessage;
  3069. /**
  3070. <p>The subject line for email messages.</p>
  3071. */
  3072. @property (nonatomic, strong) NSString * _Nullable emailSubject;
  3073. /**
  3074. <p>The message template for SMS messages.</p>
  3075. */
  3076. @property (nonatomic, strong) NSString * _Nullable SMSMessage;
  3077. @end
  3078. /**
  3079. <p>The new device metadata type.</p>
  3080. */
  3081. @interface AWSCognitoIdentityProviderLatestDeviceMetadataType : AWSModel
  3082. /**
  3083. <p>The device group key.</p>
  3084. */
  3085. @property (nonatomic, strong) NSString * _Nullable deviceGroupKey;
  3086. /**
  3087. <p>The device key.</p>
  3088. */
  3089. @property (nonatomic, strong) NSString * _Nullable deviceKey;
  3090. @end
  3091. /**
  3092. <p>The notify configuration type.</p>
  3093. Required parameters: [SourceArn]
  3094. */
  3095. @interface AWSCognitoIdentityProviderNotifyConfigurationType : AWSModel
  3096. /**
  3097. <p>Email template used when a detected risk event is blocked.</p>
  3098. */
  3099. @property (nonatomic, strong) AWSCognitoIdentityProviderNotifyEmailType * _Nullable blockEmail;
  3100. /**
  3101. <p>The email address that is sending the email. It must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.</p>
  3102. */
  3103. @property (nonatomic, strong) NSString * _Nullable from;
  3104. /**
  3105. <p>The MFA email template used when MFA is challenged as part of a detected risk.</p>
  3106. */
  3107. @property (nonatomic, strong) AWSCognitoIdentityProviderNotifyEmailType * _Nullable mfaEmail;
  3108. /**
  3109. <p>The email template used when a detected risk event is allowed.</p>
  3110. */
  3111. @property (nonatomic, strong) AWSCognitoIdentityProviderNotifyEmailType * _Nullable noActionEmail;
  3112. /**
  3113. <p>The destination to which the receiver of an email should reply to.</p>
  3114. */
  3115. @property (nonatomic, strong) NSString * _Nullable replyTo;
  3116. /**
  3117. <p>The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. It permits Amazon Cognito to send for the email address specified in the <code>From</code> parameter.</p>
  3118. */
  3119. @property (nonatomic, strong) NSString * _Nullable sourceArn;
  3120. @end
  3121. /**
  3122. <p>The notify email type.</p>
  3123. Required parameters: [Subject]
  3124. */
  3125. @interface AWSCognitoIdentityProviderNotifyEmailType : AWSModel
  3126. /**
  3127. <p>The HTML body.</p>
  3128. */
  3129. @property (nonatomic, strong) NSString * _Nullable htmlBody;
  3130. /**
  3131. <p>The subject.</p>
  3132. */
  3133. @property (nonatomic, strong) NSString * _Nullable subject;
  3134. /**
  3135. <p>The text body.</p>
  3136. */
  3137. @property (nonatomic, strong) NSString * _Nullable textBody;
  3138. @end
  3139. /**
  3140. <p>The minimum and maximum value of an attribute that is of the number data type.</p>
  3141. */
  3142. @interface AWSCognitoIdentityProviderNumberAttributeConstraintsType : AWSModel
  3143. /**
  3144. <p>The maximum value of an attribute that is of the number data type.</p>
  3145. */
  3146. @property (nonatomic, strong) NSString * _Nullable maxValue;
  3147. /**
  3148. <p>The minimum value of an attribute that is of the number data type.</p>
  3149. */
  3150. @property (nonatomic, strong) NSString * _Nullable minValue;
  3151. @end
  3152. /**
  3153. <p>The password policy type.</p>
  3154. */
  3155. @interface AWSCognitoIdentityProviderPasswordPolicyType : AWSModel
  3156. /**
  3157. <p>The minimum length of the password policy that you have set. Cannot be less than 6.</p>
  3158. */
  3159. @property (nonatomic, strong) NSNumber * _Nullable minimumLength;
  3160. /**
  3161. <p>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.</p>
  3162. */
  3163. @property (nonatomic, strong) NSNumber * _Nullable requireLowercase;
  3164. /**
  3165. <p>In the password policy that you have set, refers to whether you have required users to use at least one number in their password.</p>
  3166. */
  3167. @property (nonatomic, strong) NSNumber * _Nullable requireNumbers;
  3168. /**
  3169. <p>In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.</p>
  3170. */
  3171. @property (nonatomic, strong) NSNumber * _Nullable requireSymbols;
  3172. /**
  3173. <p>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.</p>
  3174. */
  3175. @property (nonatomic, strong) NSNumber * _Nullable requireUppercase;
  3176. @end
  3177. /**
  3178. <p>A container for identity provider details.</p>
  3179. */
  3180. @interface AWSCognitoIdentityProviderProviderDescription : AWSModel
  3181. /**
  3182. <p>The date the provider was added to the user pool.</p>
  3183. */
  3184. @property (nonatomic, strong) NSDate * _Nullable creationDate;
  3185. /**
  3186. <p>The date the provider was last modified.</p>
  3187. */
  3188. @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate;
  3189. /**
  3190. <p>The identity provider name.</p>
  3191. */
  3192. @property (nonatomic, strong) NSString * _Nullable providerName;
  3193. /**
  3194. <p>The identity provider type.</p>
  3195. */
  3196. @property (nonatomic, assign) AWSCognitoIdentityProviderIdentityProviderTypeType providerType;
  3197. @end
  3198. /**
  3199. <p>A container for information about an identity provider for a user pool.</p>
  3200. */
  3201. @interface AWSCognitoIdentityProviderProviderUserIdentifierType : AWSModel
  3202. /**
  3203. <p>The name of the provider attribute to link to, for example, <code>NameID</code>.</p>
  3204. */
  3205. @property (nonatomic, strong) NSString * _Nullable providerAttributeName;
  3206. /**
  3207. <p>The value of the provider attribute to link to, for example, <code>xxxxx_account</code>.</p>
  3208. */
  3209. @property (nonatomic, strong) NSString * _Nullable providerAttributeValue;
  3210. /**
  3211. <p>The name of the provider, for example, Facebook, Google, or Login with Amazon.</p>
  3212. */
  3213. @property (nonatomic, strong) NSString * _Nullable providerName;
  3214. @end
  3215. /**
  3216. <p>Represents the request to resend the confirmation code.</p>
  3217. Required parameters: [ClientId, Username]
  3218. */
  3219. @interface AWSCognitoIdentityProviderResendConfirmationCodeRequest : AWSRequest
  3220. /**
  3221. <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ResendConfirmationCode</code> calls.</p>
  3222. */
  3223. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata;
  3224. /**
  3225. <p>The ID of the client associated with the user pool.</p>
  3226. */
  3227. @property (nonatomic, strong) NSString * _Nullable clientId;
  3228. /**
  3229. <p>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.</p>
  3230. */
  3231. @property (nonatomic, strong) NSString * _Nullable secretHash;
  3232. /**
  3233. <p>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.</p>
  3234. */
  3235. @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData;
  3236. /**
  3237. <p>The user name of the user to whom you wish to resend a confirmation code.</p>
  3238. */
  3239. @property (nonatomic, strong) NSString * _Nullable username;
  3240. @end
  3241. /**
  3242. <p>The response from the server when the Amazon Cognito Your User Pools service makes the request to resend a confirmation code.</p>
  3243. */
  3244. @interface AWSCognitoIdentityProviderResendConfirmationCodeResponse : AWSModel
  3245. /**
  3246. <p>The code delivery details returned by the server in response to the request to resend the confirmation code.</p>
  3247. */
  3248. @property (nonatomic, strong) AWSCognitoIdentityProviderCodeDeliveryDetailsType * _Nullable codeDeliveryDetails;
  3249. @end
  3250. /**
  3251. <p>A resource server scope.</p>
  3252. Required parameters: [ScopeName, ScopeDescription]
  3253. */
  3254. @interface AWSCognitoIdentityProviderResourceServerScopeType : AWSModel
  3255. /**
  3256. <p>A description of the scope.</p>
  3257. */
  3258. @property (nonatomic, strong) NSString * _Nullable scopeDescription;
  3259. /**
  3260. <p>The name of the scope.</p>
  3261. */
  3262. @property (nonatomic, strong) NSString * _Nullable scopeName;
  3263. @end
  3264. /**
  3265. <p>A container for information about a resource server for a user pool.</p>
  3266. */
  3267. @interface AWSCognitoIdentityProviderResourceServerType : AWSModel
  3268. /**
  3269. <p>The identifier for the resource server.</p>
  3270. */
  3271. @property (nonatomic, strong) NSString * _Nullable identifier;
  3272. /**
  3273. <p>The name of the resource server.</p>
  3274. */
  3275. @property (nonatomic, strong) NSString * _Nullable name;
  3276. /**
  3277. <p>A list of scopes that are defined for the resource server.</p>
  3278. */
  3279. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderResourceServerScopeType *> * _Nullable scopes;
  3280. /**
  3281. <p>The user pool ID for the user pool that hosts the resource server.</p>
  3282. */
  3283. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3284. @end
  3285. /**
  3286. <p>The request to respond to an authentication challenge.</p>
  3287. Required parameters: [ClientId, ChallengeName]
  3288. */
  3289. @interface AWSCognitoIdentityProviderRespondToAuthChallengeRequest : AWSRequest
  3290. /**
  3291. <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>RespondToAuthChallenge</code> calls.</p>
  3292. */
  3293. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata;
  3294. /**
  3295. <p>The challenge name. For more information, see .</p><p><code>ADMIN_NO_SRP_AUTH</code> is not a valid value.</p>
  3296. */
  3297. @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName;
  3298. /**
  3299. <p>The challenge responses. These are inputs corresponding to the value of <code>ChallengeName</code>, for example:</p><ul><li><p><code>SMS_MFA</code>: <code>SMS_MFA_CODE</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p></li><li><p><code>PASSWORD_VERIFIER</code>: <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, <code>TIMESTAMP</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p></li><li><p><code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>, any other required attributes, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). </p></li></ul>
  3300. */
  3301. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable challengeResponses;
  3302. /**
  3303. <p>The app client ID.</p>
  3304. */
  3305. @property (nonatomic, strong) NSString * _Nullable clientId;
  3306. /**
  3307. <p>The session which should be passed both ways in challenge-response calls to the service. If <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
  3308. */
  3309. @property (nonatomic, strong) NSString * _Nullable session;
  3310. /**
  3311. <p>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.</p>
  3312. */
  3313. @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData;
  3314. @end
  3315. /**
  3316. <p>The response to respond to the authentication challenge.</p>
  3317. */
  3318. @interface AWSCognitoIdentityProviderRespondToAuthChallengeResponse : AWSModel
  3319. /**
  3320. <p>The result returned by the server in response to the request to respond to the authentication challenge.</p>
  3321. */
  3322. @property (nonatomic, strong) AWSCognitoIdentityProviderAuthenticationResultType * _Nullable authenticationResult;
  3323. /**
  3324. <p>The challenge name. For more information, see .</p>
  3325. */
  3326. @property (nonatomic, assign) AWSCognitoIdentityProviderChallengeNameType challengeName;
  3327. /**
  3328. <p>The challenge parameters. For more information, see .</p>
  3329. */
  3330. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable challengeParameters;
  3331. /**
  3332. <p>The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
  3333. */
  3334. @property (nonatomic, strong) NSString * _Nullable session;
  3335. @end
  3336. /**
  3337. <p>The risk configuration type.</p>
  3338. */
  3339. @interface AWSCognitoIdentityProviderRiskConfigurationType : AWSModel
  3340. /**
  3341. <p>The account takeover risk configuration object including the <code>NotifyConfiguration</code> object and <code>Actions</code> to take in the case of an account takeover.</p>
  3342. */
  3343. @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverRiskConfigurationType * _Nullable accountTakeoverRiskConfiguration;
  3344. /**
  3345. <p>The app client ID.</p>
  3346. */
  3347. @property (nonatomic, strong) NSString * _Nullable clientId;
  3348. /**
  3349. <p>The compromised credentials risk configuration object including the <code>EventFilter</code> and the <code>EventAction</code></p>
  3350. */
  3351. @property (nonatomic, strong) AWSCognitoIdentityProviderCompromisedCredentialsRiskConfigurationType * _Nullable compromisedCredentialsRiskConfiguration;
  3352. /**
  3353. <p>The last modified date.</p>
  3354. */
  3355. @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate;
  3356. /**
  3357. <p>The configuration to override the risk decision.</p>
  3358. */
  3359. @property (nonatomic, strong) AWSCognitoIdentityProviderRiskExceptionConfigurationType * _Nullable riskExceptionConfiguration;
  3360. /**
  3361. <p>The user pool ID.</p>
  3362. */
  3363. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3364. @end
  3365. /**
  3366. <p>The type of the configuration to override the risk decision.</p>
  3367. */
  3368. @interface AWSCognitoIdentityProviderRiskExceptionConfigurationType : AWSModel
  3369. /**
  3370. <p>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 associated routing prefix.</p>
  3371. */
  3372. @property (nonatomic, strong) NSArray<NSString *> * _Nullable blockedIPRangeList;
  3373. /**
  3374. <p>Risk detection is not performed on the IP addresses in the range list. The IP range is in CIDR notation.</p>
  3375. */
  3376. @property (nonatomic, strong) NSArray<NSString *> * _Nullable skippedIPRangeList;
  3377. @end
  3378. /**
  3379. <p>The SMS multi-factor authentication (MFA) settings type.</p>
  3380. */
  3381. @interface AWSCognitoIdentityProviderSMSMfaSettingsType : AWSModel
  3382. /**
  3383. <p>Specifies whether SMS text message MFA is enabled.</p>
  3384. */
  3385. @property (nonatomic, strong) NSNumber * _Nullable enabled;
  3386. /**
  3387. <p>The preferred MFA method.</p>
  3388. */
  3389. @property (nonatomic, strong) NSNumber * _Nullable preferredMfa;
  3390. @end
  3391. /**
  3392. <p>Contains information about the schema attribute.</p>
  3393. */
  3394. @interface AWSCognitoIdentityProviderSchemaAttributeType : AWSModel
  3395. /**
  3396. <p>The attribute data type.</p>
  3397. */
  3398. @property (nonatomic, assign) AWSCognitoIdentityProviderAttributeDataType attributeDataType;
  3399. /**
  3400. <p>Specifies whether the attribute type is developer only.</p>
  3401. */
  3402. @property (nonatomic, strong) NSNumber * _Nullable developerOnlyAttribute;
  3403. /**
  3404. <p>Specifies whether the value of the attribute can be changed.</p>
  3405. */
  3406. @property (nonatomic, strong) NSNumber * _Nullable varying;
  3407. /**
  3408. <p>A schema attribute of the name type.</p>
  3409. */
  3410. @property (nonatomic, strong) NSString * _Nullable name;
  3411. /**
  3412. <p>Specifies the constraints for an attribute of the number type.</p>
  3413. */
  3414. @property (nonatomic, strong) AWSCognitoIdentityProviderNumberAttributeConstraintsType * _Nullable numberAttributeConstraints;
  3415. /**
  3416. <p>Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.</p>
  3417. */
  3418. @property (nonatomic, strong) NSNumber * _Nullable required;
  3419. /**
  3420. <p>Specifies the constraints for an attribute of the string type.</p>
  3421. */
  3422. @property (nonatomic, strong) AWSCognitoIdentityProviderStringAttributeConstraintsType * _Nullable stringAttributeConstraints;
  3423. @end
  3424. /**
  3425. */
  3426. @interface AWSCognitoIdentityProviderSetRiskConfigurationRequest : AWSRequest
  3427. /**
  3428. <p>The account takeover risk configuration.</p>
  3429. */
  3430. @property (nonatomic, strong) AWSCognitoIdentityProviderAccountTakeoverRiskConfigurationType * _Nullable accountTakeoverRiskConfiguration;
  3431. /**
  3432. <p>The app client ID. If <code>ClientId</code> is null, then the risk configuration is mapped to <code>userPoolId</code>. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.</p><p>Otherwise, <code>ClientId</code> is mapped to the client. When the client ID is not null, the user pool configuration is overridden and the risk configuration for the client is used instead.</p>
  3433. */
  3434. @property (nonatomic, strong) NSString * _Nullable clientId;
  3435. /**
  3436. <p>The compromised credentials risk configuration.</p>
  3437. */
  3438. @property (nonatomic, strong) AWSCognitoIdentityProviderCompromisedCredentialsRiskConfigurationType * _Nullable compromisedCredentialsRiskConfiguration;
  3439. /**
  3440. <p>The configuration to override the risk decision.</p>
  3441. */
  3442. @property (nonatomic, strong) AWSCognitoIdentityProviderRiskExceptionConfigurationType * _Nullable riskExceptionConfiguration;
  3443. /**
  3444. <p>The user pool ID. </p>
  3445. */
  3446. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3447. @end
  3448. /**
  3449. */
  3450. @interface AWSCognitoIdentityProviderSetRiskConfigurationResponse : AWSModel
  3451. /**
  3452. <p>The risk configuration.</p>
  3453. */
  3454. @property (nonatomic, strong) AWSCognitoIdentityProviderRiskConfigurationType * _Nullable riskConfiguration;
  3455. @end
  3456. /**
  3457. */
  3458. @interface AWSCognitoIdentityProviderSetUICustomizationRequest : AWSRequest
  3459. /**
  3460. <p>The CSS values in the UI customization.</p>
  3461. */
  3462. @property (nonatomic, strong) NSString * _Nullable CSS;
  3463. /**
  3464. <p>The client ID for the client app.</p>
  3465. */
  3466. @property (nonatomic, strong) NSString * _Nullable clientId;
  3467. /**
  3468. <p>The uploaded logo image for the UI customization.</p>
  3469. */
  3470. @property (nonatomic, strong) NSData * _Nullable imageFile;
  3471. /**
  3472. <p>The user pool ID for the user pool.</p>
  3473. */
  3474. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3475. @end
  3476. /**
  3477. */
  3478. @interface AWSCognitoIdentityProviderSetUICustomizationResponse : AWSModel
  3479. /**
  3480. <p>The UI customization information.</p>
  3481. */
  3482. @property (nonatomic, strong) AWSCognitoIdentityProviderUICustomizationType * _Nullable UICustomization;
  3483. @end
  3484. /**
  3485. */
  3486. @interface AWSCognitoIdentityProviderSetUserMFAPreferenceRequest : AWSRequest
  3487. /**
  3488. <p>The access token.</p>
  3489. */
  3490. @property (nonatomic, strong) NSString * _Nullable accessToken;
  3491. /**
  3492. <p>The SMS text message multi-factor authentication (MFA) settings.</p>
  3493. */
  3494. @property (nonatomic, strong) AWSCognitoIdentityProviderSMSMfaSettingsType * _Nullable SMSMfaSettings;
  3495. /**
  3496. <p>The time-based one-time password software token MFA settings.</p>
  3497. */
  3498. @property (nonatomic, strong) AWSCognitoIdentityProviderSoftwareTokenMfaSettingsType * _Nullable softwareTokenMfaSettings;
  3499. @end
  3500. /**
  3501. */
  3502. @interface AWSCognitoIdentityProviderSetUserMFAPreferenceResponse : AWSModel
  3503. @end
  3504. /**
  3505. */
  3506. @interface AWSCognitoIdentityProviderSetUserPoolMfaConfigRequest : AWSRequest
  3507. /**
  3508. <p>The MFA configuration.</p>
  3509. */
  3510. @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration;
  3511. /**
  3512. <p>The SMS text message MFA configuration.</p>
  3513. */
  3514. @property (nonatomic, strong) AWSCognitoIdentityProviderSmsMfaConfigType * _Nullable smsMfaConfiguration;
  3515. /**
  3516. <p>The software token MFA configuration.</p>
  3517. */
  3518. @property (nonatomic, strong) AWSCognitoIdentityProviderSoftwareTokenMfaConfigType * _Nullable softwareTokenMfaConfiguration;
  3519. /**
  3520. <p>The user pool ID.</p>
  3521. */
  3522. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3523. @end
  3524. /**
  3525. */
  3526. @interface AWSCognitoIdentityProviderSetUserPoolMfaConfigResponse : AWSModel
  3527. /**
  3528. <p>The MFA configuration.</p>
  3529. */
  3530. @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration;
  3531. /**
  3532. <p>The SMS text message MFA configuration.</p>
  3533. */
  3534. @property (nonatomic, strong) AWSCognitoIdentityProviderSmsMfaConfigType * _Nullable smsMfaConfiguration;
  3535. /**
  3536. <p>The software token MFA configuration.</p>
  3537. */
  3538. @property (nonatomic, strong) AWSCognitoIdentityProviderSoftwareTokenMfaConfigType * _Nullable softwareTokenMfaConfiguration;
  3539. @end
  3540. /**
  3541. <p>Represents the request to set user settings.</p>
  3542. Required parameters: [AccessToken, MFAOptions]
  3543. */
  3544. @interface AWSCognitoIdentityProviderSetUserSettingsRequest : AWSRequest
  3545. /**
  3546. <p>The access token for the set user settings request.</p>
  3547. */
  3548. @property (nonatomic, strong) NSString * _Nullable accessToken;
  3549. /**
  3550. <p>Specifies the options for MFA (e.g., email or phone number).</p>
  3551. */
  3552. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderMFAOptionType *> * _Nullable MFAOptions;
  3553. @end
  3554. /**
  3555. <p>The response from the server for a set user settings request.</p>
  3556. */
  3557. @interface AWSCognitoIdentityProviderSetUserSettingsResponse : AWSModel
  3558. @end
  3559. /**
  3560. <p>Represents the request to register a user.</p>
  3561. Required parameters: [ClientId, Username, Password]
  3562. */
  3563. @interface AWSCognitoIdentityProviderSignUpRequest : AWSRequest
  3564. /**
  3565. <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>SignUp</code> calls.</p>
  3566. */
  3567. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType * _Nullable analyticsMetadata;
  3568. /**
  3569. <p>The ID of the client associated with the user pool.</p>
  3570. */
  3571. @property (nonatomic, strong) NSString * _Nullable clientId;
  3572. /**
  3573. <p>The password of the user you wish to register.</p>
  3574. */
  3575. @property (nonatomic, strong) NSString * _Nullable password;
  3576. /**
  3577. <p>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.</p>
  3578. */
  3579. @property (nonatomic, strong) NSString * _Nullable secretHash;
  3580. /**
  3581. <p>An array of name-value pairs representing user attributes.</p><p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
  3582. */
  3583. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType *> * _Nullable userAttributes;
  3584. /**
  3585. <p>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.</p>
  3586. */
  3587. @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType * _Nullable userContextData;
  3588. /**
  3589. <p>The user name of the user you wish to register.</p>
  3590. */
  3591. @property (nonatomic, strong) NSString * _Nullable username;
  3592. /**
  3593. <p>The validation data in the request to register a user.</p>
  3594. */
  3595. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType *> * _Nullable validationData;
  3596. @end
  3597. /**
  3598. <p>The response from the server for a registration request.</p>
  3599. Required parameters: [UserConfirmed, UserSub]
  3600. */
  3601. @interface AWSCognitoIdentityProviderSignUpResponse : AWSModel
  3602. /**
  3603. <p>The code delivery details returned by the server response to the user registration request.</p>
  3604. */
  3605. @property (nonatomic, strong) AWSCognitoIdentityProviderCodeDeliveryDetailsType * _Nullable codeDeliveryDetails;
  3606. /**
  3607. <p>A response from the server indicating that a user registration has been confirmed.</p>
  3608. */
  3609. @property (nonatomic, strong) NSNumber * _Nullable userConfirmed;
  3610. /**
  3611. <p>The UUID of the authenticated user. This is not the same as <code>username</code>.</p>
  3612. */
  3613. @property (nonatomic, strong) NSString * _Nullable userSub;
  3614. @end
  3615. /**
  3616. <p>The SMS configuration type.</p>
  3617. Required parameters: [SnsCallerArn]
  3618. */
  3619. @interface AWSCognitoIdentityProviderSmsConfigurationType : AWSModel
  3620. /**
  3621. <p>The external ID.</p>
  3622. */
  3623. @property (nonatomic, strong) NSString * _Nullable externalId;
  3624. /**
  3625. <p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.</p>
  3626. */
  3627. @property (nonatomic, strong) NSString * _Nullable snsCallerArn;
  3628. @end
  3629. /**
  3630. <p>The SMS text message multi-factor authentication (MFA) configuration type.</p>
  3631. */
  3632. @interface AWSCognitoIdentityProviderSmsMfaConfigType : AWSModel
  3633. /**
  3634. <p>The SMS authentication message.</p>
  3635. */
  3636. @property (nonatomic, strong) NSString * _Nullable smsAuthenticationMessage;
  3637. /**
  3638. <p>The SMS configuration.</p>
  3639. */
  3640. @property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType * _Nullable smsConfiguration;
  3641. @end
  3642. /**
  3643. <p>The type used for enabling software token MFA at the user pool level.</p>
  3644. */
  3645. @interface AWSCognitoIdentityProviderSoftwareTokenMfaConfigType : AWSModel
  3646. /**
  3647. <p>Specifies whether software token MFA is enabled.</p>
  3648. */
  3649. @property (nonatomic, strong) NSNumber * _Nullable enabled;
  3650. @end
  3651. /**
  3652. <p>The type used for enabling software token MFA at the user level.</p>
  3653. */
  3654. @interface AWSCognitoIdentityProviderSoftwareTokenMfaSettingsType : AWSModel
  3655. /**
  3656. <p>Specifies whether software token MFA is enabled.</p>
  3657. */
  3658. @property (nonatomic, strong) NSNumber * _Nullable enabled;
  3659. /**
  3660. <p>The preferred MFA method.</p>
  3661. */
  3662. @property (nonatomic, strong) NSNumber * _Nullable preferredMfa;
  3663. @end
  3664. /**
  3665. <p>Represents the request to start the user import job.</p>
  3666. Required parameters: [UserPoolId, JobId]
  3667. */
  3668. @interface AWSCognitoIdentityProviderStartUserImportJobRequest : AWSRequest
  3669. /**
  3670. <p>The job ID for the user import job.</p>
  3671. */
  3672. @property (nonatomic, strong) NSString * _Nullable jobId;
  3673. /**
  3674. <p>The user pool ID for the user pool that the users are being imported into.</p>
  3675. */
  3676. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3677. @end
  3678. /**
  3679. <p>Represents the response from the server to the request to start the user import job.</p>
  3680. */
  3681. @interface AWSCognitoIdentityProviderStartUserImportJobResponse : AWSModel
  3682. /**
  3683. <p>The job object that represents the user import job.</p>
  3684. */
  3685. @property (nonatomic, strong) AWSCognitoIdentityProviderUserImportJobType * _Nullable userImportJob;
  3686. @end
  3687. /**
  3688. <p>Represents the request to stop the user import job.</p>
  3689. Required parameters: [UserPoolId, JobId]
  3690. */
  3691. @interface AWSCognitoIdentityProviderStopUserImportJobRequest : AWSRequest
  3692. /**
  3693. <p>The job ID for the user import job.</p>
  3694. */
  3695. @property (nonatomic, strong) NSString * _Nullable jobId;
  3696. /**
  3697. <p>The user pool ID for the user pool that the users are being imported into.</p>
  3698. */
  3699. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3700. @end
  3701. /**
  3702. <p>Represents the response from the server to the request to stop the user import job.</p>
  3703. */
  3704. @interface AWSCognitoIdentityProviderStopUserImportJobResponse : AWSModel
  3705. /**
  3706. <p>The job object that represents the user import job.</p>
  3707. */
  3708. @property (nonatomic, strong) AWSCognitoIdentityProviderUserImportJobType * _Nullable userImportJob;
  3709. @end
  3710. /**
  3711. <p>The constraints associated with a string attribute.</p>
  3712. */
  3713. @interface AWSCognitoIdentityProviderStringAttributeConstraintsType : AWSModel
  3714. /**
  3715. <p>The maximum length.</p>
  3716. */
  3717. @property (nonatomic, strong) NSString * _Nullable maxLength;
  3718. /**
  3719. <p>The minimum length.</p>
  3720. */
  3721. @property (nonatomic, strong) NSString * _Nullable minLength;
  3722. @end
  3723. /**
  3724. <p>A container for the UI customization information for a user pool's built-in app UI.</p>
  3725. */
  3726. @interface AWSCognitoIdentityProviderUICustomizationType : AWSModel
  3727. /**
  3728. <p>The CSS values in the UI customization.</p>
  3729. */
  3730. @property (nonatomic, strong) NSString * _Nullable CSS;
  3731. /**
  3732. <p>The CSS version number.</p>
  3733. */
  3734. @property (nonatomic, strong) NSString * _Nullable CSSVersion;
  3735. /**
  3736. <p>The client ID for the client app.</p>
  3737. */
  3738. @property (nonatomic, strong) NSString * _Nullable clientId;
  3739. /**
  3740. <p>The creation date for the UI customization.</p>
  3741. */
  3742. @property (nonatomic, strong) NSDate * _Nullable creationDate;
  3743. /**
  3744. <p>The logo image for the UI customization.</p>
  3745. */
  3746. @property (nonatomic, strong) NSString * _Nullable imageUrl;
  3747. /**
  3748. <p>The last-modified date for the UI customization.</p>
  3749. */
  3750. @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate;
  3751. /**
  3752. <p>The user pool ID for the user pool.</p>
  3753. */
  3754. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3755. @end
  3756. /**
  3757. */
  3758. @interface AWSCognitoIdentityProviderUpdateAuthEventFeedbackRequest : AWSRequest
  3759. /**
  3760. <p>The event ID.</p>
  3761. */
  3762. @property (nonatomic, strong) NSString * _Nullable eventId;
  3763. /**
  3764. <p>The feedback token.</p>
  3765. */
  3766. @property (nonatomic, strong) NSString * _Nullable feedbackToken;
  3767. /**
  3768. <p>The authentication event feedback value.</p>
  3769. */
  3770. @property (nonatomic, assign) AWSCognitoIdentityProviderFeedbackValueType feedbackValue;
  3771. /**
  3772. <p>The user pool ID.</p>
  3773. */
  3774. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3775. /**
  3776. <p>The user pool username.</p>
  3777. */
  3778. @property (nonatomic, strong) NSString * _Nullable username;
  3779. @end
  3780. /**
  3781. */
  3782. @interface AWSCognitoIdentityProviderUpdateAuthEventFeedbackResponse : AWSModel
  3783. @end
  3784. /**
  3785. <p>Represents the request to update the device status.</p>
  3786. Required parameters: [AccessToken, DeviceKey]
  3787. */
  3788. @interface AWSCognitoIdentityProviderUpdateDeviceStatusRequest : AWSRequest
  3789. /**
  3790. <p>The access token.</p>
  3791. */
  3792. @property (nonatomic, strong) NSString * _Nullable accessToken;
  3793. /**
  3794. <p>The device key.</p>
  3795. */
  3796. @property (nonatomic, strong) NSString * _Nullable deviceKey;
  3797. /**
  3798. <p>The status of whether a device is remembered.</p>
  3799. */
  3800. @property (nonatomic, assign) AWSCognitoIdentityProviderDeviceRememberedStatusType deviceRememberedStatus;
  3801. @end
  3802. /**
  3803. <p>The response to the request to update the device status.</p>
  3804. */
  3805. @interface AWSCognitoIdentityProviderUpdateDeviceStatusResponse : AWSModel
  3806. @end
  3807. /**
  3808. */
  3809. @interface AWSCognitoIdentityProviderUpdateGroupRequest : AWSRequest
  3810. /**
  3811. <p>A string containing the new description of the group.</p>
  3812. */
  3813. @property (nonatomic, strong) NSString * _Nullable detail;
  3814. /**
  3815. <p>The name of the group.</p>
  3816. */
  3817. @property (nonatomic, strong) NSString * _Nullable groupName;
  3818. /**
  3819. <p>The new precedence value for the group. For more information about this parameter, see .</p>
  3820. */
  3821. @property (nonatomic, strong) NSNumber * _Nullable precedence;
  3822. /**
  3823. <p>The new role ARN for the group. This is used for setting the <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims in the token.</p>
  3824. */
  3825. @property (nonatomic, strong) NSString * _Nullable roleArn;
  3826. /**
  3827. <p>The user pool ID for the user pool.</p>
  3828. */
  3829. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3830. @end
  3831. /**
  3832. */
  3833. @interface AWSCognitoIdentityProviderUpdateGroupResponse : AWSModel
  3834. /**
  3835. <p>The group object for the group.</p>
  3836. */
  3837. @property (nonatomic, strong) AWSCognitoIdentityProviderGroupType * _Nullable group;
  3838. @end
  3839. /**
  3840. */
  3841. @interface AWSCognitoIdentityProviderUpdateIdentityProviderRequest : AWSRequest
  3842. /**
  3843. <p>The identity provider attribute mapping to be changed.</p>
  3844. */
  3845. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable attributeMapping;
  3846. /**
  3847. <p>A list of identity provider identifiers.</p>
  3848. */
  3849. @property (nonatomic, strong) NSArray<NSString *> * _Nullable idpIdentifiers;
  3850. /**
  3851. <p>The identity provider details to be updated, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>
  3852. */
  3853. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable providerDetails;
  3854. /**
  3855. <p>The identity provider name.</p>
  3856. */
  3857. @property (nonatomic, strong) NSString * _Nullable providerName;
  3858. /**
  3859. <p>The user pool ID.</p>
  3860. */
  3861. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3862. @end
  3863. /**
  3864. */
  3865. @interface AWSCognitoIdentityProviderUpdateIdentityProviderResponse : AWSModel
  3866. /**
  3867. <p>The identity provider object.</p>
  3868. */
  3869. @property (nonatomic, strong) AWSCognitoIdentityProviderIdentityProviderType * _Nullable identityProvider;
  3870. @end
  3871. /**
  3872. */
  3873. @interface AWSCognitoIdentityProviderUpdateResourceServerRequest : AWSRequest
  3874. /**
  3875. <p>The identifier for the resource server.</p>
  3876. */
  3877. @property (nonatomic, strong) NSString * _Nullable identifier;
  3878. /**
  3879. <p>The name of the resource server.</p>
  3880. */
  3881. @property (nonatomic, strong) NSString * _Nullable name;
  3882. /**
  3883. <p>The scope values to be set for the resource server.</p>
  3884. */
  3885. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderResourceServerScopeType *> * _Nullable scopes;
  3886. /**
  3887. <p>The user pool ID for the user pool.</p>
  3888. */
  3889. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3890. @end
  3891. /**
  3892. */
  3893. @interface AWSCognitoIdentityProviderUpdateResourceServerResponse : AWSModel
  3894. /**
  3895. <p>The resource server.</p>
  3896. */
  3897. @property (nonatomic, strong) AWSCognitoIdentityProviderResourceServerType * _Nullable resourceServer;
  3898. @end
  3899. /**
  3900. <p>Represents the request to update user attributes.</p>
  3901. Required parameters: [UserAttributes, AccessToken]
  3902. */
  3903. @interface AWSCognitoIdentityProviderUpdateUserAttributesRequest : AWSRequest
  3904. /**
  3905. <p>The access token for the request to update user attributes.</p>
  3906. */
  3907. @property (nonatomic, strong) NSString * _Nullable accessToken;
  3908. /**
  3909. <p>An array of name-value pairs representing user attributes.</p><p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
  3910. */
  3911. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType *> * _Nullable userAttributes;
  3912. @end
  3913. /**
  3914. <p>Represents the response from the server for the request to update user attributes.</p>
  3915. */
  3916. @interface AWSCognitoIdentityProviderUpdateUserAttributesResponse : AWSModel
  3917. /**
  3918. <p>The code delivery details list from the server for the request to update user attributes.</p>
  3919. */
  3920. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderCodeDeliveryDetailsType *> * _Nullable codeDeliveryDetailsList;
  3921. @end
  3922. /**
  3923. <p>Represents the request to update the user pool client.</p>
  3924. Required parameters: [UserPoolId, ClientId]
  3925. */
  3926. @interface AWSCognitoIdentityProviderUpdateUserPoolClientRequest : AWSRequest
  3927. /**
  3928. <p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p><p>Set to <code>token</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p>
  3929. */
  3930. @property (nonatomic, strong) NSArray<NSString *> * _Nullable allowedOAuthFlows;
  3931. /**
  3932. <p>Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>
  3933. */
  3934. @property (nonatomic, strong) NSNumber * _Nullable allowedOAuthFlowsUserPoolClient;
  3935. /**
  3936. <p>A list of allowed <code>OAuth</code> scopes. Currently supported values are <code>"phone"</code>, <code>"email"</code>, <code>"openid"</code>, and <code>"Cognito"</code>.</p>
  3937. */
  3938. @property (nonatomic, strong) NSArray<NSString *> * _Nullable allowedOAuthScopes;
  3939. /**
  3940. <p>The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.</p>
  3941. */
  3942. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsConfigurationType * _Nullable analyticsConfiguration;
  3943. /**
  3944. <p>A list of allowed redirect (callback) URLs for the identity providers.</p><p>A redirect URI must:</p><ul><li><p>Be an absolute URI.</p></li><li><p>Be registered with the authorization server.</p></li><li><p>Not include a fragment component.</p></li></ul><p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p><p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p><p>App callback URLs such as myapp://example are also supported.</p>
  3945. */
  3946. @property (nonatomic, strong) NSArray<NSString *> * _Nullable callbackURLs;
  3947. /**
  3948. <p>The ID of the client associated with the user pool.</p>
  3949. */
  3950. @property (nonatomic, strong) NSString * _Nullable clientId;
  3951. /**
  3952. <p>The client name from the update user pool client request.</p>
  3953. */
  3954. @property (nonatomic, strong) NSString * _Nullable clientName;
  3955. /**
  3956. <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p><p>A redirect URI must:</p><ul><li><p>Be an absolute URI.</p></li><li><p>Be registered with the authorization server.</p></li><li><p>Not include a fragment component.</p></li></ul><p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p><p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p><p>App callback URLs such as myapp://example are also supported.</p>
  3957. */
  3958. @property (nonatomic, strong) NSString * _Nullable defaultRedirectURI;
  3959. /**
  3960. <p>Explicit authentication flows.</p>
  3961. */
  3962. @property (nonatomic, strong) NSArray<NSString *> * _Nullable explicitAuthFlows;
  3963. /**
  3964. <p>A list of allowed logout URLs for the identity providers.</p>
  3965. */
  3966. @property (nonatomic, strong) NSArray<NSString *> * _Nullable logoutURLs;
  3967. /**
  3968. <p>The read-only attributes of the user pool.</p>
  3969. */
  3970. @property (nonatomic, strong) NSArray<NSString *> * _Nullable readAttributes;
  3971. /**
  3972. <p>The time limit, in days, after which the refresh token is no longer valid and cannot be used.</p>
  3973. */
  3974. @property (nonatomic, strong) NSNumber * _Nullable refreshTokenValidity;
  3975. /**
  3976. <p>A list of provider names for the identity providers that are supported on this client.</p>
  3977. */
  3978. @property (nonatomic, strong) NSArray<NSString *> * _Nullable supportedIdentityProviders;
  3979. /**
  3980. <p>The user pool ID for the user pool where you want to update the user pool client.</p>
  3981. */
  3982. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  3983. /**
  3984. <p>The writeable attributes of the user pool.</p>
  3985. */
  3986. @property (nonatomic, strong) NSArray<NSString *> * _Nullable writeAttributes;
  3987. @end
  3988. /**
  3989. <p>Represents the response from the server to the request to update the user pool client.</p>
  3990. */
  3991. @interface AWSCognitoIdentityProviderUpdateUserPoolClientResponse : AWSModel
  3992. /**
  3993. <p>The user pool client value from the response from the server when an update user pool client request is made.</p>
  3994. */
  3995. @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolClientType * _Nullable userPoolClient;
  3996. @end
  3997. /**
  3998. <p>Represents the request to update the user pool.</p>
  3999. Required parameters: [UserPoolId]
  4000. */
  4001. @interface AWSCognitoIdentityProviderUpdateUserPoolRequest : AWSRequest
  4002. /**
  4003. <p>The configuration for <code>AdminCreateUser</code> requests.</p>
  4004. */
  4005. @property (nonatomic, strong) AWSCognitoIdentityProviderAdminCreateUserConfigType * _Nullable adminCreateUserConfig;
  4006. /**
  4007. <p>The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.</p>
  4008. */
  4009. @property (nonatomic, strong) NSArray<NSString *> * _Nullable autoVerifiedAttributes;
  4010. /**
  4011. <p>Device configuration.</p>
  4012. */
  4013. @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceConfigurationType * _Nullable deviceConfiguration;
  4014. /**
  4015. <p>Email configuration.</p>
  4016. */
  4017. @property (nonatomic, strong) AWSCognitoIdentityProviderEmailConfigurationType * _Nullable emailConfiguration;
  4018. /**
  4019. <p>The contents of the email verification message.</p>
  4020. */
  4021. @property (nonatomic, strong) NSString * _Nullable emailVerificationMessage;
  4022. /**
  4023. <p>The subject of the email verification message.</p>
  4024. */
  4025. @property (nonatomic, strong) NSString * _Nullable emailVerificationSubject;
  4026. /**
  4027. <p>The AWS Lambda configuration information from the request to update the user pool.</p>
  4028. */
  4029. @property (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType * _Nullable lambdaConfig;
  4030. /**
  4031. <p>Can be one of the following values:</p><ul><li><p><code>OFF</code> - MFA tokens are not required and cannot be specified during user registration.</p></li><li><p><code>ON</code> - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.</p></li><li><p><code>OPTIONAL</code> - Users have the option when registering to create an MFA token.</p></li></ul>
  4032. */
  4033. @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration;
  4034. /**
  4035. <p>A container with the policies you wish to update in a user pool.</p>
  4036. */
  4037. @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolPolicyType * _Nullable policies;
  4038. /**
  4039. <p>The contents of the SMS authentication message.</p>
  4040. */
  4041. @property (nonatomic, strong) NSString * _Nullable smsAuthenticationMessage;
  4042. /**
  4043. <p>SMS configuration.</p>
  4044. */
  4045. @property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType * _Nullable smsConfiguration;
  4046. /**
  4047. <p>A container with information about the SMS verification message.</p>
  4048. */
  4049. @property (nonatomic, strong) NSString * _Nullable smsVerificationMessage;
  4050. /**
  4051. <p>Used to enable advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
  4052. */
  4053. @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolAddOnsType * _Nullable userPoolAddOns;
  4054. /**
  4055. <p>The user pool ID for the user pool you want to update.</p>
  4056. */
  4057. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  4058. /**
  4059. <p>The cost allocation tags for the user pool. For more information, see <a href="http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-cost-allocation-tagging.html">Adding Cost Allocation Tags to Your User Pool</a></p>
  4060. */
  4061. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable userPoolTags;
  4062. /**
  4063. <p>The template for verification messages.</p>
  4064. */
  4065. @property (nonatomic, strong) AWSCognitoIdentityProviderVerificationMessageTemplateType * _Nullable verificationMessageTemplate;
  4066. @end
  4067. /**
  4068. <p>Represents the response from the server when you make a request to update the user pool.</p>
  4069. */
  4070. @interface AWSCognitoIdentityProviderUpdateUserPoolResponse : AWSModel
  4071. @end
  4072. /**
  4073. <p>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.</p>
  4074. */
  4075. @interface AWSCognitoIdentityProviderUserContextDataType : AWSModel
  4076. /**
  4077. <p>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.</p>
  4078. */
  4079. @property (nonatomic, strong) NSString * _Nullable encodedData;
  4080. @end
  4081. /**
  4082. <p>The user import job type.</p>
  4083. */
  4084. @interface AWSCognitoIdentityProviderUserImportJobType : AWSModel
  4085. /**
  4086. <p>The role 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.</p>
  4087. */
  4088. @property (nonatomic, strong) NSString * _Nullable cloudWatchLogsRoleArn;
  4089. /**
  4090. <p>The date when the user import job was completed.</p>
  4091. */
  4092. @property (nonatomic, strong) NSDate * _Nullable completionDate;
  4093. /**
  4094. <p>The message returned when the user import job is completed.</p>
  4095. */
  4096. @property (nonatomic, strong) NSString * _Nullable completionMessage;
  4097. /**
  4098. <p>The date the user import job was created.</p>
  4099. */
  4100. @property (nonatomic, strong) NSDate * _Nullable creationDate;
  4101. /**
  4102. <p>The number of users that could not be imported.</p>
  4103. */
  4104. @property (nonatomic, strong) NSNumber * _Nullable failedUsers;
  4105. /**
  4106. <p>The number of users that were successfully imported.</p>
  4107. */
  4108. @property (nonatomic, strong) NSNumber * _Nullable importedUsers;
  4109. /**
  4110. <p>The job ID for the user import job.</p>
  4111. */
  4112. @property (nonatomic, strong) NSString * _Nullable jobId;
  4113. /**
  4114. <p>The job name for the user import job.</p>
  4115. */
  4116. @property (nonatomic, strong) NSString * _Nullable jobName;
  4117. /**
  4118. <p>The pre-signed URL to be used to upload the <code>.csv</code> file.</p>
  4119. */
  4120. @property (nonatomic, strong) NSString * _Nullable preSignedUrl;
  4121. /**
  4122. <p>The number of users that were skipped.</p>
  4123. */
  4124. @property (nonatomic, strong) NSNumber * _Nullable skippedUsers;
  4125. /**
  4126. <p>The date when the user import job was started.</p>
  4127. */
  4128. @property (nonatomic, strong) NSDate * _Nullable startDate;
  4129. /**
  4130. <p>The status of the user import job. One of the following:</p><ul><li><p><code>Created</code> - The job was created but not started.</p></li><li><p><code>Pending</code> - A transition state. You have started the job, but it has not begun importing users yet.</p></li><li><p><code>InProgress</code> - The job has started, and users are being imported.</p></li><li><p><code>Stopping</code> - You have stopped the job, but the job has not stopped importing users yet.</p></li><li><p><code>Stopped</code> - You have stopped the job, and the job has stopped importing users.</p></li><li><p><code>Succeeded</code> - The job has completed successfully.</p></li><li><p><code>Failed</code> - The job has stopped due to an error.</p></li><li><p><code>Expired</code> - 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 cannot be started.</p></li></ul>
  4131. */
  4132. @property (nonatomic, assign) AWSCognitoIdentityProviderUserImportJobStatusType status;
  4133. /**
  4134. <p>The user pool ID for the user pool that the users are being imported into.</p>
  4135. */
  4136. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  4137. @end
  4138. /**
  4139. <p>The user pool add-ons type.</p>
  4140. Required parameters: [AdvancedSecurityMode]
  4141. */
  4142. @interface AWSCognitoIdentityProviderUserPoolAddOnsType : AWSModel
  4143. /**
  4144. <p>The advanced security mode.</p>
  4145. */
  4146. @property (nonatomic, assign) AWSCognitoIdentityProviderAdvancedSecurityModeType advancedSecurityMode;
  4147. @end
  4148. /**
  4149. <p>The description of the user pool client.</p>
  4150. */
  4151. @interface AWSCognitoIdentityProviderUserPoolClientDescription : AWSModel
  4152. /**
  4153. <p>The ID of the client associated with the user pool.</p>
  4154. */
  4155. @property (nonatomic, strong) NSString * _Nullable clientId;
  4156. /**
  4157. <p>The client name from the user pool client description.</p>
  4158. */
  4159. @property (nonatomic, strong) NSString * _Nullable clientName;
  4160. /**
  4161. <p>The user pool ID for the user pool where you want to describe the user pool client.</p>
  4162. */
  4163. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  4164. @end
  4165. /**
  4166. <p>Contains information about a user pool client.</p>
  4167. */
  4168. @interface AWSCognitoIdentityProviderUserPoolClientType : AWSModel
  4169. /**
  4170. <p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p><p>Set to <code>token</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p>
  4171. */
  4172. @property (nonatomic, strong) NSArray<NSString *> * _Nullable allowedOAuthFlows;
  4173. /**
  4174. <p>Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>
  4175. */
  4176. @property (nonatomic, strong) NSNumber * _Nullable allowedOAuthFlowsUserPoolClient;
  4177. /**
  4178. <p>A list of allowed <code>OAuth</code> scopes. Currently supported values are <code>"phone"</code>, <code>"email"</code>, <code>"openid"</code>, and <code>"Cognito"</code>.</p>
  4179. */
  4180. @property (nonatomic, strong) NSArray<NSString *> * _Nullable allowedOAuthScopes;
  4181. /**
  4182. <p>The Amazon Pinpoint analytics configuration for the user pool client.</p>
  4183. */
  4184. @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsConfigurationType * _Nullable analyticsConfiguration;
  4185. /**
  4186. <p>A list of allowed redirect (callback) URLs for the identity providers.</p><p>A redirect URI must:</p><ul><li><p>Be an absolute URI.</p></li><li><p>Be registered with the authorization server.</p></li><li><p>Not include a fragment component.</p></li></ul><p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p><p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p><p>App callback URLs such as myapp://example are also supported.</p>
  4187. */
  4188. @property (nonatomic, strong) NSArray<NSString *> * _Nullable callbackURLs;
  4189. /**
  4190. <p>The ID of the client associated with the user pool.</p>
  4191. */
  4192. @property (nonatomic, strong) NSString * _Nullable clientId;
  4193. /**
  4194. <p>The client name from the user pool request of the client type.</p>
  4195. */
  4196. @property (nonatomic, strong) NSString * _Nullable clientName;
  4197. /**
  4198. <p>The client secret from the user pool request of the client type.</p>
  4199. */
  4200. @property (nonatomic, strong) NSString * _Nullable clientSecret;
  4201. /**
  4202. <p>The date the user pool client was created.</p>
  4203. */
  4204. @property (nonatomic, strong) NSDate * _Nullable creationDate;
  4205. /**
  4206. <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p><p>A redirect URI must:</p><ul><li><p>Be an absolute URI.</p></li><li><p>Be registered with the authorization server.</p></li><li><p>Not include a fragment component.</p></li></ul><p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p><p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p><p>App callback URLs such as myapp://example are also supported.</p>
  4207. */
  4208. @property (nonatomic, strong) NSString * _Nullable defaultRedirectURI;
  4209. /**
  4210. <p>The explicit authentication flows.</p>
  4211. */
  4212. @property (nonatomic, strong) NSArray<NSString *> * _Nullable explicitAuthFlows;
  4213. /**
  4214. <p>The date the user pool client was last modified.</p>
  4215. */
  4216. @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate;
  4217. /**
  4218. <p>A list of allowed logout URLs for the identity providers.</p>
  4219. */
  4220. @property (nonatomic, strong) NSArray<NSString *> * _Nullable logoutURLs;
  4221. /**
  4222. <p>The Read-only attributes.</p>
  4223. */
  4224. @property (nonatomic, strong) NSArray<NSString *> * _Nullable readAttributes;
  4225. /**
  4226. <p>The time limit, in days, after which the refresh token is no longer valid and cannot be used.</p>
  4227. */
  4228. @property (nonatomic, strong) NSNumber * _Nullable refreshTokenValidity;
  4229. /**
  4230. <p>A list of provider names for the identity providers that are supported on this client.</p>
  4231. */
  4232. @property (nonatomic, strong) NSArray<NSString *> * _Nullable supportedIdentityProviders;
  4233. /**
  4234. <p>The user pool ID for the user pool client.</p>
  4235. */
  4236. @property (nonatomic, strong) NSString * _Nullable userPoolId;
  4237. /**
  4238. <p>The writeable attributes.</p>
  4239. */
  4240. @property (nonatomic, strong) NSArray<NSString *> * _Nullable writeAttributes;
  4241. @end
  4242. /**
  4243. <p>A user pool description.</p>
  4244. */
  4245. @interface AWSCognitoIdentityProviderUserPoolDescriptionType : AWSModel
  4246. /**
  4247. <p>The date the user pool description was created.</p>
  4248. */
  4249. @property (nonatomic, strong) NSDate * _Nullable creationDate;
  4250. /**
  4251. <p>The ID in a user pool description.</p>
  4252. */
  4253. @property (nonatomic, strong) NSString * _Nullable identifier;
  4254. /**
  4255. <p>The AWS Lambda configuration information in a user pool description.</p>
  4256. */
  4257. @property (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType * _Nullable lambdaConfig;
  4258. /**
  4259. <p>The date the user pool description was last modified.</p>
  4260. */
  4261. @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate;
  4262. /**
  4263. <p>The name in a user pool description.</p>
  4264. */
  4265. @property (nonatomic, strong) NSString * _Nullable name;
  4266. /**
  4267. <p>The user pool status in a user pool description.</p>
  4268. */
  4269. @property (nonatomic, assign) AWSCognitoIdentityProviderStatusType status;
  4270. @end
  4271. /**
  4272. <p>The policy associated with a user pool.</p>
  4273. */
  4274. @interface AWSCognitoIdentityProviderUserPoolPolicyType : AWSModel
  4275. /**
  4276. <p>The password policy.</p>
  4277. */
  4278. @property (nonatomic, strong) AWSCognitoIdentityProviderPasswordPolicyType * _Nullable passwordPolicy;
  4279. @end
  4280. /**
  4281. <p>A container for information about the user pool.</p>
  4282. */
  4283. @interface AWSCognitoIdentityProviderUserPoolType : AWSModel
  4284. /**
  4285. <p>The configuration for <code>AdminCreateUser</code> requests.</p>
  4286. */
  4287. @property (nonatomic, strong) AWSCognitoIdentityProviderAdminCreateUserConfigType * _Nullable adminCreateUserConfig;
  4288. /**
  4289. <p>Specifies the attributes that are aliased in a user pool.</p>
  4290. */
  4291. @property (nonatomic, strong) NSArray<NSString *> * _Nullable aliasAttributes;
  4292. /**
  4293. <p>The Amazon Resource Name (ARN) for the user pool.</p>
  4294. */
  4295. @property (nonatomic, strong) NSString * _Nullable arn;
  4296. /**
  4297. <p>Specifies the attributes that are auto-verified in a user pool.</p>
  4298. */
  4299. @property (nonatomic, strong) NSArray<NSString *> * _Nullable autoVerifiedAttributes;
  4300. /**
  4301. <p>The date the user pool was created.</p>
  4302. */
  4303. @property (nonatomic, strong) NSDate * _Nullable creationDate;
  4304. /**
  4305. */
  4306. @property (nonatomic, strong) NSString * _Nullable customDomain;
  4307. /**
  4308. <p>The device configuration.</p>
  4309. */
  4310. @property (nonatomic, strong) AWSCognitoIdentityProviderDeviceConfigurationType * _Nullable deviceConfiguration;
  4311. /**
  4312. <p>Holds the domain prefix if the user pool has a domain associated with it.</p>
  4313. */
  4314. @property (nonatomic, strong) NSString * _Nullable domain;
  4315. /**
  4316. <p>The email configuration.</p>
  4317. */
  4318. @property (nonatomic, strong) AWSCognitoIdentityProviderEmailConfigurationType * _Nullable emailConfiguration;
  4319. /**
  4320. <p>The reason why the email configuration cannot send the messages to your users.</p>
  4321. */
  4322. @property (nonatomic, strong) NSString * _Nullable emailConfigurationFailure;
  4323. /**
  4324. <p>The contents of the email verification message.</p>
  4325. */
  4326. @property (nonatomic, strong) NSString * _Nullable emailVerificationMessage;
  4327. /**
  4328. <p>The subject of the email verification message.</p>
  4329. */
  4330. @property (nonatomic, strong) NSString * _Nullable emailVerificationSubject;
  4331. /**
  4332. <p>A number estimating the size of the user pool.</p>
  4333. */
  4334. @property (nonatomic, strong) NSNumber * _Nullable estimatedNumberOfUsers;
  4335. /**
  4336. <p>The ID of the user pool.</p>
  4337. */
  4338. @property (nonatomic, strong) NSString * _Nullable identifier;
  4339. /**
  4340. <p>The AWS Lambda triggers associated with the user pool.</p>
  4341. */
  4342. @property (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType * _Nullable lambdaConfig;
  4343. /**
  4344. <p>The date the user pool was last modified.</p>
  4345. */
  4346. @property (nonatomic, strong) NSDate * _Nullable lastModifiedDate;
  4347. /**
  4348. <p>Can be one of the following values:</p><ul><li><p><code>OFF</code> - MFA tokens are not required and cannot be specified during user registration.</p></li><li><p><code>ON</code> - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.</p></li><li><p><code>OPTIONAL</code> - Users have the option when registering to create an MFA token.</p></li></ul>
  4349. */
  4350. @property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration;
  4351. /**
  4352. <p>The name of the user pool.</p>
  4353. */
  4354. @property (nonatomic, strong) NSString * _Nullable name;
  4355. /**
  4356. <p>The policies associated with the user pool.</p>
  4357. */
  4358. @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolPolicyType * _Nullable policies;
  4359. /**
  4360. <p>A container with the schema attributes of a user pool.</p>
  4361. */
  4362. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderSchemaAttributeType *> * _Nullable schemaAttributes;
  4363. /**
  4364. <p>The contents of the SMS authentication message.</p>
  4365. */
  4366. @property (nonatomic, strong) NSString * _Nullable smsAuthenticationMessage;
  4367. /**
  4368. <p>The SMS configuration.</p>
  4369. */
  4370. @property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType * _Nullable smsConfiguration;
  4371. /**
  4372. <p>The reason why the SMS configuration cannot send the messages to your users.</p>
  4373. */
  4374. @property (nonatomic, strong) NSString * _Nullable smsConfigurationFailure;
  4375. /**
  4376. <p>The contents of the SMS verification message.</p>
  4377. */
  4378. @property (nonatomic, strong) NSString * _Nullable smsVerificationMessage;
  4379. /**
  4380. <p>The status of a user pool.</p>
  4381. */
  4382. @property (nonatomic, assign) AWSCognitoIdentityProviderStatusType status;
  4383. /**
  4384. <p>The user pool add-ons.</p>
  4385. */
  4386. @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolAddOnsType * _Nullable userPoolAddOns;
  4387. /**
  4388. <p>The cost allocation tags for the user pool. For more information, see <a href="http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-cost-allocation-tagging.html">Adding Cost Allocation Tags to Your User Pool</a></p>
  4389. */
  4390. @property (nonatomic, strong) NSDictionary<NSString *, NSString *> * _Nullable userPoolTags;
  4391. /**
  4392. <p>Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.</p>
  4393. */
  4394. @property (nonatomic, strong) NSArray<NSString *> * _Nullable usernameAttributes;
  4395. /**
  4396. <p>The template for verification messages.</p>
  4397. */
  4398. @property (nonatomic, strong) AWSCognitoIdentityProviderVerificationMessageTemplateType * _Nullable verificationMessageTemplate;
  4399. @end
  4400. /**
  4401. <p>The user type.</p>
  4402. */
  4403. @interface AWSCognitoIdentityProviderUserType : AWSModel
  4404. /**
  4405. <p>A container with information about the user type attributes.</p>
  4406. */
  4407. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType *> * _Nullable attributes;
  4408. /**
  4409. <p>Specifies whether the user is enabled.</p>
  4410. */
  4411. @property (nonatomic, strong) NSNumber * _Nullable enabled;
  4412. /**
  4413. <p>The MFA options for the user.</p>
  4414. */
  4415. @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderMFAOptionType *> * _Nullable MFAOptions;
  4416. /**
  4417. <p>The creation date of the user.</p>
  4418. */
  4419. @property (nonatomic, strong) NSDate * _Nullable userCreateDate;
  4420. /**
  4421. <p>The last modified date of the user.</p>
  4422. */
  4423. @property (nonatomic, strong) NSDate * _Nullable userLastModifiedDate;
  4424. /**
  4425. <p>The user status. Can be one of the following:</p><ul><li><p>UNCONFIRMED - User has been created but not confirmed.</p></li><li><p>CONFIRMED - User has been confirmed.</p></li><li><p>ARCHIVED - User is no longer active.</p></li><li><p>COMPROMISED - User is disabled due to a potential security threat.</p></li><li><p>UNKNOWN - User status is not known.</p></li></ul>
  4426. */
  4427. @property (nonatomic, assign) AWSCognitoIdentityProviderUserStatusType userStatus;
  4428. /**
  4429. <p>The user name of the user you wish to describe.</p>
  4430. */
  4431. @property (nonatomic, strong) NSString * _Nullable username;
  4432. @end
  4433. /**
  4434. <p>The template for verification messages.</p>
  4435. */
  4436. @interface AWSCognitoIdentityProviderVerificationMessageTemplateType : AWSModel
  4437. /**
  4438. <p>The default email option.</p>
  4439. */
  4440. @property (nonatomic, assign) AWSCognitoIdentityProviderDefaultEmailOptionType defaultEmailOption;
  4441. /**
  4442. <p>The email message template.</p>
  4443. */
  4444. @property (nonatomic, strong) NSString * _Nullable emailMessage;
  4445. /**
  4446. <p>The email message template for sending a confirmation link to the user.</p>
  4447. */
  4448. @property (nonatomic, strong) NSString * _Nullable emailMessageByLink;
  4449. /**
  4450. <p>The subject line for the email message template.</p>
  4451. */
  4452. @property (nonatomic, strong) NSString * _Nullable emailSubject;
  4453. /**
  4454. <p>The subject line for the email message template for sending a confirmation link to the user.</p>
  4455. */
  4456. @property (nonatomic, strong) NSString * _Nullable emailSubjectByLink;
  4457. /**
  4458. <p>The SMS message template.</p>
  4459. */
  4460. @property (nonatomic, strong) NSString * _Nullable smsMessage;
  4461. @end
  4462. /**
  4463. */
  4464. @interface AWSCognitoIdentityProviderVerifySoftwareTokenRequest : AWSRequest
  4465. /**
  4466. <p>The access token.</p>
  4467. */
  4468. @property (nonatomic, strong) NSString * _Nullable accessToken;
  4469. /**
  4470. <p>The friendly device name.</p>
  4471. */
  4472. @property (nonatomic, strong) NSString * _Nullable friendlyDeviceName;
  4473. /**
  4474. <p>The session which should be passed both ways in challenge-response calls to the service.</p>
  4475. */
  4476. @property (nonatomic, strong) NSString * _Nullable session;
  4477. /**
  4478. <p>The one time password computed using the secret code returned by </p>
  4479. */
  4480. @property (nonatomic, strong) NSString * _Nullable userCode;
  4481. @end
  4482. /**
  4483. */
  4484. @interface AWSCognitoIdentityProviderVerifySoftwareTokenResponse : AWSModel
  4485. /**
  4486. <p>The session which should be passed both ways in challenge-response calls to the service.</p>
  4487. */
  4488. @property (nonatomic, strong) NSString * _Nullable session;
  4489. /**
  4490. <p>The status of the verify software token.</p>
  4491. */
  4492. @property (nonatomic, assign) AWSCognitoIdentityProviderVerifySoftwareTokenResponseType status;
  4493. @end
  4494. /**
  4495. <p>Represents the request to verify user attributes.</p>
  4496. Required parameters: [AccessToken, AttributeName, Code]
  4497. */
  4498. @interface AWSCognitoIdentityProviderVerifyUserAttributeRequest : AWSRequest
  4499. /**
  4500. <p>Represents the access token of the request to verify user attributes.</p>
  4501. */
  4502. @property (nonatomic, strong) NSString * _Nullable accessToken;
  4503. /**
  4504. <p>The attribute name in the request to verify user attributes.</p>
  4505. */
  4506. @property (nonatomic, strong) NSString * _Nullable attributeName;
  4507. /**
  4508. <p>The verification code in the request to verify user attributes.</p>
  4509. */
  4510. @property (nonatomic, strong) NSString * _Nullable code;
  4511. @end
  4512. /**
  4513. <p>A container representing the response from the server from the request to verify user attributes.</p>
  4514. */
  4515. @interface AWSCognitoIdentityProviderVerifyUserAttributeResponse : AWSModel
  4516. @end
  4517. NS_ASSUME_NONNULL_END