api.go 195 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711
  1. // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
  2. package connect
  3. import (
  4. "time"
  5. "github.com/aws/aws-sdk-go/aws"
  6. "github.com/aws/aws-sdk-go/aws/awsutil"
  7. "github.com/aws/aws-sdk-go/aws/request"
  8. "github.com/aws/aws-sdk-go/private/protocol"
  9. "github.com/aws/aws-sdk-go/private/protocol/restjson"
  10. )
  11. const opCreateUser = "CreateUser"
  12. // CreateUserRequest generates a "aws/request.Request" representing the
  13. // client's request for the CreateUser operation. The "output" return
  14. // value will be populated with the request's response once the request completes
  15. // successfully.
  16. //
  17. // Use "Send" method on the returned Request to send the API call to the service.
  18. // the "output" return value is not valid until after Send returns without error.
  19. //
  20. // See CreateUser for more information on using the CreateUser
  21. // API call, and error handling.
  22. //
  23. // This method is useful when you want to inject custom logic or configuration
  24. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  25. //
  26. //
  27. // // Example sending a request using the CreateUserRequest method.
  28. // req, resp := client.CreateUserRequest(params)
  29. //
  30. // err := req.Send()
  31. // if err == nil { // resp is now filled
  32. // fmt.Println(resp)
  33. // }
  34. //
  35. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser
  36. func (c *Connect) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput) {
  37. op := &request.Operation{
  38. Name: opCreateUser,
  39. HTTPMethod: "PUT",
  40. HTTPPath: "/users/{InstanceId}",
  41. }
  42. if input == nil {
  43. input = &CreateUserInput{}
  44. }
  45. output = &CreateUserOutput{}
  46. req = c.newRequest(op, input, output)
  47. return
  48. }
  49. // CreateUser API operation for Amazon Connect Service.
  50. //
  51. // Creates a new user account in your Amazon Connect instance.
  52. //
  53. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  54. // with awserr.Error's Code and Message methods to get detailed information about
  55. // the error.
  56. //
  57. // See the AWS API reference guide for Amazon Connect Service's
  58. // API operation CreateUser for usage and error information.
  59. //
  60. // Returned Error Codes:
  61. // * ErrCodeInvalidRequestException "InvalidRequestException"
  62. // The request is not valid.
  63. //
  64. // * ErrCodeInvalidParameterException "InvalidParameterException"
  65. // One or more of the parameters provided to the operation are not valid.
  66. //
  67. // * ErrCodeLimitExceededException "LimitExceededException"
  68. // The allowed limit for the resource has been reached.
  69. //
  70. // * ErrCodeDuplicateResourceException "DuplicateResourceException"
  71. // A resource with that name already exists.
  72. //
  73. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  74. // The specified resource was not found.
  75. //
  76. // * ErrCodeThrottlingException "ThrottlingException"
  77. // The throttling limit has been exceeded.
  78. //
  79. // * ErrCodeInternalServiceException "InternalServiceException"
  80. // Request processing failed due to an error or failure with the service.
  81. //
  82. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser
  83. func (c *Connect) CreateUser(input *CreateUserInput) (*CreateUserOutput, error) {
  84. req, out := c.CreateUserRequest(input)
  85. return out, req.Send()
  86. }
  87. // CreateUserWithContext is the same as CreateUser with the addition of
  88. // the ability to pass a context and additional request options.
  89. //
  90. // See CreateUser for details on how to use this API operation.
  91. //
  92. // The context must be non-nil and will be used for request cancellation. If
  93. // the context is nil a panic will occur. In the future the SDK may create
  94. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  95. // for more information on using Contexts.
  96. func (c *Connect) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error) {
  97. req, out := c.CreateUserRequest(input)
  98. req.SetContext(ctx)
  99. req.ApplyOptions(opts...)
  100. return out, req.Send()
  101. }
  102. const opDeleteUser = "DeleteUser"
  103. // DeleteUserRequest generates a "aws/request.Request" representing the
  104. // client's request for the DeleteUser operation. The "output" return
  105. // value will be populated with the request's response once the request completes
  106. // successfully.
  107. //
  108. // Use "Send" method on the returned Request to send the API call to the service.
  109. // the "output" return value is not valid until after Send returns without error.
  110. //
  111. // See DeleteUser for more information on using the DeleteUser
  112. // API call, and error handling.
  113. //
  114. // This method is useful when you want to inject custom logic or configuration
  115. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  116. //
  117. //
  118. // // Example sending a request using the DeleteUserRequest method.
  119. // req, resp := client.DeleteUserRequest(params)
  120. //
  121. // err := req.Send()
  122. // if err == nil { // resp is now filled
  123. // fmt.Println(resp)
  124. // }
  125. //
  126. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser
  127. func (c *Connect) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput) {
  128. op := &request.Operation{
  129. Name: opDeleteUser,
  130. HTTPMethod: "DELETE",
  131. HTTPPath: "/users/{InstanceId}/{UserId}",
  132. }
  133. if input == nil {
  134. input = &DeleteUserInput{}
  135. }
  136. output = &DeleteUserOutput{}
  137. req = c.newRequest(op, input, output)
  138. req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
  139. return
  140. }
  141. // DeleteUser API operation for Amazon Connect Service.
  142. //
  143. // Deletes a user account from Amazon Connect.
  144. //
  145. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  146. // with awserr.Error's Code and Message methods to get detailed information about
  147. // the error.
  148. //
  149. // See the AWS API reference guide for Amazon Connect Service's
  150. // API operation DeleteUser for usage and error information.
  151. //
  152. // Returned Error Codes:
  153. // * ErrCodeInvalidRequestException "InvalidRequestException"
  154. // The request is not valid.
  155. //
  156. // * ErrCodeInvalidParameterException "InvalidParameterException"
  157. // One or more of the parameters provided to the operation are not valid.
  158. //
  159. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  160. // The specified resource was not found.
  161. //
  162. // * ErrCodeThrottlingException "ThrottlingException"
  163. // The throttling limit has been exceeded.
  164. //
  165. // * ErrCodeInternalServiceException "InternalServiceException"
  166. // Request processing failed due to an error or failure with the service.
  167. //
  168. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser
  169. func (c *Connect) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error) {
  170. req, out := c.DeleteUserRequest(input)
  171. return out, req.Send()
  172. }
  173. // DeleteUserWithContext is the same as DeleteUser with the addition of
  174. // the ability to pass a context and additional request options.
  175. //
  176. // See DeleteUser for details on how to use this API operation.
  177. //
  178. // The context must be non-nil and will be used for request cancellation. If
  179. // the context is nil a panic will occur. In the future the SDK may create
  180. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  181. // for more information on using Contexts.
  182. func (c *Connect) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error) {
  183. req, out := c.DeleteUserRequest(input)
  184. req.SetContext(ctx)
  185. req.ApplyOptions(opts...)
  186. return out, req.Send()
  187. }
  188. const opDescribeUser = "DescribeUser"
  189. // DescribeUserRequest generates a "aws/request.Request" representing the
  190. // client's request for the DescribeUser operation. The "output" return
  191. // value will be populated with the request's response once the request completes
  192. // successfully.
  193. //
  194. // Use "Send" method on the returned Request to send the API call to the service.
  195. // the "output" return value is not valid until after Send returns without error.
  196. //
  197. // See DescribeUser for more information on using the DescribeUser
  198. // API call, and error handling.
  199. //
  200. // This method is useful when you want to inject custom logic or configuration
  201. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  202. //
  203. //
  204. // // Example sending a request using the DescribeUserRequest method.
  205. // req, resp := client.DescribeUserRequest(params)
  206. //
  207. // err := req.Send()
  208. // if err == nil { // resp is now filled
  209. // fmt.Println(resp)
  210. // }
  211. //
  212. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser
  213. func (c *Connect) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput) {
  214. op := &request.Operation{
  215. Name: opDescribeUser,
  216. HTTPMethod: "GET",
  217. HTTPPath: "/users/{InstanceId}/{UserId}",
  218. }
  219. if input == nil {
  220. input = &DescribeUserInput{}
  221. }
  222. output = &DescribeUserOutput{}
  223. req = c.newRequest(op, input, output)
  224. return
  225. }
  226. // DescribeUser API operation for Amazon Connect Service.
  227. //
  228. // Returns a User object that contains information about the user account specified
  229. // by the UserId.
  230. //
  231. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  232. // with awserr.Error's Code and Message methods to get detailed information about
  233. // the error.
  234. //
  235. // See the AWS API reference guide for Amazon Connect Service's
  236. // API operation DescribeUser for usage and error information.
  237. //
  238. // Returned Error Codes:
  239. // * ErrCodeInvalidRequestException "InvalidRequestException"
  240. // The request is not valid.
  241. //
  242. // * ErrCodeInvalidParameterException "InvalidParameterException"
  243. // One or more of the parameters provided to the operation are not valid.
  244. //
  245. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  246. // The specified resource was not found.
  247. //
  248. // * ErrCodeThrottlingException "ThrottlingException"
  249. // The throttling limit has been exceeded.
  250. //
  251. // * ErrCodeInternalServiceException "InternalServiceException"
  252. // Request processing failed due to an error or failure with the service.
  253. //
  254. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser
  255. func (c *Connect) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error) {
  256. req, out := c.DescribeUserRequest(input)
  257. return out, req.Send()
  258. }
  259. // DescribeUserWithContext is the same as DescribeUser with the addition of
  260. // the ability to pass a context and additional request options.
  261. //
  262. // See DescribeUser for details on how to use this API operation.
  263. //
  264. // The context must be non-nil and will be used for request cancellation. If
  265. // the context is nil a panic will occur. In the future the SDK may create
  266. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  267. // for more information on using Contexts.
  268. func (c *Connect) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error) {
  269. req, out := c.DescribeUserRequest(input)
  270. req.SetContext(ctx)
  271. req.ApplyOptions(opts...)
  272. return out, req.Send()
  273. }
  274. const opDescribeUserHierarchyGroup = "DescribeUserHierarchyGroup"
  275. // DescribeUserHierarchyGroupRequest generates a "aws/request.Request" representing the
  276. // client's request for the DescribeUserHierarchyGroup operation. The "output" return
  277. // value will be populated with the request's response once the request completes
  278. // successfully.
  279. //
  280. // Use "Send" method on the returned Request to send the API call to the service.
  281. // the "output" return value is not valid until after Send returns without error.
  282. //
  283. // See DescribeUserHierarchyGroup for more information on using the DescribeUserHierarchyGroup
  284. // API call, and error handling.
  285. //
  286. // This method is useful when you want to inject custom logic or configuration
  287. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  288. //
  289. //
  290. // // Example sending a request using the DescribeUserHierarchyGroupRequest method.
  291. // req, resp := client.DescribeUserHierarchyGroupRequest(params)
  292. //
  293. // err := req.Send()
  294. // if err == nil { // resp is now filled
  295. // fmt.Println(resp)
  296. // }
  297. //
  298. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup
  299. func (c *Connect) DescribeUserHierarchyGroupRequest(input *DescribeUserHierarchyGroupInput) (req *request.Request, output *DescribeUserHierarchyGroupOutput) {
  300. op := &request.Operation{
  301. Name: opDescribeUserHierarchyGroup,
  302. HTTPMethod: "GET",
  303. HTTPPath: "/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}",
  304. }
  305. if input == nil {
  306. input = &DescribeUserHierarchyGroupInput{}
  307. }
  308. output = &DescribeUserHierarchyGroupOutput{}
  309. req = c.newRequest(op, input, output)
  310. return
  311. }
  312. // DescribeUserHierarchyGroup API operation for Amazon Connect Service.
  313. //
  314. // Returns a HierarchyGroup object that includes information about a hierarchy
  315. // group in your instance.
  316. //
  317. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  318. // with awserr.Error's Code and Message methods to get detailed information about
  319. // the error.
  320. //
  321. // See the AWS API reference guide for Amazon Connect Service's
  322. // API operation DescribeUserHierarchyGroup for usage and error information.
  323. //
  324. // Returned Error Codes:
  325. // * ErrCodeInvalidRequestException "InvalidRequestException"
  326. // The request is not valid.
  327. //
  328. // * ErrCodeInvalidParameterException "InvalidParameterException"
  329. // One or more of the parameters provided to the operation are not valid.
  330. //
  331. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  332. // The specified resource was not found.
  333. //
  334. // * ErrCodeThrottlingException "ThrottlingException"
  335. // The throttling limit has been exceeded.
  336. //
  337. // * ErrCodeInternalServiceException "InternalServiceException"
  338. // Request processing failed due to an error or failure with the service.
  339. //
  340. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup
  341. func (c *Connect) DescribeUserHierarchyGroup(input *DescribeUserHierarchyGroupInput) (*DescribeUserHierarchyGroupOutput, error) {
  342. req, out := c.DescribeUserHierarchyGroupRequest(input)
  343. return out, req.Send()
  344. }
  345. // DescribeUserHierarchyGroupWithContext is the same as DescribeUserHierarchyGroup with the addition of
  346. // the ability to pass a context and additional request options.
  347. //
  348. // See DescribeUserHierarchyGroup for details on how to use this API operation.
  349. //
  350. // The context must be non-nil and will be used for request cancellation. If
  351. // the context is nil a panic will occur. In the future the SDK may create
  352. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  353. // for more information on using Contexts.
  354. func (c *Connect) DescribeUserHierarchyGroupWithContext(ctx aws.Context, input *DescribeUserHierarchyGroupInput, opts ...request.Option) (*DescribeUserHierarchyGroupOutput, error) {
  355. req, out := c.DescribeUserHierarchyGroupRequest(input)
  356. req.SetContext(ctx)
  357. req.ApplyOptions(opts...)
  358. return out, req.Send()
  359. }
  360. const opDescribeUserHierarchyStructure = "DescribeUserHierarchyStructure"
  361. // DescribeUserHierarchyStructureRequest generates a "aws/request.Request" representing the
  362. // client's request for the DescribeUserHierarchyStructure operation. The "output" return
  363. // value will be populated with the request's response once the request completes
  364. // successfully.
  365. //
  366. // Use "Send" method on the returned Request to send the API call to the service.
  367. // the "output" return value is not valid until after Send returns without error.
  368. //
  369. // See DescribeUserHierarchyStructure for more information on using the DescribeUserHierarchyStructure
  370. // API call, and error handling.
  371. //
  372. // This method is useful when you want to inject custom logic or configuration
  373. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  374. //
  375. //
  376. // // Example sending a request using the DescribeUserHierarchyStructureRequest method.
  377. // req, resp := client.DescribeUserHierarchyStructureRequest(params)
  378. //
  379. // err := req.Send()
  380. // if err == nil { // resp is now filled
  381. // fmt.Println(resp)
  382. // }
  383. //
  384. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure
  385. func (c *Connect) DescribeUserHierarchyStructureRequest(input *DescribeUserHierarchyStructureInput) (req *request.Request, output *DescribeUserHierarchyStructureOutput) {
  386. op := &request.Operation{
  387. Name: opDescribeUserHierarchyStructure,
  388. HTTPMethod: "GET",
  389. HTTPPath: "/user-hierarchy-structure/{InstanceId}",
  390. }
  391. if input == nil {
  392. input = &DescribeUserHierarchyStructureInput{}
  393. }
  394. output = &DescribeUserHierarchyStructureOutput{}
  395. req = c.newRequest(op, input, output)
  396. return
  397. }
  398. // DescribeUserHierarchyStructure API operation for Amazon Connect Service.
  399. //
  400. // Returns a HiearchyGroupStructure object, which contains data about the levels
  401. // in the agent hierarchy.
  402. //
  403. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  404. // with awserr.Error's Code and Message methods to get detailed information about
  405. // the error.
  406. //
  407. // See the AWS API reference guide for Amazon Connect Service's
  408. // API operation DescribeUserHierarchyStructure for usage and error information.
  409. //
  410. // Returned Error Codes:
  411. // * ErrCodeInvalidRequestException "InvalidRequestException"
  412. // The request is not valid.
  413. //
  414. // * ErrCodeInvalidParameterException "InvalidParameterException"
  415. // One or more of the parameters provided to the operation are not valid.
  416. //
  417. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  418. // The specified resource was not found.
  419. //
  420. // * ErrCodeThrottlingException "ThrottlingException"
  421. // The throttling limit has been exceeded.
  422. //
  423. // * ErrCodeInternalServiceException "InternalServiceException"
  424. // Request processing failed due to an error or failure with the service.
  425. //
  426. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure
  427. func (c *Connect) DescribeUserHierarchyStructure(input *DescribeUserHierarchyStructureInput) (*DescribeUserHierarchyStructureOutput, error) {
  428. req, out := c.DescribeUserHierarchyStructureRequest(input)
  429. return out, req.Send()
  430. }
  431. // DescribeUserHierarchyStructureWithContext is the same as DescribeUserHierarchyStructure with the addition of
  432. // the ability to pass a context and additional request options.
  433. //
  434. // See DescribeUserHierarchyStructure for details on how to use this API operation.
  435. //
  436. // The context must be non-nil and will be used for request cancellation. If
  437. // the context is nil a panic will occur. In the future the SDK may create
  438. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  439. // for more information on using Contexts.
  440. func (c *Connect) DescribeUserHierarchyStructureWithContext(ctx aws.Context, input *DescribeUserHierarchyStructureInput, opts ...request.Option) (*DescribeUserHierarchyStructureOutput, error) {
  441. req, out := c.DescribeUserHierarchyStructureRequest(input)
  442. req.SetContext(ctx)
  443. req.ApplyOptions(opts...)
  444. return out, req.Send()
  445. }
  446. const opGetContactAttributes = "GetContactAttributes"
  447. // GetContactAttributesRequest generates a "aws/request.Request" representing the
  448. // client's request for the GetContactAttributes operation. The "output" return
  449. // value will be populated with the request's response once the request completes
  450. // successfully.
  451. //
  452. // Use "Send" method on the returned Request to send the API call to the service.
  453. // the "output" return value is not valid until after Send returns without error.
  454. //
  455. // See GetContactAttributes for more information on using the GetContactAttributes
  456. // API call, and error handling.
  457. //
  458. // This method is useful when you want to inject custom logic or configuration
  459. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  460. //
  461. //
  462. // // Example sending a request using the GetContactAttributesRequest method.
  463. // req, resp := client.GetContactAttributesRequest(params)
  464. //
  465. // err := req.Send()
  466. // if err == nil { // resp is now filled
  467. // fmt.Println(resp)
  468. // }
  469. //
  470. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributes
  471. func (c *Connect) GetContactAttributesRequest(input *GetContactAttributesInput) (req *request.Request, output *GetContactAttributesOutput) {
  472. op := &request.Operation{
  473. Name: opGetContactAttributes,
  474. HTTPMethod: "GET",
  475. HTTPPath: "/contact/attributes/{InstanceId}/{InitialContactId}",
  476. }
  477. if input == nil {
  478. input = &GetContactAttributesInput{}
  479. }
  480. output = &GetContactAttributesOutput{}
  481. req = c.newRequest(op, input, output)
  482. return
  483. }
  484. // GetContactAttributes API operation for Amazon Connect Service.
  485. //
  486. // Retrieves the contact attributes associated with a contact.
  487. //
  488. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  489. // with awserr.Error's Code and Message methods to get detailed information about
  490. // the error.
  491. //
  492. // See the AWS API reference guide for Amazon Connect Service's
  493. // API operation GetContactAttributes for usage and error information.
  494. //
  495. // Returned Error Codes:
  496. // * ErrCodeInvalidRequestException "InvalidRequestException"
  497. // The request is not valid.
  498. //
  499. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  500. // The specified resource was not found.
  501. //
  502. // * ErrCodeInternalServiceException "InternalServiceException"
  503. // Request processing failed due to an error or failure with the service.
  504. //
  505. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributes
  506. func (c *Connect) GetContactAttributes(input *GetContactAttributesInput) (*GetContactAttributesOutput, error) {
  507. req, out := c.GetContactAttributesRequest(input)
  508. return out, req.Send()
  509. }
  510. // GetContactAttributesWithContext is the same as GetContactAttributes with the addition of
  511. // the ability to pass a context and additional request options.
  512. //
  513. // See GetContactAttributes for details on how to use this API operation.
  514. //
  515. // The context must be non-nil and will be used for request cancellation. If
  516. // the context is nil a panic will occur. In the future the SDK may create
  517. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  518. // for more information on using Contexts.
  519. func (c *Connect) GetContactAttributesWithContext(ctx aws.Context, input *GetContactAttributesInput, opts ...request.Option) (*GetContactAttributesOutput, error) {
  520. req, out := c.GetContactAttributesRequest(input)
  521. req.SetContext(ctx)
  522. req.ApplyOptions(opts...)
  523. return out, req.Send()
  524. }
  525. const opGetCurrentMetricData = "GetCurrentMetricData"
  526. // GetCurrentMetricDataRequest generates a "aws/request.Request" representing the
  527. // client's request for the GetCurrentMetricData operation. The "output" return
  528. // value will be populated with the request's response once the request completes
  529. // successfully.
  530. //
  531. // Use "Send" method on the returned Request to send the API call to the service.
  532. // the "output" return value is not valid until after Send returns without error.
  533. //
  534. // See GetCurrentMetricData for more information on using the GetCurrentMetricData
  535. // API call, and error handling.
  536. //
  537. // This method is useful when you want to inject custom logic or configuration
  538. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  539. //
  540. //
  541. // // Example sending a request using the GetCurrentMetricDataRequest method.
  542. // req, resp := client.GetCurrentMetricDataRequest(params)
  543. //
  544. // err := req.Send()
  545. // if err == nil { // resp is now filled
  546. // fmt.Println(resp)
  547. // }
  548. //
  549. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricData
  550. func (c *Connect) GetCurrentMetricDataRequest(input *GetCurrentMetricDataInput) (req *request.Request, output *GetCurrentMetricDataOutput) {
  551. op := &request.Operation{
  552. Name: opGetCurrentMetricData,
  553. HTTPMethod: "POST",
  554. HTTPPath: "/metrics/current/{InstanceId}",
  555. Paginator: &request.Paginator{
  556. InputTokens: []string{"NextToken"},
  557. OutputTokens: []string{"NextToken"},
  558. LimitToken: "MaxResults",
  559. TruncationToken: "",
  560. },
  561. }
  562. if input == nil {
  563. input = &GetCurrentMetricDataInput{}
  564. }
  565. output = &GetCurrentMetricDataOutput{}
  566. req = c.newRequest(op, input, output)
  567. return
  568. }
  569. // GetCurrentMetricData API operation for Amazon Connect Service.
  570. //
  571. // The GetCurrentMetricData operation retrieves current metric data from your
  572. // Amazon Connect instance.
  573. //
  574. // If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData
  575. // action.
  576. //
  577. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  578. // with awserr.Error's Code and Message methods to get detailed information about
  579. // the error.
  580. //
  581. // See the AWS API reference guide for Amazon Connect Service's
  582. // API operation GetCurrentMetricData for usage and error information.
  583. //
  584. // Returned Error Codes:
  585. // * ErrCodeInvalidRequestException "InvalidRequestException"
  586. // The request is not valid.
  587. //
  588. // * ErrCodeInvalidParameterException "InvalidParameterException"
  589. // One or more of the parameters provided to the operation are not valid.
  590. //
  591. // * ErrCodeInternalServiceException "InternalServiceException"
  592. // Request processing failed due to an error or failure with the service.
  593. //
  594. // * ErrCodeThrottlingException "ThrottlingException"
  595. // The throttling limit has been exceeded.
  596. //
  597. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  598. // The specified resource was not found.
  599. //
  600. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricData
  601. func (c *Connect) GetCurrentMetricData(input *GetCurrentMetricDataInput) (*GetCurrentMetricDataOutput, error) {
  602. req, out := c.GetCurrentMetricDataRequest(input)
  603. return out, req.Send()
  604. }
  605. // GetCurrentMetricDataWithContext is the same as GetCurrentMetricData with the addition of
  606. // the ability to pass a context and additional request options.
  607. //
  608. // See GetCurrentMetricData for details on how to use this API operation.
  609. //
  610. // The context must be non-nil and will be used for request cancellation. If
  611. // the context is nil a panic will occur. In the future the SDK may create
  612. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  613. // for more information on using Contexts.
  614. func (c *Connect) GetCurrentMetricDataWithContext(ctx aws.Context, input *GetCurrentMetricDataInput, opts ...request.Option) (*GetCurrentMetricDataOutput, error) {
  615. req, out := c.GetCurrentMetricDataRequest(input)
  616. req.SetContext(ctx)
  617. req.ApplyOptions(opts...)
  618. return out, req.Send()
  619. }
  620. // GetCurrentMetricDataPages iterates over the pages of a GetCurrentMetricData operation,
  621. // calling the "fn" function with the response data for each page. To stop
  622. // iterating, return false from the fn function.
  623. //
  624. // See GetCurrentMetricData method for more information on how to use this operation.
  625. //
  626. // Note: This operation can generate multiple requests to a service.
  627. //
  628. // // Example iterating over at most 3 pages of a GetCurrentMetricData operation.
  629. // pageNum := 0
  630. // err := client.GetCurrentMetricDataPages(params,
  631. // func(page *GetCurrentMetricDataOutput, lastPage bool) bool {
  632. // pageNum++
  633. // fmt.Println(page)
  634. // return pageNum <= 3
  635. // })
  636. //
  637. func (c *Connect) GetCurrentMetricDataPages(input *GetCurrentMetricDataInput, fn func(*GetCurrentMetricDataOutput, bool) bool) error {
  638. return c.GetCurrentMetricDataPagesWithContext(aws.BackgroundContext(), input, fn)
  639. }
  640. // GetCurrentMetricDataPagesWithContext same as GetCurrentMetricDataPages except
  641. // it takes a Context and allows setting request options on the pages.
  642. //
  643. // The context must be non-nil and will be used for request cancellation. If
  644. // the context is nil a panic will occur. In the future the SDK may create
  645. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  646. // for more information on using Contexts.
  647. func (c *Connect) GetCurrentMetricDataPagesWithContext(ctx aws.Context, input *GetCurrentMetricDataInput, fn func(*GetCurrentMetricDataOutput, bool) bool, opts ...request.Option) error {
  648. p := request.Pagination{
  649. NewRequest: func() (*request.Request, error) {
  650. var inCpy *GetCurrentMetricDataInput
  651. if input != nil {
  652. tmp := *input
  653. inCpy = &tmp
  654. }
  655. req, _ := c.GetCurrentMetricDataRequest(inCpy)
  656. req.SetContext(ctx)
  657. req.ApplyOptions(opts...)
  658. return req, nil
  659. },
  660. }
  661. cont := true
  662. for p.Next() && cont {
  663. cont = fn(p.Page().(*GetCurrentMetricDataOutput), !p.HasNextPage())
  664. }
  665. return p.Err()
  666. }
  667. const opGetFederationToken = "GetFederationToken"
  668. // GetFederationTokenRequest generates a "aws/request.Request" representing the
  669. // client's request for the GetFederationToken operation. The "output" return
  670. // value will be populated with the request's response once the request completes
  671. // successfully.
  672. //
  673. // Use "Send" method on the returned Request to send the API call to the service.
  674. // the "output" return value is not valid until after Send returns without error.
  675. //
  676. // See GetFederationToken for more information on using the GetFederationToken
  677. // API call, and error handling.
  678. //
  679. // This method is useful when you want to inject custom logic or configuration
  680. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  681. //
  682. //
  683. // // Example sending a request using the GetFederationTokenRequest method.
  684. // req, resp := client.GetFederationTokenRequest(params)
  685. //
  686. // err := req.Send()
  687. // if err == nil { // resp is now filled
  688. // fmt.Println(resp)
  689. // }
  690. //
  691. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationToken
  692. func (c *Connect) GetFederationTokenRequest(input *GetFederationTokenInput) (req *request.Request, output *GetFederationTokenOutput) {
  693. op := &request.Operation{
  694. Name: opGetFederationToken,
  695. HTTPMethod: "GET",
  696. HTTPPath: "/user/federate/{InstanceId}",
  697. }
  698. if input == nil {
  699. input = &GetFederationTokenInput{}
  700. }
  701. output = &GetFederationTokenOutput{}
  702. req = c.newRequest(op, input, output)
  703. return
  704. }
  705. // GetFederationToken API operation for Amazon Connect Service.
  706. //
  707. // Retrieves a token for federation.
  708. //
  709. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  710. // with awserr.Error's Code and Message methods to get detailed information about
  711. // the error.
  712. //
  713. // See the AWS API reference guide for Amazon Connect Service's
  714. // API operation GetFederationToken for usage and error information.
  715. //
  716. // Returned Error Codes:
  717. // * ErrCodeInvalidRequestException "InvalidRequestException"
  718. // The request is not valid.
  719. //
  720. // * ErrCodeInvalidParameterException "InvalidParameterException"
  721. // One or more of the parameters provided to the operation are not valid.
  722. //
  723. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  724. // The specified resource was not found.
  725. //
  726. // * ErrCodeUserNotFoundException "UserNotFoundException"
  727. // No user with the specified credentials was found in the Amazon Connect instance.
  728. //
  729. // * ErrCodeInternalServiceException "InternalServiceException"
  730. // Request processing failed due to an error or failure with the service.
  731. //
  732. // * ErrCodeDuplicateResourceException "DuplicateResourceException"
  733. // A resource with that name already exists.
  734. //
  735. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationToken
  736. func (c *Connect) GetFederationToken(input *GetFederationTokenInput) (*GetFederationTokenOutput, error) {
  737. req, out := c.GetFederationTokenRequest(input)
  738. return out, req.Send()
  739. }
  740. // GetFederationTokenWithContext is the same as GetFederationToken with the addition of
  741. // the ability to pass a context and additional request options.
  742. //
  743. // See GetFederationToken for details on how to use this API operation.
  744. //
  745. // The context must be non-nil and will be used for request cancellation. If
  746. // the context is nil a panic will occur. In the future the SDK may create
  747. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  748. // for more information on using Contexts.
  749. func (c *Connect) GetFederationTokenWithContext(ctx aws.Context, input *GetFederationTokenInput, opts ...request.Option) (*GetFederationTokenOutput, error) {
  750. req, out := c.GetFederationTokenRequest(input)
  751. req.SetContext(ctx)
  752. req.ApplyOptions(opts...)
  753. return out, req.Send()
  754. }
  755. const opGetMetricData = "GetMetricData"
  756. // GetMetricDataRequest generates a "aws/request.Request" representing the
  757. // client's request for the GetMetricData operation. The "output" return
  758. // value will be populated with the request's response once the request completes
  759. // successfully.
  760. //
  761. // Use "Send" method on the returned Request to send the API call to the service.
  762. // the "output" return value is not valid until after Send returns without error.
  763. //
  764. // See GetMetricData for more information on using the GetMetricData
  765. // API call, and error handling.
  766. //
  767. // This method is useful when you want to inject custom logic or configuration
  768. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  769. //
  770. //
  771. // // Example sending a request using the GetMetricDataRequest method.
  772. // req, resp := client.GetMetricDataRequest(params)
  773. //
  774. // err := req.Send()
  775. // if err == nil { // resp is now filled
  776. // fmt.Println(resp)
  777. // }
  778. //
  779. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData
  780. func (c *Connect) GetMetricDataRequest(input *GetMetricDataInput) (req *request.Request, output *GetMetricDataOutput) {
  781. op := &request.Operation{
  782. Name: opGetMetricData,
  783. HTTPMethod: "POST",
  784. HTTPPath: "/metrics/historical/{InstanceId}",
  785. Paginator: &request.Paginator{
  786. InputTokens: []string{"NextToken"},
  787. OutputTokens: []string{"NextToken"},
  788. LimitToken: "MaxResults",
  789. TruncationToken: "",
  790. },
  791. }
  792. if input == nil {
  793. input = &GetMetricDataInput{}
  794. }
  795. output = &GetMetricDataOutput{}
  796. req = c.newRequest(op, input, output)
  797. return
  798. }
  799. // GetMetricData API operation for Amazon Connect Service.
  800. //
  801. // The GetMetricData operation retrieves historical metrics data from your Amazon
  802. // Connect instance.
  803. //
  804. // If you are using an IAM account, it must have permission to the connect:GetMetricData
  805. // action.
  806. //
  807. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  808. // with awserr.Error's Code and Message methods to get detailed information about
  809. // the error.
  810. //
  811. // See the AWS API reference guide for Amazon Connect Service's
  812. // API operation GetMetricData for usage and error information.
  813. //
  814. // Returned Error Codes:
  815. // * ErrCodeInvalidRequestException "InvalidRequestException"
  816. // The request is not valid.
  817. //
  818. // * ErrCodeInvalidParameterException "InvalidParameterException"
  819. // One or more of the parameters provided to the operation are not valid.
  820. //
  821. // * ErrCodeInternalServiceException "InternalServiceException"
  822. // Request processing failed due to an error or failure with the service.
  823. //
  824. // * ErrCodeThrottlingException "ThrottlingException"
  825. // The throttling limit has been exceeded.
  826. //
  827. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  828. // The specified resource was not found.
  829. //
  830. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData
  831. func (c *Connect) GetMetricData(input *GetMetricDataInput) (*GetMetricDataOutput, error) {
  832. req, out := c.GetMetricDataRequest(input)
  833. return out, req.Send()
  834. }
  835. // GetMetricDataWithContext is the same as GetMetricData with the addition of
  836. // the ability to pass a context and additional request options.
  837. //
  838. // See GetMetricData for details on how to use this API operation.
  839. //
  840. // The context must be non-nil and will be used for request cancellation. If
  841. // the context is nil a panic will occur. In the future the SDK may create
  842. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  843. // for more information on using Contexts.
  844. func (c *Connect) GetMetricDataWithContext(ctx aws.Context, input *GetMetricDataInput, opts ...request.Option) (*GetMetricDataOutput, error) {
  845. req, out := c.GetMetricDataRequest(input)
  846. req.SetContext(ctx)
  847. req.ApplyOptions(opts...)
  848. return out, req.Send()
  849. }
  850. // GetMetricDataPages iterates over the pages of a GetMetricData operation,
  851. // calling the "fn" function with the response data for each page. To stop
  852. // iterating, return false from the fn function.
  853. //
  854. // See GetMetricData method for more information on how to use this operation.
  855. //
  856. // Note: This operation can generate multiple requests to a service.
  857. //
  858. // // Example iterating over at most 3 pages of a GetMetricData operation.
  859. // pageNum := 0
  860. // err := client.GetMetricDataPages(params,
  861. // func(page *GetMetricDataOutput, lastPage bool) bool {
  862. // pageNum++
  863. // fmt.Println(page)
  864. // return pageNum <= 3
  865. // })
  866. //
  867. func (c *Connect) GetMetricDataPages(input *GetMetricDataInput, fn func(*GetMetricDataOutput, bool) bool) error {
  868. return c.GetMetricDataPagesWithContext(aws.BackgroundContext(), input, fn)
  869. }
  870. // GetMetricDataPagesWithContext same as GetMetricDataPages except
  871. // it takes a Context and allows setting request options on the pages.
  872. //
  873. // The context must be non-nil and will be used for request cancellation. If
  874. // the context is nil a panic will occur. In the future the SDK may create
  875. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  876. // for more information on using Contexts.
  877. func (c *Connect) GetMetricDataPagesWithContext(ctx aws.Context, input *GetMetricDataInput, fn func(*GetMetricDataOutput, bool) bool, opts ...request.Option) error {
  878. p := request.Pagination{
  879. NewRequest: func() (*request.Request, error) {
  880. var inCpy *GetMetricDataInput
  881. if input != nil {
  882. tmp := *input
  883. inCpy = &tmp
  884. }
  885. req, _ := c.GetMetricDataRequest(inCpy)
  886. req.SetContext(ctx)
  887. req.ApplyOptions(opts...)
  888. return req, nil
  889. },
  890. }
  891. cont := true
  892. for p.Next() && cont {
  893. cont = fn(p.Page().(*GetMetricDataOutput), !p.HasNextPage())
  894. }
  895. return p.Err()
  896. }
  897. const opListRoutingProfiles = "ListRoutingProfiles"
  898. // ListRoutingProfilesRequest generates a "aws/request.Request" representing the
  899. // client's request for the ListRoutingProfiles operation. The "output" return
  900. // value will be populated with the request's response once the request completes
  901. // successfully.
  902. //
  903. // Use "Send" method on the returned Request to send the API call to the service.
  904. // the "output" return value is not valid until after Send returns without error.
  905. //
  906. // See ListRoutingProfiles for more information on using the ListRoutingProfiles
  907. // API call, and error handling.
  908. //
  909. // This method is useful when you want to inject custom logic or configuration
  910. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  911. //
  912. //
  913. // // Example sending a request using the ListRoutingProfilesRequest method.
  914. // req, resp := client.ListRoutingProfilesRequest(params)
  915. //
  916. // err := req.Send()
  917. // if err == nil { // resp is now filled
  918. // fmt.Println(resp)
  919. // }
  920. //
  921. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles
  922. func (c *Connect) ListRoutingProfilesRequest(input *ListRoutingProfilesInput) (req *request.Request, output *ListRoutingProfilesOutput) {
  923. op := &request.Operation{
  924. Name: opListRoutingProfiles,
  925. HTTPMethod: "GET",
  926. HTTPPath: "/routing-profiles-summary/{InstanceId}",
  927. }
  928. if input == nil {
  929. input = &ListRoutingProfilesInput{}
  930. }
  931. output = &ListRoutingProfilesOutput{}
  932. req = c.newRequest(op, input, output)
  933. return
  934. }
  935. // ListRoutingProfiles API operation for Amazon Connect Service.
  936. //
  937. // Returns an array of RoutingProfileSummary objects that includes information
  938. // about the routing profiles in your instance.
  939. //
  940. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  941. // with awserr.Error's Code and Message methods to get detailed information about
  942. // the error.
  943. //
  944. // See the AWS API reference guide for Amazon Connect Service's
  945. // API operation ListRoutingProfiles for usage and error information.
  946. //
  947. // Returned Error Codes:
  948. // * ErrCodeInvalidRequestException "InvalidRequestException"
  949. // The request is not valid.
  950. //
  951. // * ErrCodeInvalidParameterException "InvalidParameterException"
  952. // One or more of the parameters provided to the operation are not valid.
  953. //
  954. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  955. // The specified resource was not found.
  956. //
  957. // * ErrCodeThrottlingException "ThrottlingException"
  958. // The throttling limit has been exceeded.
  959. //
  960. // * ErrCodeInternalServiceException "InternalServiceException"
  961. // Request processing failed due to an error or failure with the service.
  962. //
  963. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles
  964. func (c *Connect) ListRoutingProfiles(input *ListRoutingProfilesInput) (*ListRoutingProfilesOutput, error) {
  965. req, out := c.ListRoutingProfilesRequest(input)
  966. return out, req.Send()
  967. }
  968. // ListRoutingProfilesWithContext is the same as ListRoutingProfiles with the addition of
  969. // the ability to pass a context and additional request options.
  970. //
  971. // See ListRoutingProfiles for details on how to use this API operation.
  972. //
  973. // The context must be non-nil and will be used for request cancellation. If
  974. // the context is nil a panic will occur. In the future the SDK may create
  975. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  976. // for more information on using Contexts.
  977. func (c *Connect) ListRoutingProfilesWithContext(ctx aws.Context, input *ListRoutingProfilesInput, opts ...request.Option) (*ListRoutingProfilesOutput, error) {
  978. req, out := c.ListRoutingProfilesRequest(input)
  979. req.SetContext(ctx)
  980. req.ApplyOptions(opts...)
  981. return out, req.Send()
  982. }
  983. const opListSecurityProfiles = "ListSecurityProfiles"
  984. // ListSecurityProfilesRequest generates a "aws/request.Request" representing the
  985. // client's request for the ListSecurityProfiles operation. The "output" return
  986. // value will be populated with the request's response once the request completes
  987. // successfully.
  988. //
  989. // Use "Send" method on the returned Request to send the API call to the service.
  990. // the "output" return value is not valid until after Send returns without error.
  991. //
  992. // See ListSecurityProfiles for more information on using the ListSecurityProfiles
  993. // API call, and error handling.
  994. //
  995. // This method is useful when you want to inject custom logic or configuration
  996. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  997. //
  998. //
  999. // // Example sending a request using the ListSecurityProfilesRequest method.
  1000. // req, resp := client.ListSecurityProfilesRequest(params)
  1001. //
  1002. // err := req.Send()
  1003. // if err == nil { // resp is now filled
  1004. // fmt.Println(resp)
  1005. // }
  1006. //
  1007. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfiles
  1008. func (c *Connect) ListSecurityProfilesRequest(input *ListSecurityProfilesInput) (req *request.Request, output *ListSecurityProfilesOutput) {
  1009. op := &request.Operation{
  1010. Name: opListSecurityProfiles,
  1011. HTTPMethod: "GET",
  1012. HTTPPath: "/security-profiles-summary/{InstanceId}",
  1013. }
  1014. if input == nil {
  1015. input = &ListSecurityProfilesInput{}
  1016. }
  1017. output = &ListSecurityProfilesOutput{}
  1018. req = c.newRequest(op, input, output)
  1019. return
  1020. }
  1021. // ListSecurityProfiles API operation for Amazon Connect Service.
  1022. //
  1023. // Returns an array of SecurityProfileSummary objects that contain information
  1024. // about the security profiles in your instance, including the ARN, Id, and
  1025. // Name of the security profile.
  1026. //
  1027. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  1028. // with awserr.Error's Code and Message methods to get detailed information about
  1029. // the error.
  1030. //
  1031. // See the AWS API reference guide for Amazon Connect Service's
  1032. // API operation ListSecurityProfiles for usage and error information.
  1033. //
  1034. // Returned Error Codes:
  1035. // * ErrCodeInvalidRequestException "InvalidRequestException"
  1036. // The request is not valid.
  1037. //
  1038. // * ErrCodeInvalidParameterException "InvalidParameterException"
  1039. // One or more of the parameters provided to the operation are not valid.
  1040. //
  1041. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  1042. // The specified resource was not found.
  1043. //
  1044. // * ErrCodeThrottlingException "ThrottlingException"
  1045. // The throttling limit has been exceeded.
  1046. //
  1047. // * ErrCodeInternalServiceException "InternalServiceException"
  1048. // Request processing failed due to an error or failure with the service.
  1049. //
  1050. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfiles
  1051. func (c *Connect) ListSecurityProfiles(input *ListSecurityProfilesInput) (*ListSecurityProfilesOutput, error) {
  1052. req, out := c.ListSecurityProfilesRequest(input)
  1053. return out, req.Send()
  1054. }
  1055. // ListSecurityProfilesWithContext is the same as ListSecurityProfiles with the addition of
  1056. // the ability to pass a context and additional request options.
  1057. //
  1058. // See ListSecurityProfiles for details on how to use this API operation.
  1059. //
  1060. // The context must be non-nil and will be used for request cancellation. If
  1061. // the context is nil a panic will occur. In the future the SDK may create
  1062. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  1063. // for more information on using Contexts.
  1064. func (c *Connect) ListSecurityProfilesWithContext(ctx aws.Context, input *ListSecurityProfilesInput, opts ...request.Option) (*ListSecurityProfilesOutput, error) {
  1065. req, out := c.ListSecurityProfilesRequest(input)
  1066. req.SetContext(ctx)
  1067. req.ApplyOptions(opts...)
  1068. return out, req.Send()
  1069. }
  1070. const opListUserHierarchyGroups = "ListUserHierarchyGroups"
  1071. // ListUserHierarchyGroupsRequest generates a "aws/request.Request" representing the
  1072. // client's request for the ListUserHierarchyGroups operation. The "output" return
  1073. // value will be populated with the request's response once the request completes
  1074. // successfully.
  1075. //
  1076. // Use "Send" method on the returned Request to send the API call to the service.
  1077. // the "output" return value is not valid until after Send returns without error.
  1078. //
  1079. // See ListUserHierarchyGroups for more information on using the ListUserHierarchyGroups
  1080. // API call, and error handling.
  1081. //
  1082. // This method is useful when you want to inject custom logic or configuration
  1083. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  1084. //
  1085. //
  1086. // // Example sending a request using the ListUserHierarchyGroupsRequest method.
  1087. // req, resp := client.ListUserHierarchyGroupsRequest(params)
  1088. //
  1089. // err := req.Send()
  1090. // if err == nil { // resp is now filled
  1091. // fmt.Println(resp)
  1092. // }
  1093. //
  1094. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroups
  1095. func (c *Connect) ListUserHierarchyGroupsRequest(input *ListUserHierarchyGroupsInput) (req *request.Request, output *ListUserHierarchyGroupsOutput) {
  1096. op := &request.Operation{
  1097. Name: opListUserHierarchyGroups,
  1098. HTTPMethod: "GET",
  1099. HTTPPath: "/user-hierarchy-groups-summary/{InstanceId}",
  1100. }
  1101. if input == nil {
  1102. input = &ListUserHierarchyGroupsInput{}
  1103. }
  1104. output = &ListUserHierarchyGroupsOutput{}
  1105. req = c.newRequest(op, input, output)
  1106. return
  1107. }
  1108. // ListUserHierarchyGroups API operation for Amazon Connect Service.
  1109. //
  1110. // Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary
  1111. // objects that contain information about the hierarchy groups in your instance.
  1112. //
  1113. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  1114. // with awserr.Error's Code and Message methods to get detailed information about
  1115. // the error.
  1116. //
  1117. // See the AWS API reference guide for Amazon Connect Service's
  1118. // API operation ListUserHierarchyGroups for usage and error information.
  1119. //
  1120. // Returned Error Codes:
  1121. // * ErrCodeInvalidRequestException "InvalidRequestException"
  1122. // The request is not valid.
  1123. //
  1124. // * ErrCodeInvalidParameterException "InvalidParameterException"
  1125. // One or more of the parameters provided to the operation are not valid.
  1126. //
  1127. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  1128. // The specified resource was not found.
  1129. //
  1130. // * ErrCodeThrottlingException "ThrottlingException"
  1131. // The throttling limit has been exceeded.
  1132. //
  1133. // * ErrCodeInternalServiceException "InternalServiceException"
  1134. // Request processing failed due to an error or failure with the service.
  1135. //
  1136. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroups
  1137. func (c *Connect) ListUserHierarchyGroups(input *ListUserHierarchyGroupsInput) (*ListUserHierarchyGroupsOutput, error) {
  1138. req, out := c.ListUserHierarchyGroupsRequest(input)
  1139. return out, req.Send()
  1140. }
  1141. // ListUserHierarchyGroupsWithContext is the same as ListUserHierarchyGroups with the addition of
  1142. // the ability to pass a context and additional request options.
  1143. //
  1144. // See ListUserHierarchyGroups for details on how to use this API operation.
  1145. //
  1146. // The context must be non-nil and will be used for request cancellation. If
  1147. // the context is nil a panic will occur. In the future the SDK may create
  1148. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  1149. // for more information on using Contexts.
  1150. func (c *Connect) ListUserHierarchyGroupsWithContext(ctx aws.Context, input *ListUserHierarchyGroupsInput, opts ...request.Option) (*ListUserHierarchyGroupsOutput, error) {
  1151. req, out := c.ListUserHierarchyGroupsRequest(input)
  1152. req.SetContext(ctx)
  1153. req.ApplyOptions(opts...)
  1154. return out, req.Send()
  1155. }
  1156. const opListUsers = "ListUsers"
  1157. // ListUsersRequest generates a "aws/request.Request" representing the
  1158. // client's request for the ListUsers operation. The "output" return
  1159. // value will be populated with the request's response once the request completes
  1160. // successfully.
  1161. //
  1162. // Use "Send" method on the returned Request to send the API call to the service.
  1163. // the "output" return value is not valid until after Send returns without error.
  1164. //
  1165. // See ListUsers for more information on using the ListUsers
  1166. // API call, and error handling.
  1167. //
  1168. // This method is useful when you want to inject custom logic or configuration
  1169. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  1170. //
  1171. //
  1172. // // Example sending a request using the ListUsersRequest method.
  1173. // req, resp := client.ListUsersRequest(params)
  1174. //
  1175. // err := req.Send()
  1176. // if err == nil { // resp is now filled
  1177. // fmt.Println(resp)
  1178. // }
  1179. //
  1180. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsers
  1181. func (c *Connect) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput) {
  1182. op := &request.Operation{
  1183. Name: opListUsers,
  1184. HTTPMethod: "GET",
  1185. HTTPPath: "/users-summary/{InstanceId}",
  1186. }
  1187. if input == nil {
  1188. input = &ListUsersInput{}
  1189. }
  1190. output = &ListUsersOutput{}
  1191. req = c.newRequest(op, input, output)
  1192. return
  1193. }
  1194. // ListUsers API operation for Amazon Connect Service.
  1195. //
  1196. // Returns a UserSummaryList, which is an array of UserSummary objects.
  1197. //
  1198. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  1199. // with awserr.Error's Code and Message methods to get detailed information about
  1200. // the error.
  1201. //
  1202. // See the AWS API reference guide for Amazon Connect Service's
  1203. // API operation ListUsers for usage and error information.
  1204. //
  1205. // Returned Error Codes:
  1206. // * ErrCodeInvalidRequestException "InvalidRequestException"
  1207. // The request is not valid.
  1208. //
  1209. // * ErrCodeInvalidParameterException "InvalidParameterException"
  1210. // One or more of the parameters provided to the operation are not valid.
  1211. //
  1212. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  1213. // The specified resource was not found.
  1214. //
  1215. // * ErrCodeThrottlingException "ThrottlingException"
  1216. // The throttling limit has been exceeded.
  1217. //
  1218. // * ErrCodeInternalServiceException "InternalServiceException"
  1219. // Request processing failed due to an error or failure with the service.
  1220. //
  1221. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsers
  1222. func (c *Connect) ListUsers(input *ListUsersInput) (*ListUsersOutput, error) {
  1223. req, out := c.ListUsersRequest(input)
  1224. return out, req.Send()
  1225. }
  1226. // ListUsersWithContext is the same as ListUsers with the addition of
  1227. // the ability to pass a context and additional request options.
  1228. //
  1229. // See ListUsers for details on how to use this API operation.
  1230. //
  1231. // The context must be non-nil and will be used for request cancellation. If
  1232. // the context is nil a panic will occur. In the future the SDK may create
  1233. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  1234. // for more information on using Contexts.
  1235. func (c *Connect) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error) {
  1236. req, out := c.ListUsersRequest(input)
  1237. req.SetContext(ctx)
  1238. req.ApplyOptions(opts...)
  1239. return out, req.Send()
  1240. }
  1241. const opStartOutboundVoiceContact = "StartOutboundVoiceContact"
  1242. // StartOutboundVoiceContactRequest generates a "aws/request.Request" representing the
  1243. // client's request for the StartOutboundVoiceContact operation. The "output" return
  1244. // value will be populated with the request's response once the request completes
  1245. // successfully.
  1246. //
  1247. // Use "Send" method on the returned Request to send the API call to the service.
  1248. // the "output" return value is not valid until after Send returns without error.
  1249. //
  1250. // See StartOutboundVoiceContact for more information on using the StartOutboundVoiceContact
  1251. // API call, and error handling.
  1252. //
  1253. // This method is useful when you want to inject custom logic or configuration
  1254. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  1255. //
  1256. //
  1257. // // Example sending a request using the StartOutboundVoiceContactRequest method.
  1258. // req, resp := client.StartOutboundVoiceContactRequest(params)
  1259. //
  1260. // err := req.Send()
  1261. // if err == nil { // resp is now filled
  1262. // fmt.Println(resp)
  1263. // }
  1264. //
  1265. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact
  1266. func (c *Connect) StartOutboundVoiceContactRequest(input *StartOutboundVoiceContactInput) (req *request.Request, output *StartOutboundVoiceContactOutput) {
  1267. op := &request.Operation{
  1268. Name: opStartOutboundVoiceContact,
  1269. HTTPMethod: "PUT",
  1270. HTTPPath: "/contact/outbound-voice",
  1271. }
  1272. if input == nil {
  1273. input = &StartOutboundVoiceContactInput{}
  1274. }
  1275. output = &StartOutboundVoiceContactOutput{}
  1276. req = c.newRequest(op, input, output)
  1277. return
  1278. }
  1279. // StartOutboundVoiceContact API operation for Amazon Connect Service.
  1280. //
  1281. // The StartOutboundVoiceContact operation initiates a contact flow to place
  1282. // an outbound call to a customer.
  1283. //
  1284. // If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact
  1285. // action.
  1286. //
  1287. // There is a 60 second dialing timeout for this operation. If the call is not
  1288. // connected after 60 seconds, the call fails.
  1289. //
  1290. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  1291. // with awserr.Error's Code and Message methods to get detailed information about
  1292. // the error.
  1293. //
  1294. // See the AWS API reference guide for Amazon Connect Service's
  1295. // API operation StartOutboundVoiceContact for usage and error information.
  1296. //
  1297. // Returned Error Codes:
  1298. // * ErrCodeInvalidRequestException "InvalidRequestException"
  1299. // The request is not valid.
  1300. //
  1301. // * ErrCodeInvalidParameterException "InvalidParameterException"
  1302. // One or more of the parameters provided to the operation are not valid.
  1303. //
  1304. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  1305. // The specified resource was not found.
  1306. //
  1307. // * ErrCodeInternalServiceException "InternalServiceException"
  1308. // Request processing failed due to an error or failure with the service.
  1309. //
  1310. // * ErrCodeLimitExceededException "LimitExceededException"
  1311. // The allowed limit for the resource has been reached.
  1312. //
  1313. // * ErrCodeDestinationNotAllowedException "DestinationNotAllowedException"
  1314. // Outbound calls to the destination number are not allowed.
  1315. //
  1316. // * ErrCodeOutboundContactNotPermittedException "OutboundContactNotPermittedException"
  1317. // The contact is not permitted.
  1318. //
  1319. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact
  1320. func (c *Connect) StartOutboundVoiceContact(input *StartOutboundVoiceContactInput) (*StartOutboundVoiceContactOutput, error) {
  1321. req, out := c.StartOutboundVoiceContactRequest(input)
  1322. return out, req.Send()
  1323. }
  1324. // StartOutboundVoiceContactWithContext is the same as StartOutboundVoiceContact with the addition of
  1325. // the ability to pass a context and additional request options.
  1326. //
  1327. // See StartOutboundVoiceContact for details on how to use this API operation.
  1328. //
  1329. // The context must be non-nil and will be used for request cancellation. If
  1330. // the context is nil a panic will occur. In the future the SDK may create
  1331. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  1332. // for more information on using Contexts.
  1333. func (c *Connect) StartOutboundVoiceContactWithContext(ctx aws.Context, input *StartOutboundVoiceContactInput, opts ...request.Option) (*StartOutboundVoiceContactOutput, error) {
  1334. req, out := c.StartOutboundVoiceContactRequest(input)
  1335. req.SetContext(ctx)
  1336. req.ApplyOptions(opts...)
  1337. return out, req.Send()
  1338. }
  1339. const opStopContact = "StopContact"
  1340. // StopContactRequest generates a "aws/request.Request" representing the
  1341. // client's request for the StopContact operation. The "output" return
  1342. // value will be populated with the request's response once the request completes
  1343. // successfully.
  1344. //
  1345. // Use "Send" method on the returned Request to send the API call to the service.
  1346. // the "output" return value is not valid until after Send returns without error.
  1347. //
  1348. // See StopContact for more information on using the StopContact
  1349. // API call, and error handling.
  1350. //
  1351. // This method is useful when you want to inject custom logic or configuration
  1352. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  1353. //
  1354. //
  1355. // // Example sending a request using the StopContactRequest method.
  1356. // req, resp := client.StopContactRequest(params)
  1357. //
  1358. // err := req.Send()
  1359. // if err == nil { // resp is now filled
  1360. // fmt.Println(resp)
  1361. // }
  1362. //
  1363. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact
  1364. func (c *Connect) StopContactRequest(input *StopContactInput) (req *request.Request, output *StopContactOutput) {
  1365. op := &request.Operation{
  1366. Name: opStopContact,
  1367. HTTPMethod: "POST",
  1368. HTTPPath: "/contact/stop",
  1369. }
  1370. if input == nil {
  1371. input = &StopContactInput{}
  1372. }
  1373. output = &StopContactOutput{}
  1374. req = c.newRequest(op, input, output)
  1375. req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
  1376. return
  1377. }
  1378. // StopContact API operation for Amazon Connect Service.
  1379. //
  1380. // Ends the contact initiated by the StartOutboundVoiceContact operation.
  1381. //
  1382. // If you are using an IAM account, it must have permission to the connect:StopContact
  1383. // action.
  1384. //
  1385. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  1386. // with awserr.Error's Code and Message methods to get detailed information about
  1387. // the error.
  1388. //
  1389. // See the AWS API reference guide for Amazon Connect Service's
  1390. // API operation StopContact for usage and error information.
  1391. //
  1392. // Returned Error Codes:
  1393. // * ErrCodeInvalidRequestException "InvalidRequestException"
  1394. // The request is not valid.
  1395. //
  1396. // * ErrCodeContactNotFoundException "ContactNotFoundException"
  1397. // The contact with the specified ID is not active or does not exist.
  1398. //
  1399. // * ErrCodeInvalidParameterException "InvalidParameterException"
  1400. // One or more of the parameters provided to the operation are not valid.
  1401. //
  1402. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  1403. // The specified resource was not found.
  1404. //
  1405. // * ErrCodeInternalServiceException "InternalServiceException"
  1406. // Request processing failed due to an error or failure with the service.
  1407. //
  1408. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact
  1409. func (c *Connect) StopContact(input *StopContactInput) (*StopContactOutput, error) {
  1410. req, out := c.StopContactRequest(input)
  1411. return out, req.Send()
  1412. }
  1413. // StopContactWithContext is the same as StopContact with the addition of
  1414. // the ability to pass a context and additional request options.
  1415. //
  1416. // See StopContact for details on how to use this API operation.
  1417. //
  1418. // The context must be non-nil and will be used for request cancellation. If
  1419. // the context is nil a panic will occur. In the future the SDK may create
  1420. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  1421. // for more information on using Contexts.
  1422. func (c *Connect) StopContactWithContext(ctx aws.Context, input *StopContactInput, opts ...request.Option) (*StopContactOutput, error) {
  1423. req, out := c.StopContactRequest(input)
  1424. req.SetContext(ctx)
  1425. req.ApplyOptions(opts...)
  1426. return out, req.Send()
  1427. }
  1428. const opUpdateContactAttributes = "UpdateContactAttributes"
  1429. // UpdateContactAttributesRequest generates a "aws/request.Request" representing the
  1430. // client's request for the UpdateContactAttributes operation. The "output" return
  1431. // value will be populated with the request's response once the request completes
  1432. // successfully.
  1433. //
  1434. // Use "Send" method on the returned Request to send the API call to the service.
  1435. // the "output" return value is not valid until after Send returns without error.
  1436. //
  1437. // See UpdateContactAttributes for more information on using the UpdateContactAttributes
  1438. // API call, and error handling.
  1439. //
  1440. // This method is useful when you want to inject custom logic or configuration
  1441. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  1442. //
  1443. //
  1444. // // Example sending a request using the UpdateContactAttributesRequest method.
  1445. // req, resp := client.UpdateContactAttributesRequest(params)
  1446. //
  1447. // err := req.Send()
  1448. // if err == nil { // resp is now filled
  1449. // fmt.Println(resp)
  1450. // }
  1451. //
  1452. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactAttributes
  1453. func (c *Connect) UpdateContactAttributesRequest(input *UpdateContactAttributesInput) (req *request.Request, output *UpdateContactAttributesOutput) {
  1454. op := &request.Operation{
  1455. Name: opUpdateContactAttributes,
  1456. HTTPMethod: "POST",
  1457. HTTPPath: "/contact/attributes",
  1458. }
  1459. if input == nil {
  1460. input = &UpdateContactAttributesInput{}
  1461. }
  1462. output = &UpdateContactAttributesOutput{}
  1463. req = c.newRequest(op, input, output)
  1464. req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
  1465. return
  1466. }
  1467. // UpdateContactAttributes API operation for Amazon Connect Service.
  1468. //
  1469. // The UpdateContactAttributes operation lets you programmatically create new,
  1470. // or update existing, contact attributes associated with a contact. You can
  1471. // use the operation to add or update attributes for both ongoing and completed
  1472. // contacts. For example, you can update the customer's name or the reason the
  1473. // customer called while the call is active, or add notes about steps that the
  1474. // agent took during the call that are displayed to the next agent that takes
  1475. // the call. You can also use the UpdateContactAttributes operation to update
  1476. // attributes for a contact using data from your CRM application and save the
  1477. // data with the contact in Amazon Connect. You could also flag calls for additional
  1478. // analysis, such as legal review or identifying abusive callers.
  1479. //
  1480. // Contact attributes are available in Amazon Connect for 24 months, and are
  1481. // then deleted.
  1482. //
  1483. // Important:
  1484. //
  1485. // You cannot use the operation to update attributes for contacts that occurred
  1486. // prior to the release of the API, September 12, 2018. You can update attributes
  1487. // only for contacts that started after the release of the API. If you attempt
  1488. // to update attributes for a contact that occurred prior to the release of
  1489. // the API, a 400 error is returned. This applies also to queued callbacks that
  1490. // were initiated prior to the release of the API but are still active in your
  1491. // instance.
  1492. //
  1493. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  1494. // with awserr.Error's Code and Message methods to get detailed information about
  1495. // the error.
  1496. //
  1497. // See the AWS API reference guide for Amazon Connect Service's
  1498. // API operation UpdateContactAttributes for usage and error information.
  1499. //
  1500. // Returned Error Codes:
  1501. // * ErrCodeInvalidRequestException "InvalidRequestException"
  1502. // The request is not valid.
  1503. //
  1504. // * ErrCodeInvalidParameterException "InvalidParameterException"
  1505. // One or more of the parameters provided to the operation are not valid.
  1506. //
  1507. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  1508. // The specified resource was not found.
  1509. //
  1510. // * ErrCodeInternalServiceException "InternalServiceException"
  1511. // Request processing failed due to an error or failure with the service.
  1512. //
  1513. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactAttributes
  1514. func (c *Connect) UpdateContactAttributes(input *UpdateContactAttributesInput) (*UpdateContactAttributesOutput, error) {
  1515. req, out := c.UpdateContactAttributesRequest(input)
  1516. return out, req.Send()
  1517. }
  1518. // UpdateContactAttributesWithContext is the same as UpdateContactAttributes with the addition of
  1519. // the ability to pass a context and additional request options.
  1520. //
  1521. // See UpdateContactAttributes for details on how to use this API operation.
  1522. //
  1523. // The context must be non-nil and will be used for request cancellation. If
  1524. // the context is nil a panic will occur. In the future the SDK may create
  1525. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  1526. // for more information on using Contexts.
  1527. func (c *Connect) UpdateContactAttributesWithContext(ctx aws.Context, input *UpdateContactAttributesInput, opts ...request.Option) (*UpdateContactAttributesOutput, error) {
  1528. req, out := c.UpdateContactAttributesRequest(input)
  1529. req.SetContext(ctx)
  1530. req.ApplyOptions(opts...)
  1531. return out, req.Send()
  1532. }
  1533. const opUpdateUserHierarchy = "UpdateUserHierarchy"
  1534. // UpdateUserHierarchyRequest generates a "aws/request.Request" representing the
  1535. // client's request for the UpdateUserHierarchy operation. The "output" return
  1536. // value will be populated with the request's response once the request completes
  1537. // successfully.
  1538. //
  1539. // Use "Send" method on the returned Request to send the API call to the service.
  1540. // the "output" return value is not valid until after Send returns without error.
  1541. //
  1542. // See UpdateUserHierarchy for more information on using the UpdateUserHierarchy
  1543. // API call, and error handling.
  1544. //
  1545. // This method is useful when you want to inject custom logic or configuration
  1546. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  1547. //
  1548. //
  1549. // // Example sending a request using the UpdateUserHierarchyRequest method.
  1550. // req, resp := client.UpdateUserHierarchyRequest(params)
  1551. //
  1552. // err := req.Send()
  1553. // if err == nil { // resp is now filled
  1554. // fmt.Println(resp)
  1555. // }
  1556. //
  1557. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchy
  1558. func (c *Connect) UpdateUserHierarchyRequest(input *UpdateUserHierarchyInput) (req *request.Request, output *UpdateUserHierarchyOutput) {
  1559. op := &request.Operation{
  1560. Name: opUpdateUserHierarchy,
  1561. HTTPMethod: "POST",
  1562. HTTPPath: "/users/{InstanceId}/{UserId}/hierarchy",
  1563. }
  1564. if input == nil {
  1565. input = &UpdateUserHierarchyInput{}
  1566. }
  1567. output = &UpdateUserHierarchyOutput{}
  1568. req = c.newRequest(op, input, output)
  1569. req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
  1570. return
  1571. }
  1572. // UpdateUserHierarchy API operation for Amazon Connect Service.
  1573. //
  1574. // Assigns the specified hierarchy group to the user.
  1575. //
  1576. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  1577. // with awserr.Error's Code and Message methods to get detailed information about
  1578. // the error.
  1579. //
  1580. // See the AWS API reference guide for Amazon Connect Service's
  1581. // API operation UpdateUserHierarchy for usage and error information.
  1582. //
  1583. // Returned Error Codes:
  1584. // * ErrCodeInvalidRequestException "InvalidRequestException"
  1585. // The request is not valid.
  1586. //
  1587. // * ErrCodeInvalidParameterException "InvalidParameterException"
  1588. // One or more of the parameters provided to the operation are not valid.
  1589. //
  1590. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  1591. // The specified resource was not found.
  1592. //
  1593. // * ErrCodeThrottlingException "ThrottlingException"
  1594. // The throttling limit has been exceeded.
  1595. //
  1596. // * ErrCodeInternalServiceException "InternalServiceException"
  1597. // Request processing failed due to an error or failure with the service.
  1598. //
  1599. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchy
  1600. func (c *Connect) UpdateUserHierarchy(input *UpdateUserHierarchyInput) (*UpdateUserHierarchyOutput, error) {
  1601. req, out := c.UpdateUserHierarchyRequest(input)
  1602. return out, req.Send()
  1603. }
  1604. // UpdateUserHierarchyWithContext is the same as UpdateUserHierarchy with the addition of
  1605. // the ability to pass a context and additional request options.
  1606. //
  1607. // See UpdateUserHierarchy for details on how to use this API operation.
  1608. //
  1609. // The context must be non-nil and will be used for request cancellation. If
  1610. // the context is nil a panic will occur. In the future the SDK may create
  1611. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  1612. // for more information on using Contexts.
  1613. func (c *Connect) UpdateUserHierarchyWithContext(ctx aws.Context, input *UpdateUserHierarchyInput, opts ...request.Option) (*UpdateUserHierarchyOutput, error) {
  1614. req, out := c.UpdateUserHierarchyRequest(input)
  1615. req.SetContext(ctx)
  1616. req.ApplyOptions(opts...)
  1617. return out, req.Send()
  1618. }
  1619. const opUpdateUserIdentityInfo = "UpdateUserIdentityInfo"
  1620. // UpdateUserIdentityInfoRequest generates a "aws/request.Request" representing the
  1621. // client's request for the UpdateUserIdentityInfo operation. The "output" return
  1622. // value will be populated with the request's response once the request completes
  1623. // successfully.
  1624. //
  1625. // Use "Send" method on the returned Request to send the API call to the service.
  1626. // the "output" return value is not valid until after Send returns without error.
  1627. //
  1628. // See UpdateUserIdentityInfo for more information on using the UpdateUserIdentityInfo
  1629. // API call, and error handling.
  1630. //
  1631. // This method is useful when you want to inject custom logic or configuration
  1632. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  1633. //
  1634. //
  1635. // // Example sending a request using the UpdateUserIdentityInfoRequest method.
  1636. // req, resp := client.UpdateUserIdentityInfoRequest(params)
  1637. //
  1638. // err := req.Send()
  1639. // if err == nil { // resp is now filled
  1640. // fmt.Println(resp)
  1641. // }
  1642. //
  1643. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfo
  1644. func (c *Connect) UpdateUserIdentityInfoRequest(input *UpdateUserIdentityInfoInput) (req *request.Request, output *UpdateUserIdentityInfoOutput) {
  1645. op := &request.Operation{
  1646. Name: opUpdateUserIdentityInfo,
  1647. HTTPMethod: "POST",
  1648. HTTPPath: "/users/{InstanceId}/{UserId}/identity-info",
  1649. }
  1650. if input == nil {
  1651. input = &UpdateUserIdentityInfoInput{}
  1652. }
  1653. output = &UpdateUserIdentityInfoOutput{}
  1654. req = c.newRequest(op, input, output)
  1655. req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
  1656. return
  1657. }
  1658. // UpdateUserIdentityInfo API operation for Amazon Connect Service.
  1659. //
  1660. // Updates the identity information for the specified user in a UserIdentityInfo
  1661. // object, including email, first name, and last name.
  1662. //
  1663. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  1664. // with awserr.Error's Code and Message methods to get detailed information about
  1665. // the error.
  1666. //
  1667. // See the AWS API reference guide for Amazon Connect Service's
  1668. // API operation UpdateUserIdentityInfo for usage and error information.
  1669. //
  1670. // Returned Error Codes:
  1671. // * ErrCodeInvalidRequestException "InvalidRequestException"
  1672. // The request is not valid.
  1673. //
  1674. // * ErrCodeInvalidParameterException "InvalidParameterException"
  1675. // One or more of the parameters provided to the operation are not valid.
  1676. //
  1677. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  1678. // The specified resource was not found.
  1679. //
  1680. // * ErrCodeThrottlingException "ThrottlingException"
  1681. // The throttling limit has been exceeded.
  1682. //
  1683. // * ErrCodeInternalServiceException "InternalServiceException"
  1684. // Request processing failed due to an error or failure with the service.
  1685. //
  1686. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfo
  1687. func (c *Connect) UpdateUserIdentityInfo(input *UpdateUserIdentityInfoInput) (*UpdateUserIdentityInfoOutput, error) {
  1688. req, out := c.UpdateUserIdentityInfoRequest(input)
  1689. return out, req.Send()
  1690. }
  1691. // UpdateUserIdentityInfoWithContext is the same as UpdateUserIdentityInfo with the addition of
  1692. // the ability to pass a context and additional request options.
  1693. //
  1694. // See UpdateUserIdentityInfo for details on how to use this API operation.
  1695. //
  1696. // The context must be non-nil and will be used for request cancellation. If
  1697. // the context is nil a panic will occur. In the future the SDK may create
  1698. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  1699. // for more information on using Contexts.
  1700. func (c *Connect) UpdateUserIdentityInfoWithContext(ctx aws.Context, input *UpdateUserIdentityInfoInput, opts ...request.Option) (*UpdateUserIdentityInfoOutput, error) {
  1701. req, out := c.UpdateUserIdentityInfoRequest(input)
  1702. req.SetContext(ctx)
  1703. req.ApplyOptions(opts...)
  1704. return out, req.Send()
  1705. }
  1706. const opUpdateUserPhoneConfig = "UpdateUserPhoneConfig"
  1707. // UpdateUserPhoneConfigRequest generates a "aws/request.Request" representing the
  1708. // client's request for the UpdateUserPhoneConfig operation. The "output" return
  1709. // value will be populated with the request's response once the request completes
  1710. // successfully.
  1711. //
  1712. // Use "Send" method on the returned Request to send the API call to the service.
  1713. // the "output" return value is not valid until after Send returns without error.
  1714. //
  1715. // See UpdateUserPhoneConfig for more information on using the UpdateUserPhoneConfig
  1716. // API call, and error handling.
  1717. //
  1718. // This method is useful when you want to inject custom logic or configuration
  1719. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  1720. //
  1721. //
  1722. // // Example sending a request using the UpdateUserPhoneConfigRequest method.
  1723. // req, resp := client.UpdateUserPhoneConfigRequest(params)
  1724. //
  1725. // err := req.Send()
  1726. // if err == nil { // resp is now filled
  1727. // fmt.Println(resp)
  1728. // }
  1729. //
  1730. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfig
  1731. func (c *Connect) UpdateUserPhoneConfigRequest(input *UpdateUserPhoneConfigInput) (req *request.Request, output *UpdateUserPhoneConfigOutput) {
  1732. op := &request.Operation{
  1733. Name: opUpdateUserPhoneConfig,
  1734. HTTPMethod: "POST",
  1735. HTTPPath: "/users/{InstanceId}/{UserId}/phone-config",
  1736. }
  1737. if input == nil {
  1738. input = &UpdateUserPhoneConfigInput{}
  1739. }
  1740. output = &UpdateUserPhoneConfigOutput{}
  1741. req = c.newRequest(op, input, output)
  1742. req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
  1743. return
  1744. }
  1745. // UpdateUserPhoneConfig API operation for Amazon Connect Service.
  1746. //
  1747. // Updates the phone configuration settings in the UserPhoneConfig object for
  1748. // the specified user.
  1749. //
  1750. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  1751. // with awserr.Error's Code and Message methods to get detailed information about
  1752. // the error.
  1753. //
  1754. // See the AWS API reference guide for Amazon Connect Service's
  1755. // API operation UpdateUserPhoneConfig for usage and error information.
  1756. //
  1757. // Returned Error Codes:
  1758. // * ErrCodeInvalidRequestException "InvalidRequestException"
  1759. // The request is not valid.
  1760. //
  1761. // * ErrCodeInvalidParameterException "InvalidParameterException"
  1762. // One or more of the parameters provided to the operation are not valid.
  1763. //
  1764. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  1765. // The specified resource was not found.
  1766. //
  1767. // * ErrCodeThrottlingException "ThrottlingException"
  1768. // The throttling limit has been exceeded.
  1769. //
  1770. // * ErrCodeInternalServiceException "InternalServiceException"
  1771. // Request processing failed due to an error or failure with the service.
  1772. //
  1773. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfig
  1774. func (c *Connect) UpdateUserPhoneConfig(input *UpdateUserPhoneConfigInput) (*UpdateUserPhoneConfigOutput, error) {
  1775. req, out := c.UpdateUserPhoneConfigRequest(input)
  1776. return out, req.Send()
  1777. }
  1778. // UpdateUserPhoneConfigWithContext is the same as UpdateUserPhoneConfig with the addition of
  1779. // the ability to pass a context and additional request options.
  1780. //
  1781. // See UpdateUserPhoneConfig for details on how to use this API operation.
  1782. //
  1783. // The context must be non-nil and will be used for request cancellation. If
  1784. // the context is nil a panic will occur. In the future the SDK may create
  1785. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  1786. // for more information on using Contexts.
  1787. func (c *Connect) UpdateUserPhoneConfigWithContext(ctx aws.Context, input *UpdateUserPhoneConfigInput, opts ...request.Option) (*UpdateUserPhoneConfigOutput, error) {
  1788. req, out := c.UpdateUserPhoneConfigRequest(input)
  1789. req.SetContext(ctx)
  1790. req.ApplyOptions(opts...)
  1791. return out, req.Send()
  1792. }
  1793. const opUpdateUserRoutingProfile = "UpdateUserRoutingProfile"
  1794. // UpdateUserRoutingProfileRequest generates a "aws/request.Request" representing the
  1795. // client's request for the UpdateUserRoutingProfile operation. The "output" return
  1796. // value will be populated with the request's response once the request completes
  1797. // successfully.
  1798. //
  1799. // Use "Send" method on the returned Request to send the API call to the service.
  1800. // the "output" return value is not valid until after Send returns without error.
  1801. //
  1802. // See UpdateUserRoutingProfile for more information on using the UpdateUserRoutingProfile
  1803. // API call, and error handling.
  1804. //
  1805. // This method is useful when you want to inject custom logic or configuration
  1806. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  1807. //
  1808. //
  1809. // // Example sending a request using the UpdateUserRoutingProfileRequest method.
  1810. // req, resp := client.UpdateUserRoutingProfileRequest(params)
  1811. //
  1812. // err := req.Send()
  1813. // if err == nil { // resp is now filled
  1814. // fmt.Println(resp)
  1815. // }
  1816. //
  1817. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfile
  1818. func (c *Connect) UpdateUserRoutingProfileRequest(input *UpdateUserRoutingProfileInput) (req *request.Request, output *UpdateUserRoutingProfileOutput) {
  1819. op := &request.Operation{
  1820. Name: opUpdateUserRoutingProfile,
  1821. HTTPMethod: "POST",
  1822. HTTPPath: "/users/{InstanceId}/{UserId}/routing-profile",
  1823. }
  1824. if input == nil {
  1825. input = &UpdateUserRoutingProfileInput{}
  1826. }
  1827. output = &UpdateUserRoutingProfileOutput{}
  1828. req = c.newRequest(op, input, output)
  1829. req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
  1830. return
  1831. }
  1832. // UpdateUserRoutingProfile API operation for Amazon Connect Service.
  1833. //
  1834. // Assigns the specified routing profile to a user.
  1835. //
  1836. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  1837. // with awserr.Error's Code and Message methods to get detailed information about
  1838. // the error.
  1839. //
  1840. // See the AWS API reference guide for Amazon Connect Service's
  1841. // API operation UpdateUserRoutingProfile for usage and error information.
  1842. //
  1843. // Returned Error Codes:
  1844. // * ErrCodeInvalidRequestException "InvalidRequestException"
  1845. // The request is not valid.
  1846. //
  1847. // * ErrCodeInvalidParameterException "InvalidParameterException"
  1848. // One or more of the parameters provided to the operation are not valid.
  1849. //
  1850. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  1851. // The specified resource was not found.
  1852. //
  1853. // * ErrCodeThrottlingException "ThrottlingException"
  1854. // The throttling limit has been exceeded.
  1855. //
  1856. // * ErrCodeInternalServiceException "InternalServiceException"
  1857. // Request processing failed due to an error or failure with the service.
  1858. //
  1859. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfile
  1860. func (c *Connect) UpdateUserRoutingProfile(input *UpdateUserRoutingProfileInput) (*UpdateUserRoutingProfileOutput, error) {
  1861. req, out := c.UpdateUserRoutingProfileRequest(input)
  1862. return out, req.Send()
  1863. }
  1864. // UpdateUserRoutingProfileWithContext is the same as UpdateUserRoutingProfile with the addition of
  1865. // the ability to pass a context and additional request options.
  1866. //
  1867. // See UpdateUserRoutingProfile for details on how to use this API operation.
  1868. //
  1869. // The context must be non-nil and will be used for request cancellation. If
  1870. // the context is nil a panic will occur. In the future the SDK may create
  1871. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  1872. // for more information on using Contexts.
  1873. func (c *Connect) UpdateUserRoutingProfileWithContext(ctx aws.Context, input *UpdateUserRoutingProfileInput, opts ...request.Option) (*UpdateUserRoutingProfileOutput, error) {
  1874. req, out := c.UpdateUserRoutingProfileRequest(input)
  1875. req.SetContext(ctx)
  1876. req.ApplyOptions(opts...)
  1877. return out, req.Send()
  1878. }
  1879. const opUpdateUserSecurityProfiles = "UpdateUserSecurityProfiles"
  1880. // UpdateUserSecurityProfilesRequest generates a "aws/request.Request" representing the
  1881. // client's request for the UpdateUserSecurityProfiles operation. The "output" return
  1882. // value will be populated with the request's response once the request completes
  1883. // successfully.
  1884. //
  1885. // Use "Send" method on the returned Request to send the API call to the service.
  1886. // the "output" return value is not valid until after Send returns without error.
  1887. //
  1888. // See UpdateUserSecurityProfiles for more information on using the UpdateUserSecurityProfiles
  1889. // API call, and error handling.
  1890. //
  1891. // This method is useful when you want to inject custom logic or configuration
  1892. // into the SDK's request lifecycle. Such as custom headers, or retry logic.
  1893. //
  1894. //
  1895. // // Example sending a request using the UpdateUserSecurityProfilesRequest method.
  1896. // req, resp := client.UpdateUserSecurityProfilesRequest(params)
  1897. //
  1898. // err := req.Send()
  1899. // if err == nil { // resp is now filled
  1900. // fmt.Println(resp)
  1901. // }
  1902. //
  1903. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfiles
  1904. func (c *Connect) UpdateUserSecurityProfilesRequest(input *UpdateUserSecurityProfilesInput) (req *request.Request, output *UpdateUserSecurityProfilesOutput) {
  1905. op := &request.Operation{
  1906. Name: opUpdateUserSecurityProfiles,
  1907. HTTPMethod: "POST",
  1908. HTTPPath: "/users/{InstanceId}/{UserId}/security-profiles",
  1909. }
  1910. if input == nil {
  1911. input = &UpdateUserSecurityProfilesInput{}
  1912. }
  1913. output = &UpdateUserSecurityProfilesOutput{}
  1914. req = c.newRequest(op, input, output)
  1915. req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
  1916. return
  1917. }
  1918. // UpdateUserSecurityProfiles API operation for Amazon Connect Service.
  1919. //
  1920. // Updates the security profiles assigned to the user.
  1921. //
  1922. // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
  1923. // with awserr.Error's Code and Message methods to get detailed information about
  1924. // the error.
  1925. //
  1926. // See the AWS API reference guide for Amazon Connect Service's
  1927. // API operation UpdateUserSecurityProfiles for usage and error information.
  1928. //
  1929. // Returned Error Codes:
  1930. // * ErrCodeInvalidRequestException "InvalidRequestException"
  1931. // The request is not valid.
  1932. //
  1933. // * ErrCodeInvalidParameterException "InvalidParameterException"
  1934. // One or more of the parameters provided to the operation are not valid.
  1935. //
  1936. // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
  1937. // The specified resource was not found.
  1938. //
  1939. // * ErrCodeThrottlingException "ThrottlingException"
  1940. // The throttling limit has been exceeded.
  1941. //
  1942. // * ErrCodeInternalServiceException "InternalServiceException"
  1943. // Request processing failed due to an error or failure with the service.
  1944. //
  1945. // See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfiles
  1946. func (c *Connect) UpdateUserSecurityProfiles(input *UpdateUserSecurityProfilesInput) (*UpdateUserSecurityProfilesOutput, error) {
  1947. req, out := c.UpdateUserSecurityProfilesRequest(input)
  1948. return out, req.Send()
  1949. }
  1950. // UpdateUserSecurityProfilesWithContext is the same as UpdateUserSecurityProfiles with the addition of
  1951. // the ability to pass a context and additional request options.
  1952. //
  1953. // See UpdateUserSecurityProfiles for details on how to use this API operation.
  1954. //
  1955. // The context must be non-nil and will be used for request cancellation. If
  1956. // the context is nil a panic will occur. In the future the SDK may create
  1957. // sub-contexts for http.Requests. See https://golang.org/pkg/context/
  1958. // for more information on using Contexts.
  1959. func (c *Connect) UpdateUserSecurityProfilesWithContext(ctx aws.Context, input *UpdateUserSecurityProfilesInput, opts ...request.Option) (*UpdateUserSecurityProfilesOutput, error) {
  1960. req, out := c.UpdateUserSecurityProfilesRequest(input)
  1961. req.SetContext(ctx)
  1962. req.ApplyOptions(opts...)
  1963. return out, req.Send()
  1964. }
  1965. type CreateUserInput struct {
  1966. _ struct{} `type:"structure"`
  1967. // The unique identifier for the user account in the directory service directory
  1968. // used for identity management. If Amazon Connect is unable to access the existing
  1969. // directory, you can use the DirectoryUserId to authenticate users. If you
  1970. // include the parameter, it is assumed that Amazon Connect cannot access the
  1971. // directory. If the parameter is not included, the UserIdentityInfo is used
  1972. // to authenticate users from your existing directory.
  1973. //
  1974. // This parameter is required if you are using an existing directory for identity
  1975. // management in Amazon Connect when Amazon Connect cannot access your directory
  1976. // to authenticate users. If you are using SAML for identity management and
  1977. // include this parameter, an InvalidRequestException is returned.
  1978. DirectoryUserId *string `type:"string"`
  1979. // The unique identifier for the hierarchy group to assign to the user created.
  1980. HierarchyGroupId *string `type:"string"`
  1981. // Information about the user, including email address, first name, and last
  1982. // name.
  1983. IdentityInfo *UserIdentityInfo `type:"structure"`
  1984. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  1985. // open the AWS console and select Amazon Connect. Select the alias of the instance
  1986. // in the Instance alias column. The instance ID is displayed in the Overview
  1987. // section of your instance settings. For example, the instance ID is the set
  1988. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  1989. //
  1990. // InstanceId is a required field
  1991. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  1992. // The password for the user account to create. This is required if you are
  1993. // using Amazon Connect for identity management. If you are using SAML for identity
  1994. // management and include this parameter, an InvalidRequestException is returned.
  1995. Password *string `type:"string"`
  1996. // Specifies the phone settings for the user, including AfterContactWorkTimeLimit,
  1997. // AutoAccept, DeskPhoneNumber, and PhoneType.
  1998. //
  1999. // PhoneConfig is a required field
  2000. PhoneConfig *UserPhoneConfig `type:"structure" required:"true"`
  2001. // The unique identifier for the routing profile to assign to the user created.
  2002. //
  2003. // RoutingProfileId is a required field
  2004. RoutingProfileId *string `type:"string" required:"true"`
  2005. // The unique identifier of the security profile to assign to the user created.
  2006. //
  2007. // SecurityProfileIds is a required field
  2008. SecurityProfileIds []*string `min:"1" type:"list" required:"true"`
  2009. // The user name in Amazon Connect for the account to create. If you are using
  2010. // SAML for identity management in your Amazon Connect, the value for Username
  2011. // can include up to 64 characters from [a-zA-Z0-9_-.\@]+.
  2012. //
  2013. // Username is a required field
  2014. Username *string `min:"1" type:"string" required:"true"`
  2015. }
  2016. // String returns the string representation
  2017. func (s CreateUserInput) String() string {
  2018. return awsutil.Prettify(s)
  2019. }
  2020. // GoString returns the string representation
  2021. func (s CreateUserInput) GoString() string {
  2022. return s.String()
  2023. }
  2024. // Validate inspects the fields of the type to determine if they are valid.
  2025. func (s *CreateUserInput) Validate() error {
  2026. invalidParams := request.ErrInvalidParams{Context: "CreateUserInput"}
  2027. if s.InstanceId == nil {
  2028. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  2029. }
  2030. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  2031. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  2032. }
  2033. if s.PhoneConfig == nil {
  2034. invalidParams.Add(request.NewErrParamRequired("PhoneConfig"))
  2035. }
  2036. if s.RoutingProfileId == nil {
  2037. invalidParams.Add(request.NewErrParamRequired("RoutingProfileId"))
  2038. }
  2039. if s.SecurityProfileIds == nil {
  2040. invalidParams.Add(request.NewErrParamRequired("SecurityProfileIds"))
  2041. }
  2042. if s.SecurityProfileIds != nil && len(s.SecurityProfileIds) < 1 {
  2043. invalidParams.Add(request.NewErrParamMinLen("SecurityProfileIds", 1))
  2044. }
  2045. if s.Username == nil {
  2046. invalidParams.Add(request.NewErrParamRequired("Username"))
  2047. }
  2048. if s.Username != nil && len(*s.Username) < 1 {
  2049. invalidParams.Add(request.NewErrParamMinLen("Username", 1))
  2050. }
  2051. if s.IdentityInfo != nil {
  2052. if err := s.IdentityInfo.Validate(); err != nil {
  2053. invalidParams.AddNested("IdentityInfo", err.(request.ErrInvalidParams))
  2054. }
  2055. }
  2056. if s.PhoneConfig != nil {
  2057. if err := s.PhoneConfig.Validate(); err != nil {
  2058. invalidParams.AddNested("PhoneConfig", err.(request.ErrInvalidParams))
  2059. }
  2060. }
  2061. if invalidParams.Len() > 0 {
  2062. return invalidParams
  2063. }
  2064. return nil
  2065. }
  2066. // SetDirectoryUserId sets the DirectoryUserId field's value.
  2067. func (s *CreateUserInput) SetDirectoryUserId(v string) *CreateUserInput {
  2068. s.DirectoryUserId = &v
  2069. return s
  2070. }
  2071. // SetHierarchyGroupId sets the HierarchyGroupId field's value.
  2072. func (s *CreateUserInput) SetHierarchyGroupId(v string) *CreateUserInput {
  2073. s.HierarchyGroupId = &v
  2074. return s
  2075. }
  2076. // SetIdentityInfo sets the IdentityInfo field's value.
  2077. func (s *CreateUserInput) SetIdentityInfo(v *UserIdentityInfo) *CreateUserInput {
  2078. s.IdentityInfo = v
  2079. return s
  2080. }
  2081. // SetInstanceId sets the InstanceId field's value.
  2082. func (s *CreateUserInput) SetInstanceId(v string) *CreateUserInput {
  2083. s.InstanceId = &v
  2084. return s
  2085. }
  2086. // SetPassword sets the Password field's value.
  2087. func (s *CreateUserInput) SetPassword(v string) *CreateUserInput {
  2088. s.Password = &v
  2089. return s
  2090. }
  2091. // SetPhoneConfig sets the PhoneConfig field's value.
  2092. func (s *CreateUserInput) SetPhoneConfig(v *UserPhoneConfig) *CreateUserInput {
  2093. s.PhoneConfig = v
  2094. return s
  2095. }
  2096. // SetRoutingProfileId sets the RoutingProfileId field's value.
  2097. func (s *CreateUserInput) SetRoutingProfileId(v string) *CreateUserInput {
  2098. s.RoutingProfileId = &v
  2099. return s
  2100. }
  2101. // SetSecurityProfileIds sets the SecurityProfileIds field's value.
  2102. func (s *CreateUserInput) SetSecurityProfileIds(v []*string) *CreateUserInput {
  2103. s.SecurityProfileIds = v
  2104. return s
  2105. }
  2106. // SetUsername sets the Username field's value.
  2107. func (s *CreateUserInput) SetUsername(v string) *CreateUserInput {
  2108. s.Username = &v
  2109. return s
  2110. }
  2111. type CreateUserOutput struct {
  2112. _ struct{} `type:"structure"`
  2113. // The Amazon Resource Name (ARN) of the user account created.
  2114. UserArn *string `type:"string"`
  2115. // The unique identifier for the user account in Amazon Connect
  2116. UserId *string `type:"string"`
  2117. }
  2118. // String returns the string representation
  2119. func (s CreateUserOutput) String() string {
  2120. return awsutil.Prettify(s)
  2121. }
  2122. // GoString returns the string representation
  2123. func (s CreateUserOutput) GoString() string {
  2124. return s.String()
  2125. }
  2126. // SetUserArn sets the UserArn field's value.
  2127. func (s *CreateUserOutput) SetUserArn(v string) *CreateUserOutput {
  2128. s.UserArn = &v
  2129. return s
  2130. }
  2131. // SetUserId sets the UserId field's value.
  2132. func (s *CreateUserOutput) SetUserId(v string) *CreateUserOutput {
  2133. s.UserId = &v
  2134. return s
  2135. }
  2136. // The credentials to use for federation.
  2137. type Credentials struct {
  2138. _ struct{} `type:"structure"`
  2139. // An access token generated for a federated user to access Amazon Connect
  2140. AccessToken *string `type:"string" sensitive:"true"`
  2141. // A token generated with an expiration time for the session a user is logged
  2142. // in to Amazon Connect
  2143. AccessTokenExpiration *time.Time `type:"timestamp"`
  2144. // Renews a token generated for a user to access the Amazon Connect instance.
  2145. RefreshToken *string `type:"string" sensitive:"true"`
  2146. // Renews the expiration timer for a generated token.
  2147. RefreshTokenExpiration *time.Time `type:"timestamp"`
  2148. }
  2149. // String returns the string representation
  2150. func (s Credentials) String() string {
  2151. return awsutil.Prettify(s)
  2152. }
  2153. // GoString returns the string representation
  2154. func (s Credentials) GoString() string {
  2155. return s.String()
  2156. }
  2157. // SetAccessToken sets the AccessToken field's value.
  2158. func (s *Credentials) SetAccessToken(v string) *Credentials {
  2159. s.AccessToken = &v
  2160. return s
  2161. }
  2162. // SetAccessTokenExpiration sets the AccessTokenExpiration field's value.
  2163. func (s *Credentials) SetAccessTokenExpiration(v time.Time) *Credentials {
  2164. s.AccessTokenExpiration = &v
  2165. return s
  2166. }
  2167. // SetRefreshToken sets the RefreshToken field's value.
  2168. func (s *Credentials) SetRefreshToken(v string) *Credentials {
  2169. s.RefreshToken = &v
  2170. return s
  2171. }
  2172. // SetRefreshTokenExpiration sets the RefreshTokenExpiration field's value.
  2173. func (s *Credentials) SetRefreshTokenExpiration(v time.Time) *Credentials {
  2174. s.RefreshTokenExpiration = &v
  2175. return s
  2176. }
  2177. // A CurrentMetric object that contains the Name and Unit for the metric.
  2178. type CurrentMetric struct {
  2179. _ struct{} `type:"structure"`
  2180. // The name of the metric.
  2181. Name *string `type:"string" enum:"CurrentMetricName"`
  2182. // The unit for the metric.
  2183. Unit *string `type:"string" enum:"Unit"`
  2184. }
  2185. // String returns the string representation
  2186. func (s CurrentMetric) String() string {
  2187. return awsutil.Prettify(s)
  2188. }
  2189. // GoString returns the string representation
  2190. func (s CurrentMetric) GoString() string {
  2191. return s.String()
  2192. }
  2193. // SetName sets the Name field's value.
  2194. func (s *CurrentMetric) SetName(v string) *CurrentMetric {
  2195. s.Name = &v
  2196. return s
  2197. }
  2198. // SetUnit sets the Unit field's value.
  2199. func (s *CurrentMetric) SetUnit(v string) *CurrentMetric {
  2200. s.Unit = &v
  2201. return s
  2202. }
  2203. // A CurrentMetricData object.
  2204. type CurrentMetricData struct {
  2205. _ struct{} `type:"structure"`
  2206. // The metric in a CurrentMetricData object.
  2207. Metric *CurrentMetric `type:"structure"`
  2208. // The value of the metric in the CurrentMetricData object.
  2209. Value *float64 `type:"double"`
  2210. }
  2211. // String returns the string representation
  2212. func (s CurrentMetricData) String() string {
  2213. return awsutil.Prettify(s)
  2214. }
  2215. // GoString returns the string representation
  2216. func (s CurrentMetricData) GoString() string {
  2217. return s.String()
  2218. }
  2219. // SetMetric sets the Metric field's value.
  2220. func (s *CurrentMetricData) SetMetric(v *CurrentMetric) *CurrentMetricData {
  2221. s.Metric = v
  2222. return s
  2223. }
  2224. // SetValue sets the Value field's value.
  2225. func (s *CurrentMetricData) SetValue(v float64) *CurrentMetricData {
  2226. s.Value = &v
  2227. return s
  2228. }
  2229. // A CurrentMetricResult object.
  2230. type CurrentMetricResult struct {
  2231. _ struct{} `type:"structure"`
  2232. // The Collections for the CurrentMetricResult object.
  2233. Collections []*CurrentMetricData `type:"list"`
  2234. // The Dimensions for the CurrentMetricResult object.
  2235. Dimensions *Dimensions `type:"structure"`
  2236. }
  2237. // String returns the string representation
  2238. func (s CurrentMetricResult) String() string {
  2239. return awsutil.Prettify(s)
  2240. }
  2241. // GoString returns the string representation
  2242. func (s CurrentMetricResult) GoString() string {
  2243. return s.String()
  2244. }
  2245. // SetCollections sets the Collections field's value.
  2246. func (s *CurrentMetricResult) SetCollections(v []*CurrentMetricData) *CurrentMetricResult {
  2247. s.Collections = v
  2248. return s
  2249. }
  2250. // SetDimensions sets the Dimensions field's value.
  2251. func (s *CurrentMetricResult) SetDimensions(v *Dimensions) *CurrentMetricResult {
  2252. s.Dimensions = v
  2253. return s
  2254. }
  2255. type DeleteUserInput struct {
  2256. _ struct{} `type:"structure"`
  2257. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  2258. // open the AWS console and select Amazon Connect. Select the alias of the instance
  2259. // in the Instance alias column. The instance ID is displayed in the Overview
  2260. // section of your instance settings. For example, the instance ID is the set
  2261. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  2262. //
  2263. // InstanceId is a required field
  2264. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  2265. // The unique identifier of the user to delete.
  2266. //
  2267. // UserId is a required field
  2268. UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
  2269. }
  2270. // String returns the string representation
  2271. func (s DeleteUserInput) String() string {
  2272. return awsutil.Prettify(s)
  2273. }
  2274. // GoString returns the string representation
  2275. func (s DeleteUserInput) GoString() string {
  2276. return s.String()
  2277. }
  2278. // Validate inspects the fields of the type to determine if they are valid.
  2279. func (s *DeleteUserInput) Validate() error {
  2280. invalidParams := request.ErrInvalidParams{Context: "DeleteUserInput"}
  2281. if s.InstanceId == nil {
  2282. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  2283. }
  2284. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  2285. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  2286. }
  2287. if s.UserId == nil {
  2288. invalidParams.Add(request.NewErrParamRequired("UserId"))
  2289. }
  2290. if s.UserId != nil && len(*s.UserId) < 1 {
  2291. invalidParams.Add(request.NewErrParamMinLen("UserId", 1))
  2292. }
  2293. if invalidParams.Len() > 0 {
  2294. return invalidParams
  2295. }
  2296. return nil
  2297. }
  2298. // SetInstanceId sets the InstanceId field's value.
  2299. func (s *DeleteUserInput) SetInstanceId(v string) *DeleteUserInput {
  2300. s.InstanceId = &v
  2301. return s
  2302. }
  2303. // SetUserId sets the UserId field's value.
  2304. func (s *DeleteUserInput) SetUserId(v string) *DeleteUserInput {
  2305. s.UserId = &v
  2306. return s
  2307. }
  2308. type DeleteUserOutput struct {
  2309. _ struct{} `type:"structure"`
  2310. }
  2311. // String returns the string representation
  2312. func (s DeleteUserOutput) String() string {
  2313. return awsutil.Prettify(s)
  2314. }
  2315. // GoString returns the string representation
  2316. func (s DeleteUserOutput) GoString() string {
  2317. return s.String()
  2318. }
  2319. type DescribeUserHierarchyGroupInput struct {
  2320. _ struct{} `type:"structure"`
  2321. // The identifier for the hierarchy group to return.
  2322. //
  2323. // HierarchyGroupId is a required field
  2324. HierarchyGroupId *string `location:"uri" locationName:"HierarchyGroupId" type:"string" required:"true"`
  2325. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  2326. // open the AWS console and select Amazon Connect. Select the alias of the instance
  2327. // in the Instance alias column. The instance ID is displayed in the Overview
  2328. // section of your instance settings. For example, the instance ID is the set
  2329. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  2330. //
  2331. // InstanceId is a required field
  2332. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  2333. }
  2334. // String returns the string representation
  2335. func (s DescribeUserHierarchyGroupInput) String() string {
  2336. return awsutil.Prettify(s)
  2337. }
  2338. // GoString returns the string representation
  2339. func (s DescribeUserHierarchyGroupInput) GoString() string {
  2340. return s.String()
  2341. }
  2342. // Validate inspects the fields of the type to determine if they are valid.
  2343. func (s *DescribeUserHierarchyGroupInput) Validate() error {
  2344. invalidParams := request.ErrInvalidParams{Context: "DescribeUserHierarchyGroupInput"}
  2345. if s.HierarchyGroupId == nil {
  2346. invalidParams.Add(request.NewErrParamRequired("HierarchyGroupId"))
  2347. }
  2348. if s.HierarchyGroupId != nil && len(*s.HierarchyGroupId) < 1 {
  2349. invalidParams.Add(request.NewErrParamMinLen("HierarchyGroupId", 1))
  2350. }
  2351. if s.InstanceId == nil {
  2352. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  2353. }
  2354. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  2355. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  2356. }
  2357. if invalidParams.Len() > 0 {
  2358. return invalidParams
  2359. }
  2360. return nil
  2361. }
  2362. // SetHierarchyGroupId sets the HierarchyGroupId field's value.
  2363. func (s *DescribeUserHierarchyGroupInput) SetHierarchyGroupId(v string) *DescribeUserHierarchyGroupInput {
  2364. s.HierarchyGroupId = &v
  2365. return s
  2366. }
  2367. // SetInstanceId sets the InstanceId field's value.
  2368. func (s *DescribeUserHierarchyGroupInput) SetInstanceId(v string) *DescribeUserHierarchyGroupInput {
  2369. s.InstanceId = &v
  2370. return s
  2371. }
  2372. type DescribeUserHierarchyGroupOutput struct {
  2373. _ struct{} `type:"structure"`
  2374. // Returns a HierarchyGroup object.
  2375. HierarchyGroup *HierarchyGroup `type:"structure"`
  2376. }
  2377. // String returns the string representation
  2378. func (s DescribeUserHierarchyGroupOutput) String() string {
  2379. return awsutil.Prettify(s)
  2380. }
  2381. // GoString returns the string representation
  2382. func (s DescribeUserHierarchyGroupOutput) GoString() string {
  2383. return s.String()
  2384. }
  2385. // SetHierarchyGroup sets the HierarchyGroup field's value.
  2386. func (s *DescribeUserHierarchyGroupOutput) SetHierarchyGroup(v *HierarchyGroup) *DescribeUserHierarchyGroupOutput {
  2387. s.HierarchyGroup = v
  2388. return s
  2389. }
  2390. type DescribeUserHierarchyStructureInput struct {
  2391. _ struct{} `type:"structure"`
  2392. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  2393. // open the AWS console and select Amazon Connect. Select the alias of the instance
  2394. // in the Instance alias column. The instance ID is displayed in the Overview
  2395. // section of your instance settings. For example, the instance ID is the set
  2396. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  2397. //
  2398. // InstanceId is a required field
  2399. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  2400. }
  2401. // String returns the string representation
  2402. func (s DescribeUserHierarchyStructureInput) String() string {
  2403. return awsutil.Prettify(s)
  2404. }
  2405. // GoString returns the string representation
  2406. func (s DescribeUserHierarchyStructureInput) GoString() string {
  2407. return s.String()
  2408. }
  2409. // Validate inspects the fields of the type to determine if they are valid.
  2410. func (s *DescribeUserHierarchyStructureInput) Validate() error {
  2411. invalidParams := request.ErrInvalidParams{Context: "DescribeUserHierarchyStructureInput"}
  2412. if s.InstanceId == nil {
  2413. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  2414. }
  2415. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  2416. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  2417. }
  2418. if invalidParams.Len() > 0 {
  2419. return invalidParams
  2420. }
  2421. return nil
  2422. }
  2423. // SetInstanceId sets the InstanceId field's value.
  2424. func (s *DescribeUserHierarchyStructureInput) SetInstanceId(v string) *DescribeUserHierarchyStructureInput {
  2425. s.InstanceId = &v
  2426. return s
  2427. }
  2428. type DescribeUserHierarchyStructureOutput struct {
  2429. _ struct{} `type:"structure"`
  2430. // A HierarchyStructure object.
  2431. HierarchyStructure *HierarchyStructure `type:"structure"`
  2432. }
  2433. // String returns the string representation
  2434. func (s DescribeUserHierarchyStructureOutput) String() string {
  2435. return awsutil.Prettify(s)
  2436. }
  2437. // GoString returns the string representation
  2438. func (s DescribeUserHierarchyStructureOutput) GoString() string {
  2439. return s.String()
  2440. }
  2441. // SetHierarchyStructure sets the HierarchyStructure field's value.
  2442. func (s *DescribeUserHierarchyStructureOutput) SetHierarchyStructure(v *HierarchyStructure) *DescribeUserHierarchyStructureOutput {
  2443. s.HierarchyStructure = v
  2444. return s
  2445. }
  2446. type DescribeUserInput struct {
  2447. _ struct{} `type:"structure"`
  2448. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  2449. // open the AWS console and select Amazon Connect. Select the alias of the instance
  2450. // in the Instance alias column. The instance ID is displayed in the Overview
  2451. // section of your instance settings. For example, the instance ID is the set
  2452. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  2453. //
  2454. // InstanceId is a required field
  2455. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  2456. // Unique identifier for the user account to return.
  2457. //
  2458. // UserId is a required field
  2459. UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
  2460. }
  2461. // String returns the string representation
  2462. func (s DescribeUserInput) String() string {
  2463. return awsutil.Prettify(s)
  2464. }
  2465. // GoString returns the string representation
  2466. func (s DescribeUserInput) GoString() string {
  2467. return s.String()
  2468. }
  2469. // Validate inspects the fields of the type to determine if they are valid.
  2470. func (s *DescribeUserInput) Validate() error {
  2471. invalidParams := request.ErrInvalidParams{Context: "DescribeUserInput"}
  2472. if s.InstanceId == nil {
  2473. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  2474. }
  2475. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  2476. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  2477. }
  2478. if s.UserId == nil {
  2479. invalidParams.Add(request.NewErrParamRequired("UserId"))
  2480. }
  2481. if s.UserId != nil && len(*s.UserId) < 1 {
  2482. invalidParams.Add(request.NewErrParamMinLen("UserId", 1))
  2483. }
  2484. if invalidParams.Len() > 0 {
  2485. return invalidParams
  2486. }
  2487. return nil
  2488. }
  2489. // SetInstanceId sets the InstanceId field's value.
  2490. func (s *DescribeUserInput) SetInstanceId(v string) *DescribeUserInput {
  2491. s.InstanceId = &v
  2492. return s
  2493. }
  2494. // SetUserId sets the UserId field's value.
  2495. func (s *DescribeUserInput) SetUserId(v string) *DescribeUserInput {
  2496. s.UserId = &v
  2497. return s
  2498. }
  2499. type DescribeUserOutput struct {
  2500. _ struct{} `type:"structure"`
  2501. // A User object that contains information about the user account and configuration
  2502. // settings.
  2503. User *User `type:"structure"`
  2504. }
  2505. // String returns the string representation
  2506. func (s DescribeUserOutput) String() string {
  2507. return awsutil.Prettify(s)
  2508. }
  2509. // GoString returns the string representation
  2510. func (s DescribeUserOutput) GoString() string {
  2511. return s.String()
  2512. }
  2513. // SetUser sets the User field's value.
  2514. func (s *DescribeUserOutput) SetUser(v *User) *DescribeUserOutput {
  2515. s.User = v
  2516. return s
  2517. }
  2518. // A Dimensions object that includes the Channel and Queue for the metric.
  2519. type Dimensions struct {
  2520. _ struct{} `type:"structure"`
  2521. // The channel used for grouping and filters. Only VOICE is supported.
  2522. Channel *string `type:"string" enum:"Channel"`
  2523. // A QueueReference object used as one part of dimension for the metrics results.
  2524. Queue *QueueReference `type:"structure"`
  2525. }
  2526. // String returns the string representation
  2527. func (s Dimensions) String() string {
  2528. return awsutil.Prettify(s)
  2529. }
  2530. // GoString returns the string representation
  2531. func (s Dimensions) GoString() string {
  2532. return s.String()
  2533. }
  2534. // SetChannel sets the Channel field's value.
  2535. func (s *Dimensions) SetChannel(v string) *Dimensions {
  2536. s.Channel = &v
  2537. return s
  2538. }
  2539. // SetQueue sets the Queue field's value.
  2540. func (s *Dimensions) SetQueue(v *QueueReference) *Dimensions {
  2541. s.Queue = v
  2542. return s
  2543. }
  2544. // The filter, either channel or queues, to apply to the metric results retrieved.
  2545. type Filters struct {
  2546. _ struct{} `type:"structure"`
  2547. // The Channel to use as a filter for the metrics returned. Only VOICE is supported.
  2548. Channels []*string `type:"list"`
  2549. // A list of up to 100 queue IDs or queue ARNs to use to filter the metrics
  2550. // retrieved. You can include both IDs and ARNs in a request.
  2551. Queues []*string `min:"1" type:"list"`
  2552. }
  2553. // String returns the string representation
  2554. func (s Filters) String() string {
  2555. return awsutil.Prettify(s)
  2556. }
  2557. // GoString returns the string representation
  2558. func (s Filters) GoString() string {
  2559. return s.String()
  2560. }
  2561. // Validate inspects the fields of the type to determine if they are valid.
  2562. func (s *Filters) Validate() error {
  2563. invalidParams := request.ErrInvalidParams{Context: "Filters"}
  2564. if s.Queues != nil && len(s.Queues) < 1 {
  2565. invalidParams.Add(request.NewErrParamMinLen("Queues", 1))
  2566. }
  2567. if invalidParams.Len() > 0 {
  2568. return invalidParams
  2569. }
  2570. return nil
  2571. }
  2572. // SetChannels sets the Channels field's value.
  2573. func (s *Filters) SetChannels(v []*string) *Filters {
  2574. s.Channels = v
  2575. return s
  2576. }
  2577. // SetQueues sets the Queues field's value.
  2578. func (s *Filters) SetQueues(v []*string) *Filters {
  2579. s.Queues = v
  2580. return s
  2581. }
  2582. type GetContactAttributesInput struct {
  2583. _ struct{} `type:"structure"`
  2584. // The ID for the initial contact in Amazon Connect associated with the attributes
  2585. // to update.
  2586. //
  2587. // InitialContactId is a required field
  2588. InitialContactId *string `location:"uri" locationName:"InitialContactId" min:"1" type:"string" required:"true"`
  2589. // The instance ID for the instance from which to retrieve contact attributes.
  2590. //
  2591. // InstanceId is a required field
  2592. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  2593. }
  2594. // String returns the string representation
  2595. func (s GetContactAttributesInput) String() string {
  2596. return awsutil.Prettify(s)
  2597. }
  2598. // GoString returns the string representation
  2599. func (s GetContactAttributesInput) GoString() string {
  2600. return s.String()
  2601. }
  2602. // Validate inspects the fields of the type to determine if they are valid.
  2603. func (s *GetContactAttributesInput) Validate() error {
  2604. invalidParams := request.ErrInvalidParams{Context: "GetContactAttributesInput"}
  2605. if s.InitialContactId == nil {
  2606. invalidParams.Add(request.NewErrParamRequired("InitialContactId"))
  2607. }
  2608. if s.InitialContactId != nil && len(*s.InitialContactId) < 1 {
  2609. invalidParams.Add(request.NewErrParamMinLen("InitialContactId", 1))
  2610. }
  2611. if s.InstanceId == nil {
  2612. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  2613. }
  2614. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  2615. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  2616. }
  2617. if invalidParams.Len() > 0 {
  2618. return invalidParams
  2619. }
  2620. return nil
  2621. }
  2622. // SetInitialContactId sets the InitialContactId field's value.
  2623. func (s *GetContactAttributesInput) SetInitialContactId(v string) *GetContactAttributesInput {
  2624. s.InitialContactId = &v
  2625. return s
  2626. }
  2627. // SetInstanceId sets the InstanceId field's value.
  2628. func (s *GetContactAttributesInput) SetInstanceId(v string) *GetContactAttributesInput {
  2629. s.InstanceId = &v
  2630. return s
  2631. }
  2632. type GetContactAttributesOutput struct {
  2633. _ struct{} `type:"structure"`
  2634. // The attributes to update.
  2635. Attributes map[string]*string `type:"map"`
  2636. }
  2637. // String returns the string representation
  2638. func (s GetContactAttributesOutput) String() string {
  2639. return awsutil.Prettify(s)
  2640. }
  2641. // GoString returns the string representation
  2642. func (s GetContactAttributesOutput) GoString() string {
  2643. return s.String()
  2644. }
  2645. // SetAttributes sets the Attributes field's value.
  2646. func (s *GetContactAttributesOutput) SetAttributes(v map[string]*string) *GetContactAttributesOutput {
  2647. s.Attributes = v
  2648. return s
  2649. }
  2650. type GetCurrentMetricDataInput struct {
  2651. _ struct{} `type:"structure"`
  2652. // A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric
  2653. // includes a name of a metric to retrieve and the unit to use for it. You must
  2654. // list each metric to retrieve data for in the request.
  2655. //
  2656. // The following metrics are available:
  2657. //
  2658. // AGENTS_AVAILABLEUnit: COUNT
  2659. //
  2660. // AGENTS_ONLINEUnit: COUNT
  2661. //
  2662. // AGENTS_ON_CALLUnit: COUNT
  2663. //
  2664. // AGENTS_STAFFEDUnit: COUNT
  2665. //
  2666. // AGENTS_AFTER_CONTACT_WORKUnit: COUNT
  2667. //
  2668. // AGENTS_NON_PRODUCTIVEUnit: COUNT
  2669. //
  2670. // AGENTS_ERRORUnit: COUNT
  2671. //
  2672. // CONTACTS_IN_QUEUEUnit: COUNT
  2673. //
  2674. // OLDEST_CONTACT_AGEUnit: SECONDS
  2675. //
  2676. // CONTACTS_SCHEDULEDUnit: COUNT
  2677. //
  2678. // CurrentMetrics is a required field
  2679. CurrentMetrics []*CurrentMetric `type:"list" required:"true"`
  2680. // A Filters object that contains a list of queue IDs or queue ARNs, up to 100,
  2681. // or list of Channels to use to filter the metrics returned in the response.
  2682. // Metric data is retrieved only for the resources associated with the queue
  2683. // IDs, ARNs, or Channels included in the filter. You can include both IDs and
  2684. // ARNs in the same request. To retrieve metrics for all queues, add the queue
  2685. // ID or ARN for each queue in your instance. Only VOICE is supported for Channels.
  2686. //
  2687. // To find the ARN for a queue, open the queue you want to use in the Amazon
  2688. // Connect Queue editor. The ARN for the queue is displayed in the address bar
  2689. // as part of the URL. For example, the queue ARN is the set of characters at
  2690. // the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61.
  2691. // The queue ID is also included in the URL, and is the string after 'queue/'.
  2692. //
  2693. // Filters is a required field
  2694. Filters *Filters `type:"structure" required:"true"`
  2695. // The grouping applied to the metrics returned. For example, when grouped by
  2696. // QUEUE, the metrics returned apply to each queue rather than aggregated for
  2697. // all queues. If you group by CHANNEL, you should include a Channels filter.
  2698. // The only supported channel is VOICE.
  2699. //
  2700. // If no Grouping is included in the request, a summary of CurrentMetrics is
  2701. // returned.
  2702. Groupings []*string `type:"list"`
  2703. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  2704. // open the AWS console and select Amazon Connect. Select the alias of the instance
  2705. // in the Instance alias column. The instance ID is displayed in the Overview
  2706. // section of your instance settings. For example, the instance ID is the set
  2707. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  2708. //
  2709. // InstanceId is a required field
  2710. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  2711. // MaxResults indicates the maximum number of results to return per page in
  2712. // the response, between 1 and 100.
  2713. MaxResults *int64 `min:"1" type:"integer"`
  2714. // The token for the next set of results. Use the value returned in the previous
  2715. // response in the next request to retrieve the next set of results.
  2716. //
  2717. // The token expires after 5 minutes from the time it is created. Subsequent
  2718. // requests that use the NextToken must use the same request parameters as the
  2719. // request that generated the token.
  2720. NextToken *string `type:"string"`
  2721. }
  2722. // String returns the string representation
  2723. func (s GetCurrentMetricDataInput) String() string {
  2724. return awsutil.Prettify(s)
  2725. }
  2726. // GoString returns the string representation
  2727. func (s GetCurrentMetricDataInput) GoString() string {
  2728. return s.String()
  2729. }
  2730. // Validate inspects the fields of the type to determine if they are valid.
  2731. func (s *GetCurrentMetricDataInput) Validate() error {
  2732. invalidParams := request.ErrInvalidParams{Context: "GetCurrentMetricDataInput"}
  2733. if s.CurrentMetrics == nil {
  2734. invalidParams.Add(request.NewErrParamRequired("CurrentMetrics"))
  2735. }
  2736. if s.Filters == nil {
  2737. invalidParams.Add(request.NewErrParamRequired("Filters"))
  2738. }
  2739. if s.InstanceId == nil {
  2740. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  2741. }
  2742. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  2743. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  2744. }
  2745. if s.MaxResults != nil && *s.MaxResults < 1 {
  2746. invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
  2747. }
  2748. if s.Filters != nil {
  2749. if err := s.Filters.Validate(); err != nil {
  2750. invalidParams.AddNested("Filters", err.(request.ErrInvalidParams))
  2751. }
  2752. }
  2753. if invalidParams.Len() > 0 {
  2754. return invalidParams
  2755. }
  2756. return nil
  2757. }
  2758. // SetCurrentMetrics sets the CurrentMetrics field's value.
  2759. func (s *GetCurrentMetricDataInput) SetCurrentMetrics(v []*CurrentMetric) *GetCurrentMetricDataInput {
  2760. s.CurrentMetrics = v
  2761. return s
  2762. }
  2763. // SetFilters sets the Filters field's value.
  2764. func (s *GetCurrentMetricDataInput) SetFilters(v *Filters) *GetCurrentMetricDataInput {
  2765. s.Filters = v
  2766. return s
  2767. }
  2768. // SetGroupings sets the Groupings field's value.
  2769. func (s *GetCurrentMetricDataInput) SetGroupings(v []*string) *GetCurrentMetricDataInput {
  2770. s.Groupings = v
  2771. return s
  2772. }
  2773. // SetInstanceId sets the InstanceId field's value.
  2774. func (s *GetCurrentMetricDataInput) SetInstanceId(v string) *GetCurrentMetricDataInput {
  2775. s.InstanceId = &v
  2776. return s
  2777. }
  2778. // SetMaxResults sets the MaxResults field's value.
  2779. func (s *GetCurrentMetricDataInput) SetMaxResults(v int64) *GetCurrentMetricDataInput {
  2780. s.MaxResults = &v
  2781. return s
  2782. }
  2783. // SetNextToken sets the NextToken field's value.
  2784. func (s *GetCurrentMetricDataInput) SetNextToken(v string) *GetCurrentMetricDataInput {
  2785. s.NextToken = &v
  2786. return s
  2787. }
  2788. type GetCurrentMetricDataOutput struct {
  2789. _ struct{} `type:"structure"`
  2790. // The time at which CurrentMetricData was retrieved and cached for pagination.
  2791. DataSnapshotTime *time.Time `type:"timestamp"`
  2792. // A list of CurrentMetricResult objects organized by Dimensions combining with
  2793. // CurrentMetricDataCollections.
  2794. //
  2795. // Dimensions is the resourceId specified in the Filters of the request.
  2796. //
  2797. // Collections is a list of CurrentMetricData objects with corresponding values
  2798. // to the CurrentMetrics specified in the request.
  2799. //
  2800. // If no Grouping is specified in the request, Collections is a summary for
  2801. // the CurrentMetric returned.
  2802. MetricResults []*CurrentMetricResult `type:"list"`
  2803. // A string returned in the response. Use the value returned in the response
  2804. // as the value of the NextToken in a subsequent request to retrieve the next
  2805. // set of results.
  2806. //
  2807. // The token expires after 5 minutes from the time it is created. Subsequent
  2808. // requests that use the NextToken must use the same request parameters as the
  2809. // request that generated the token.
  2810. NextToken *string `type:"string"`
  2811. }
  2812. // String returns the string representation
  2813. func (s GetCurrentMetricDataOutput) String() string {
  2814. return awsutil.Prettify(s)
  2815. }
  2816. // GoString returns the string representation
  2817. func (s GetCurrentMetricDataOutput) GoString() string {
  2818. return s.String()
  2819. }
  2820. // SetDataSnapshotTime sets the DataSnapshotTime field's value.
  2821. func (s *GetCurrentMetricDataOutput) SetDataSnapshotTime(v time.Time) *GetCurrentMetricDataOutput {
  2822. s.DataSnapshotTime = &v
  2823. return s
  2824. }
  2825. // SetMetricResults sets the MetricResults field's value.
  2826. func (s *GetCurrentMetricDataOutput) SetMetricResults(v []*CurrentMetricResult) *GetCurrentMetricDataOutput {
  2827. s.MetricResults = v
  2828. return s
  2829. }
  2830. // SetNextToken sets the NextToken field's value.
  2831. func (s *GetCurrentMetricDataOutput) SetNextToken(v string) *GetCurrentMetricDataOutput {
  2832. s.NextToken = &v
  2833. return s
  2834. }
  2835. type GetFederationTokenInput struct {
  2836. _ struct{} `type:"structure"`
  2837. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  2838. // open the AWS console and select Amazon Connect. Select the alias of the instance
  2839. // in the Instance alias column. The instance ID is displayed in the Overview
  2840. // section of your instance settings. For example, the instance ID is the set
  2841. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  2842. //
  2843. // InstanceId is a required field
  2844. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  2845. }
  2846. // String returns the string representation
  2847. func (s GetFederationTokenInput) String() string {
  2848. return awsutil.Prettify(s)
  2849. }
  2850. // GoString returns the string representation
  2851. func (s GetFederationTokenInput) GoString() string {
  2852. return s.String()
  2853. }
  2854. // Validate inspects the fields of the type to determine if they are valid.
  2855. func (s *GetFederationTokenInput) Validate() error {
  2856. invalidParams := request.ErrInvalidParams{Context: "GetFederationTokenInput"}
  2857. if s.InstanceId == nil {
  2858. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  2859. }
  2860. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  2861. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  2862. }
  2863. if invalidParams.Len() > 0 {
  2864. return invalidParams
  2865. }
  2866. return nil
  2867. }
  2868. // SetInstanceId sets the InstanceId field's value.
  2869. func (s *GetFederationTokenInput) SetInstanceId(v string) *GetFederationTokenInput {
  2870. s.InstanceId = &v
  2871. return s
  2872. }
  2873. type GetFederationTokenOutput struct {
  2874. _ struct{} `type:"structure"`
  2875. // The credentials to use for federation.
  2876. Credentials *Credentials `type:"structure"`
  2877. }
  2878. // String returns the string representation
  2879. func (s GetFederationTokenOutput) String() string {
  2880. return awsutil.Prettify(s)
  2881. }
  2882. // GoString returns the string representation
  2883. func (s GetFederationTokenOutput) GoString() string {
  2884. return s.String()
  2885. }
  2886. // SetCredentials sets the Credentials field's value.
  2887. func (s *GetFederationTokenOutput) SetCredentials(v *Credentials) *GetFederationTokenOutput {
  2888. s.Credentials = v
  2889. return s
  2890. }
  2891. type GetMetricDataInput struct {
  2892. _ struct{} `type:"structure"`
  2893. // The timestamp, in UNIX Epoch time format, at which to end the reporting interval
  2894. // for the retrieval of historical metrics data. The time must be specified
  2895. // using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be
  2896. // later than the StartTime timestamp.
  2897. //
  2898. // The time range between StartTime and EndTime must be less than 24 hours.
  2899. //
  2900. // EndTime is a required field
  2901. EndTime *time.Time `type:"timestamp" required:"true"`
  2902. // A Filters object that contains a list of queue IDs or queue ARNs, up to 100,
  2903. // or a list of Channels to use to filter the metrics returned in the response.
  2904. // Metric data is retrieved only for the resources associated with the IDs,
  2905. // ARNs, or Channels included in the filter. You can use both IDs and ARNs together
  2906. // in a request. Only VOICE is supported for Channel.
  2907. //
  2908. // To find the ARN for a queue, open the queue you want to use in the Amazon
  2909. // Connect Queue editor. The ARN for the queue is displayed in the address bar
  2910. // as part of the URL. For example, the queue ARN is the set of characters at
  2911. // the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61.
  2912. // The queue ID is also included in the URL, and is the string after 'queue/'.
  2913. //
  2914. // Filters is a required field
  2915. Filters *Filters `type:"structure" required:"true"`
  2916. // The grouping applied to the metrics returned. For example, when results are
  2917. // grouped by queueId, the metrics returned are grouped by queue. The values
  2918. // returned apply to the metrics for each queue rather than aggregated for all
  2919. // queues.
  2920. //
  2921. // The current version supports grouping by Queue
  2922. //
  2923. // If no Grouping is included in the request, a summary of HistoricalMetrics
  2924. // for all queues is returned.
  2925. Groupings []*string `type:"list"`
  2926. // A list of HistoricalMetric objects that contain the metrics to retrieve with
  2927. // the request.
  2928. //
  2929. // A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold,
  2930. // and Unit.
  2931. //
  2932. // You must list each metric to retrieve data for in the request. For each historical
  2933. // metric you include in the request, you must include a Unit and a Statistic.
  2934. //
  2935. // The following historical metrics are available:
  2936. //
  2937. // CONTACTS_QUEUEDUnit: COUNT
  2938. //
  2939. // Statistic: SUM
  2940. //
  2941. // CONTACTS_HANDLEDUnit: COUNT
  2942. //
  2943. // Statistics: SUM
  2944. //
  2945. // CONTACTS_ABANDONEDUnit: COUNT
  2946. //
  2947. // Statistics: SUM
  2948. //
  2949. // CONTACTS_CONSULTEDUnit: COUNT
  2950. //
  2951. // Statistics: SUM
  2952. //
  2953. // CONTACTS_AGENT_HUNG_UP_FIRSTUnit: COUNT
  2954. //
  2955. // Statistics: SUM
  2956. //
  2957. // CONTACTS_HANDLED_INCOMINGUnit: COUNT
  2958. //
  2959. // Statistics: SUM
  2960. //
  2961. // CONTACTS_HANDLED_OUTBOUNDUnit: COUNT
  2962. //
  2963. // Statistics: SUM
  2964. //
  2965. // CONTACTS_HOLD_ABANDONSUnit: COUNT
  2966. //
  2967. // Statistics: SUM
  2968. //
  2969. // CONTACTS_TRANSFERRED_INUnit: COUNT
  2970. //
  2971. // Statistics: SUM
  2972. //
  2973. // CONTACTS_TRANSFERRED_OUTUnit: COUNT
  2974. //
  2975. // Statistics: SUM
  2976. //
  2977. // CONTACTS_TRANSFERRED_IN_FROM_QUEUEUnit: COUNT
  2978. //
  2979. // Statistics: SUM
  2980. //
  2981. // CONTACTS_TRANSFERRED_OUT_FROM_QUEUEUnit: COUNT
  2982. //
  2983. // Statistics: SUM
  2984. //
  2985. // CALLBACK_CONTACTS_HANDLEDUnit: COUNT
  2986. //
  2987. // Statistics: SUM
  2988. //
  2989. // CALLBACK_CONTACTS_HANDLEDUnit: COUNT
  2990. //
  2991. // Statistics: SUM
  2992. //
  2993. // API_CONTACTS_HANDLEDUnit: COUNT
  2994. //
  2995. // Statistics: SUM
  2996. //
  2997. // CONTACTS_MISSEDUnit: COUNT
  2998. //
  2999. // Statistics: SUM
  3000. //
  3001. // OCCUPANCYUnit: PERCENT
  3002. //
  3003. // Statistics: AVG
  3004. //
  3005. // HANDLE_TIMEUnit: SECONDS
  3006. //
  3007. // Statistics: AVG
  3008. //
  3009. // AFTER_CONTACT_WORK_TIMEUnit: SECONDS
  3010. //
  3011. // Statistics: AVG
  3012. //
  3013. // QUEUED_TIMEUnit: SECONDS
  3014. //
  3015. // Statistics: MAX
  3016. //
  3017. // ABANDON_TIMEUnit: COUNT
  3018. //
  3019. // Statistics: SUM
  3020. //
  3021. // QUEUE_ANSWER_TIMEUnit: SECONDS
  3022. //
  3023. // Statistics: AVG
  3024. //
  3025. // HOLD_TIMEUnit: SECONDS
  3026. //
  3027. // Statistics: AVG
  3028. //
  3029. // INTERACTION_TIMEUnit: SECONDS
  3030. //
  3031. // Statistics: AVG
  3032. //
  3033. // INTERACTION_AND_HOLD_TIMEUnit: SECONDS
  3034. //
  3035. // Statistics: AVG
  3036. //
  3037. // SERVICE_LEVELUnit: PERCENT
  3038. //
  3039. // Statistics: AVG
  3040. //
  3041. // Threshold: Only "Less than" comparisons are supported, with the following
  3042. // service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300,
  3043. // 600
  3044. //
  3045. // HistoricalMetrics is a required field
  3046. HistoricalMetrics []*HistoricalMetric `type:"list" required:"true"`
  3047. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  3048. // open the AWS console and select Amazon Connect. Select the alias of the instance
  3049. // in the Instance alias column. The instance ID is displayed in the Overview
  3050. // section of your instance settings. For example, the instance ID is the set
  3051. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  3052. //
  3053. // InstanceId is a required field
  3054. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  3055. // Indicates the maximum number of results to return per page in the response,
  3056. // between 1-100.
  3057. MaxResults *int64 `min:"1" type:"integer"`
  3058. // The token for the next set of results. Use the value returned in the previous
  3059. // response in the next request to retrieve the next set of results.
  3060. NextToken *string `type:"string"`
  3061. // The timestamp, in UNIX Epoch time format, at which to start the reporting
  3062. // interval for the retrieval of historical metrics data. The time must be specified
  3063. // using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
  3064. //
  3065. // StartTime cannot be earlier than 24 hours before the time of the request.
  3066. // Historical metrics are available in Amazon Connect only for 24 hours.
  3067. //
  3068. // StartTime is a required field
  3069. StartTime *time.Time `type:"timestamp" required:"true"`
  3070. }
  3071. // String returns the string representation
  3072. func (s GetMetricDataInput) String() string {
  3073. return awsutil.Prettify(s)
  3074. }
  3075. // GoString returns the string representation
  3076. func (s GetMetricDataInput) GoString() string {
  3077. return s.String()
  3078. }
  3079. // Validate inspects the fields of the type to determine if they are valid.
  3080. func (s *GetMetricDataInput) Validate() error {
  3081. invalidParams := request.ErrInvalidParams{Context: "GetMetricDataInput"}
  3082. if s.EndTime == nil {
  3083. invalidParams.Add(request.NewErrParamRequired("EndTime"))
  3084. }
  3085. if s.Filters == nil {
  3086. invalidParams.Add(request.NewErrParamRequired("Filters"))
  3087. }
  3088. if s.HistoricalMetrics == nil {
  3089. invalidParams.Add(request.NewErrParamRequired("HistoricalMetrics"))
  3090. }
  3091. if s.InstanceId == nil {
  3092. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  3093. }
  3094. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  3095. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  3096. }
  3097. if s.MaxResults != nil && *s.MaxResults < 1 {
  3098. invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
  3099. }
  3100. if s.StartTime == nil {
  3101. invalidParams.Add(request.NewErrParamRequired("StartTime"))
  3102. }
  3103. if s.Filters != nil {
  3104. if err := s.Filters.Validate(); err != nil {
  3105. invalidParams.AddNested("Filters", err.(request.ErrInvalidParams))
  3106. }
  3107. }
  3108. if invalidParams.Len() > 0 {
  3109. return invalidParams
  3110. }
  3111. return nil
  3112. }
  3113. // SetEndTime sets the EndTime field's value.
  3114. func (s *GetMetricDataInput) SetEndTime(v time.Time) *GetMetricDataInput {
  3115. s.EndTime = &v
  3116. return s
  3117. }
  3118. // SetFilters sets the Filters field's value.
  3119. func (s *GetMetricDataInput) SetFilters(v *Filters) *GetMetricDataInput {
  3120. s.Filters = v
  3121. return s
  3122. }
  3123. // SetGroupings sets the Groupings field's value.
  3124. func (s *GetMetricDataInput) SetGroupings(v []*string) *GetMetricDataInput {
  3125. s.Groupings = v
  3126. return s
  3127. }
  3128. // SetHistoricalMetrics sets the HistoricalMetrics field's value.
  3129. func (s *GetMetricDataInput) SetHistoricalMetrics(v []*HistoricalMetric) *GetMetricDataInput {
  3130. s.HistoricalMetrics = v
  3131. return s
  3132. }
  3133. // SetInstanceId sets the InstanceId field's value.
  3134. func (s *GetMetricDataInput) SetInstanceId(v string) *GetMetricDataInput {
  3135. s.InstanceId = &v
  3136. return s
  3137. }
  3138. // SetMaxResults sets the MaxResults field's value.
  3139. func (s *GetMetricDataInput) SetMaxResults(v int64) *GetMetricDataInput {
  3140. s.MaxResults = &v
  3141. return s
  3142. }
  3143. // SetNextToken sets the NextToken field's value.
  3144. func (s *GetMetricDataInput) SetNextToken(v string) *GetMetricDataInput {
  3145. s.NextToken = &v
  3146. return s
  3147. }
  3148. // SetStartTime sets the StartTime field's value.
  3149. func (s *GetMetricDataInput) SetStartTime(v time.Time) *GetMetricDataInput {
  3150. s.StartTime = &v
  3151. return s
  3152. }
  3153. type GetMetricDataOutput struct {
  3154. _ struct{} `type:"structure"`
  3155. // A list of HistoricalMetricResult objects, organized by Dimensions, which
  3156. // is the ID of the resource specified in the Filters used for the request.
  3157. // The metrics are combined with the metrics included in Collections, which
  3158. // is a list of HisotricalMetricData objects.
  3159. //
  3160. // If no Grouping is specified in the request, Collections includes summary
  3161. // data for the HistoricalMetrics.
  3162. MetricResults []*HistoricalMetricResult `type:"list"`
  3163. // A string returned in the response. Use the value returned in the response
  3164. // as the value of the NextToken in a subsequent request to retrieve the next
  3165. // set of results.
  3166. //
  3167. // The token expires after 5 minutes from the time it is created. Subsequent
  3168. // requests that use the NextToken must use the same request parameters as the
  3169. // request that generated the token.
  3170. NextToken *string `type:"string"`
  3171. }
  3172. // String returns the string representation
  3173. func (s GetMetricDataOutput) String() string {
  3174. return awsutil.Prettify(s)
  3175. }
  3176. // GoString returns the string representation
  3177. func (s GetMetricDataOutput) GoString() string {
  3178. return s.String()
  3179. }
  3180. // SetMetricResults sets the MetricResults field's value.
  3181. func (s *GetMetricDataOutput) SetMetricResults(v []*HistoricalMetricResult) *GetMetricDataOutput {
  3182. s.MetricResults = v
  3183. return s
  3184. }
  3185. // SetNextToken sets the NextToken field's value.
  3186. func (s *GetMetricDataOutput) SetNextToken(v string) *GetMetricDataOutput {
  3187. s.NextToken = &v
  3188. return s
  3189. }
  3190. // A HierarchyGroup object that contains information about a hierarchy group
  3191. // in your Amazon Connect instance.
  3192. type HierarchyGroup struct {
  3193. _ struct{} `type:"structure"`
  3194. // The Amazon Resource Name (ARN) for the hierarchy group.
  3195. Arn *string `type:"string"`
  3196. // A HierarchyPath object that contains information about the levels in the
  3197. // hierarchy group.
  3198. HierarchyPath *HierarchyPath `type:"structure"`
  3199. // The identifier for the hierarchy group.
  3200. Id *string `type:"string"`
  3201. // The identifier for the level in the hierarchy group.
  3202. LevelId *string `type:"string"`
  3203. // The name of the hierarchy group in your instance.
  3204. Name *string `type:"string"`
  3205. }
  3206. // String returns the string representation
  3207. func (s HierarchyGroup) String() string {
  3208. return awsutil.Prettify(s)
  3209. }
  3210. // GoString returns the string representation
  3211. func (s HierarchyGroup) GoString() string {
  3212. return s.String()
  3213. }
  3214. // SetArn sets the Arn field's value.
  3215. func (s *HierarchyGroup) SetArn(v string) *HierarchyGroup {
  3216. s.Arn = &v
  3217. return s
  3218. }
  3219. // SetHierarchyPath sets the HierarchyPath field's value.
  3220. func (s *HierarchyGroup) SetHierarchyPath(v *HierarchyPath) *HierarchyGroup {
  3221. s.HierarchyPath = v
  3222. return s
  3223. }
  3224. // SetId sets the Id field's value.
  3225. func (s *HierarchyGroup) SetId(v string) *HierarchyGroup {
  3226. s.Id = &v
  3227. return s
  3228. }
  3229. // SetLevelId sets the LevelId field's value.
  3230. func (s *HierarchyGroup) SetLevelId(v string) *HierarchyGroup {
  3231. s.LevelId = &v
  3232. return s
  3233. }
  3234. // SetName sets the Name field's value.
  3235. func (s *HierarchyGroup) SetName(v string) *HierarchyGroup {
  3236. s.Name = &v
  3237. return s
  3238. }
  3239. // A HierarchyGroupSummary object that contains information about the hierarchy
  3240. // group, including ARN, Id, and Name.
  3241. type HierarchyGroupSummary struct {
  3242. _ struct{} `type:"structure"`
  3243. // The ARN for the hierarchy group.
  3244. Arn *string `type:"string"`
  3245. // The identifier of the hierarchy group.
  3246. Id *string `type:"string"`
  3247. // The name of the hierarchy group.
  3248. Name *string `type:"string"`
  3249. }
  3250. // String returns the string representation
  3251. func (s HierarchyGroupSummary) String() string {
  3252. return awsutil.Prettify(s)
  3253. }
  3254. // GoString returns the string representation
  3255. func (s HierarchyGroupSummary) GoString() string {
  3256. return s.String()
  3257. }
  3258. // SetArn sets the Arn field's value.
  3259. func (s *HierarchyGroupSummary) SetArn(v string) *HierarchyGroupSummary {
  3260. s.Arn = &v
  3261. return s
  3262. }
  3263. // SetId sets the Id field's value.
  3264. func (s *HierarchyGroupSummary) SetId(v string) *HierarchyGroupSummary {
  3265. s.Id = &v
  3266. return s
  3267. }
  3268. // SetName sets the Name field's value.
  3269. func (s *HierarchyGroupSummary) SetName(v string) *HierarchyGroupSummary {
  3270. s.Name = &v
  3271. return s
  3272. }
  3273. // A HierarchyLevel object that contains information about the levels in a hierarchy
  3274. // group, including ARN, Id, and Name.
  3275. type HierarchyLevel struct {
  3276. _ struct{} `type:"structure"`
  3277. // The ARN for the hierarchy group level.
  3278. Arn *string `type:"string"`
  3279. // The identifier for the hierarchy group level.
  3280. Id *string `type:"string"`
  3281. // The name of the hierarchy group level.
  3282. Name *string `type:"string"`
  3283. }
  3284. // String returns the string representation
  3285. func (s HierarchyLevel) String() string {
  3286. return awsutil.Prettify(s)
  3287. }
  3288. // GoString returns the string representation
  3289. func (s HierarchyLevel) GoString() string {
  3290. return s.String()
  3291. }
  3292. // SetArn sets the Arn field's value.
  3293. func (s *HierarchyLevel) SetArn(v string) *HierarchyLevel {
  3294. s.Arn = &v
  3295. return s
  3296. }
  3297. // SetId sets the Id field's value.
  3298. func (s *HierarchyLevel) SetId(v string) *HierarchyLevel {
  3299. s.Id = &v
  3300. return s
  3301. }
  3302. // SetName sets the Name field's value.
  3303. func (s *HierarchyLevel) SetName(v string) *HierarchyLevel {
  3304. s.Name = &v
  3305. return s
  3306. }
  3307. // A HierarchyPath object that contains information about the levels of the
  3308. // hierarchy group.
  3309. type HierarchyPath struct {
  3310. _ struct{} `type:"structure"`
  3311. // A HierarchyGroupSummary object that contains information about the level
  3312. // of the hierarchy group, including ARN, Id, and Name.
  3313. LevelFive *HierarchyGroupSummary `type:"structure"`
  3314. // A HierarchyGroupSummary object that contains information about the level
  3315. // of the hierarchy group, including ARN, Id, and Name.
  3316. LevelFour *HierarchyGroupSummary `type:"structure"`
  3317. // A HierarchyGroupSummary object that contains information about the level
  3318. // of the hierarchy group, including ARN, Id, and Name.
  3319. LevelOne *HierarchyGroupSummary `type:"structure"`
  3320. // A HierarchyGroupSummary object that contains information about the level
  3321. // of the hierarchy group, including ARN, Id, and Name.
  3322. LevelThree *HierarchyGroupSummary `type:"structure"`
  3323. // A HierarchyGroupSummary object that contains information about the level
  3324. // of the hierarchy group, including ARN, Id, and Name.
  3325. LevelTwo *HierarchyGroupSummary `type:"structure"`
  3326. }
  3327. // String returns the string representation
  3328. func (s HierarchyPath) String() string {
  3329. return awsutil.Prettify(s)
  3330. }
  3331. // GoString returns the string representation
  3332. func (s HierarchyPath) GoString() string {
  3333. return s.String()
  3334. }
  3335. // SetLevelFive sets the LevelFive field's value.
  3336. func (s *HierarchyPath) SetLevelFive(v *HierarchyGroupSummary) *HierarchyPath {
  3337. s.LevelFive = v
  3338. return s
  3339. }
  3340. // SetLevelFour sets the LevelFour field's value.
  3341. func (s *HierarchyPath) SetLevelFour(v *HierarchyGroupSummary) *HierarchyPath {
  3342. s.LevelFour = v
  3343. return s
  3344. }
  3345. // SetLevelOne sets the LevelOne field's value.
  3346. func (s *HierarchyPath) SetLevelOne(v *HierarchyGroupSummary) *HierarchyPath {
  3347. s.LevelOne = v
  3348. return s
  3349. }
  3350. // SetLevelThree sets the LevelThree field's value.
  3351. func (s *HierarchyPath) SetLevelThree(v *HierarchyGroupSummary) *HierarchyPath {
  3352. s.LevelThree = v
  3353. return s
  3354. }
  3355. // SetLevelTwo sets the LevelTwo field's value.
  3356. func (s *HierarchyPath) SetLevelTwo(v *HierarchyGroupSummary) *HierarchyPath {
  3357. s.LevelTwo = v
  3358. return s
  3359. }
  3360. // A HierarchyStructure object that contains information about the hierarchy
  3361. // group structure.
  3362. type HierarchyStructure struct {
  3363. _ struct{} `type:"structure"`
  3364. // A HierarchyLevel object that contains information about the hierarchy group
  3365. // level.
  3366. LevelFive *HierarchyLevel `type:"structure"`
  3367. // A HierarchyLevel object that contains information about the hierarchy group
  3368. // level.
  3369. LevelFour *HierarchyLevel `type:"structure"`
  3370. // A HierarchyLevel object that contains information about the hierarchy group
  3371. // level.
  3372. LevelOne *HierarchyLevel `type:"structure"`
  3373. // A HierarchyLevel object that contains information about the hierarchy group
  3374. // level.
  3375. LevelThree *HierarchyLevel `type:"structure"`
  3376. // A HierarchyLevel object that contains information about the hierarchy group
  3377. // level.
  3378. LevelTwo *HierarchyLevel `type:"structure"`
  3379. }
  3380. // String returns the string representation
  3381. func (s HierarchyStructure) String() string {
  3382. return awsutil.Prettify(s)
  3383. }
  3384. // GoString returns the string representation
  3385. func (s HierarchyStructure) GoString() string {
  3386. return s.String()
  3387. }
  3388. // SetLevelFive sets the LevelFive field's value.
  3389. func (s *HierarchyStructure) SetLevelFive(v *HierarchyLevel) *HierarchyStructure {
  3390. s.LevelFive = v
  3391. return s
  3392. }
  3393. // SetLevelFour sets the LevelFour field's value.
  3394. func (s *HierarchyStructure) SetLevelFour(v *HierarchyLevel) *HierarchyStructure {
  3395. s.LevelFour = v
  3396. return s
  3397. }
  3398. // SetLevelOne sets the LevelOne field's value.
  3399. func (s *HierarchyStructure) SetLevelOne(v *HierarchyLevel) *HierarchyStructure {
  3400. s.LevelOne = v
  3401. return s
  3402. }
  3403. // SetLevelThree sets the LevelThree field's value.
  3404. func (s *HierarchyStructure) SetLevelThree(v *HierarchyLevel) *HierarchyStructure {
  3405. s.LevelThree = v
  3406. return s
  3407. }
  3408. // SetLevelTwo sets the LevelTwo field's value.
  3409. func (s *HierarchyStructure) SetLevelTwo(v *HierarchyLevel) *HierarchyStructure {
  3410. s.LevelTwo = v
  3411. return s
  3412. }
  3413. // A HistoricalMetric object that contains the Name, Unit, Statistic, and Threshold
  3414. // for the metric.
  3415. type HistoricalMetric struct {
  3416. _ struct{} `type:"structure"`
  3417. // The name of the historical metric.
  3418. Name *string `type:"string" enum:"HistoricalMetricName"`
  3419. // The statistic for the metric.
  3420. Statistic *string `type:"string" enum:"Statistic"`
  3421. // The threshold for the metric, used with service level metrics.
  3422. Threshold *Threshold `type:"structure"`
  3423. // The unit for the metric.
  3424. Unit *string `type:"string" enum:"Unit"`
  3425. }
  3426. // String returns the string representation
  3427. func (s HistoricalMetric) String() string {
  3428. return awsutil.Prettify(s)
  3429. }
  3430. // GoString returns the string representation
  3431. func (s HistoricalMetric) GoString() string {
  3432. return s.String()
  3433. }
  3434. // SetName sets the Name field's value.
  3435. func (s *HistoricalMetric) SetName(v string) *HistoricalMetric {
  3436. s.Name = &v
  3437. return s
  3438. }
  3439. // SetStatistic sets the Statistic field's value.
  3440. func (s *HistoricalMetric) SetStatistic(v string) *HistoricalMetric {
  3441. s.Statistic = &v
  3442. return s
  3443. }
  3444. // SetThreshold sets the Threshold field's value.
  3445. func (s *HistoricalMetric) SetThreshold(v *Threshold) *HistoricalMetric {
  3446. s.Threshold = v
  3447. return s
  3448. }
  3449. // SetUnit sets the Unit field's value.
  3450. func (s *HistoricalMetric) SetUnit(v string) *HistoricalMetric {
  3451. s.Unit = &v
  3452. return s
  3453. }
  3454. // A HistoricalMetricData object than contains a Metric and a Value.
  3455. type HistoricalMetricData struct {
  3456. _ struct{} `type:"structure"`
  3457. // A HistoricalMetric object.
  3458. Metric *HistoricalMetric `type:"structure"`
  3459. // The Value of the metric.
  3460. Value *float64 `type:"double"`
  3461. }
  3462. // String returns the string representation
  3463. func (s HistoricalMetricData) String() string {
  3464. return awsutil.Prettify(s)
  3465. }
  3466. // GoString returns the string representation
  3467. func (s HistoricalMetricData) GoString() string {
  3468. return s.String()
  3469. }
  3470. // SetMetric sets the Metric field's value.
  3471. func (s *HistoricalMetricData) SetMetric(v *HistoricalMetric) *HistoricalMetricData {
  3472. s.Metric = v
  3473. return s
  3474. }
  3475. // SetValue sets the Value field's value.
  3476. func (s *HistoricalMetricData) SetValue(v float64) *HistoricalMetricData {
  3477. s.Value = &v
  3478. return s
  3479. }
  3480. // The metrics data returned from a GetMetricData operation.
  3481. type HistoricalMetricResult struct {
  3482. _ struct{} `type:"structure"`
  3483. // A list of HistoricalMetricData objects.
  3484. Collections []*HistoricalMetricData `type:"list"`
  3485. // The Dimensions for the metrics.
  3486. Dimensions *Dimensions `type:"structure"`
  3487. }
  3488. // String returns the string representation
  3489. func (s HistoricalMetricResult) String() string {
  3490. return awsutil.Prettify(s)
  3491. }
  3492. // GoString returns the string representation
  3493. func (s HistoricalMetricResult) GoString() string {
  3494. return s.String()
  3495. }
  3496. // SetCollections sets the Collections field's value.
  3497. func (s *HistoricalMetricResult) SetCollections(v []*HistoricalMetricData) *HistoricalMetricResult {
  3498. s.Collections = v
  3499. return s
  3500. }
  3501. // SetDimensions sets the Dimensions field's value.
  3502. func (s *HistoricalMetricResult) SetDimensions(v *Dimensions) *HistoricalMetricResult {
  3503. s.Dimensions = v
  3504. return s
  3505. }
  3506. type ListRoutingProfilesInput struct {
  3507. _ struct{} `type:"structure"`
  3508. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  3509. // open the AWS console and select Amazon Connect. Select the alias of the instance
  3510. // in the Instance alias column. The instance ID is displayed in the Overview
  3511. // section of your instance settings. For example, the instance ID is the set
  3512. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  3513. //
  3514. // InstanceId is a required field
  3515. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  3516. // The maximum number of routing profiles to return in the response.
  3517. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
  3518. // The token for the next set of results. Use the value returned in the previous
  3519. // response in the next request to retrieve the next set of results.
  3520. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
  3521. }
  3522. // String returns the string representation
  3523. func (s ListRoutingProfilesInput) String() string {
  3524. return awsutil.Prettify(s)
  3525. }
  3526. // GoString returns the string representation
  3527. func (s ListRoutingProfilesInput) GoString() string {
  3528. return s.String()
  3529. }
  3530. // Validate inspects the fields of the type to determine if they are valid.
  3531. func (s *ListRoutingProfilesInput) Validate() error {
  3532. invalidParams := request.ErrInvalidParams{Context: "ListRoutingProfilesInput"}
  3533. if s.InstanceId == nil {
  3534. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  3535. }
  3536. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  3537. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  3538. }
  3539. if s.MaxResults != nil && *s.MaxResults < 1 {
  3540. invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
  3541. }
  3542. if invalidParams.Len() > 0 {
  3543. return invalidParams
  3544. }
  3545. return nil
  3546. }
  3547. // SetInstanceId sets the InstanceId field's value.
  3548. func (s *ListRoutingProfilesInput) SetInstanceId(v string) *ListRoutingProfilesInput {
  3549. s.InstanceId = &v
  3550. return s
  3551. }
  3552. // SetMaxResults sets the MaxResults field's value.
  3553. func (s *ListRoutingProfilesInput) SetMaxResults(v int64) *ListRoutingProfilesInput {
  3554. s.MaxResults = &v
  3555. return s
  3556. }
  3557. // SetNextToken sets the NextToken field's value.
  3558. func (s *ListRoutingProfilesInput) SetNextToken(v string) *ListRoutingProfilesInput {
  3559. s.NextToken = &v
  3560. return s
  3561. }
  3562. type ListRoutingProfilesOutput struct {
  3563. _ struct{} `type:"structure"`
  3564. // A string returned in the response. Use the value returned in the response
  3565. // as the value of the NextToken in a subsequent request to retrieve the next
  3566. // set of results.
  3567. NextToken *string `type:"string"`
  3568. // An array of RoutingProfileSummary objects that include the ARN, Id, and Name
  3569. // of the routing profile.
  3570. RoutingProfileSummaryList []*RoutingProfileSummary `type:"list"`
  3571. }
  3572. // String returns the string representation
  3573. func (s ListRoutingProfilesOutput) String() string {
  3574. return awsutil.Prettify(s)
  3575. }
  3576. // GoString returns the string representation
  3577. func (s ListRoutingProfilesOutput) GoString() string {
  3578. return s.String()
  3579. }
  3580. // SetNextToken sets the NextToken field's value.
  3581. func (s *ListRoutingProfilesOutput) SetNextToken(v string) *ListRoutingProfilesOutput {
  3582. s.NextToken = &v
  3583. return s
  3584. }
  3585. // SetRoutingProfileSummaryList sets the RoutingProfileSummaryList field's value.
  3586. func (s *ListRoutingProfilesOutput) SetRoutingProfileSummaryList(v []*RoutingProfileSummary) *ListRoutingProfilesOutput {
  3587. s.RoutingProfileSummaryList = v
  3588. return s
  3589. }
  3590. type ListSecurityProfilesInput struct {
  3591. _ struct{} `type:"structure"`
  3592. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  3593. // open the AWS console and select Amazon Connect. Select the alias of the instance
  3594. // in the Instance alias column. The instance ID is displayed in the Overview
  3595. // section of your instance settings. For example, the instance ID is the set
  3596. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  3597. //
  3598. // InstanceId is a required field
  3599. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  3600. // The maximum number of security profiles to return.
  3601. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
  3602. // The token for the next set of results. Use the value returned in the previous
  3603. // response in the next request to retrieve the next set of results.
  3604. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
  3605. }
  3606. // String returns the string representation
  3607. func (s ListSecurityProfilesInput) String() string {
  3608. return awsutil.Prettify(s)
  3609. }
  3610. // GoString returns the string representation
  3611. func (s ListSecurityProfilesInput) GoString() string {
  3612. return s.String()
  3613. }
  3614. // Validate inspects the fields of the type to determine if they are valid.
  3615. func (s *ListSecurityProfilesInput) Validate() error {
  3616. invalidParams := request.ErrInvalidParams{Context: "ListSecurityProfilesInput"}
  3617. if s.InstanceId == nil {
  3618. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  3619. }
  3620. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  3621. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  3622. }
  3623. if s.MaxResults != nil && *s.MaxResults < 1 {
  3624. invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
  3625. }
  3626. if invalidParams.Len() > 0 {
  3627. return invalidParams
  3628. }
  3629. return nil
  3630. }
  3631. // SetInstanceId sets the InstanceId field's value.
  3632. func (s *ListSecurityProfilesInput) SetInstanceId(v string) *ListSecurityProfilesInput {
  3633. s.InstanceId = &v
  3634. return s
  3635. }
  3636. // SetMaxResults sets the MaxResults field's value.
  3637. func (s *ListSecurityProfilesInput) SetMaxResults(v int64) *ListSecurityProfilesInput {
  3638. s.MaxResults = &v
  3639. return s
  3640. }
  3641. // SetNextToken sets the NextToken field's value.
  3642. func (s *ListSecurityProfilesInput) SetNextToken(v string) *ListSecurityProfilesInput {
  3643. s.NextToken = &v
  3644. return s
  3645. }
  3646. type ListSecurityProfilesOutput struct {
  3647. _ struct{} `type:"structure"`
  3648. // A string returned in the response. Use the value returned in the response
  3649. // as the value of the NextToken in a subsequent request to retrieve the next
  3650. // set of results.
  3651. NextToken *string `type:"string"`
  3652. // An array of SecurityProfileSummary objects.
  3653. SecurityProfileSummaryList []*SecurityProfileSummary `type:"list"`
  3654. }
  3655. // String returns the string representation
  3656. func (s ListSecurityProfilesOutput) String() string {
  3657. return awsutil.Prettify(s)
  3658. }
  3659. // GoString returns the string representation
  3660. func (s ListSecurityProfilesOutput) GoString() string {
  3661. return s.String()
  3662. }
  3663. // SetNextToken sets the NextToken field's value.
  3664. func (s *ListSecurityProfilesOutput) SetNextToken(v string) *ListSecurityProfilesOutput {
  3665. s.NextToken = &v
  3666. return s
  3667. }
  3668. // SetSecurityProfileSummaryList sets the SecurityProfileSummaryList field's value.
  3669. func (s *ListSecurityProfilesOutput) SetSecurityProfileSummaryList(v []*SecurityProfileSummary) *ListSecurityProfilesOutput {
  3670. s.SecurityProfileSummaryList = v
  3671. return s
  3672. }
  3673. type ListUserHierarchyGroupsInput struct {
  3674. _ struct{} `type:"structure"`
  3675. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  3676. // open the AWS console and select Amazon Connect. Select the alias of the instance
  3677. // in the Instance alias column. The instance ID is displayed in the Overview
  3678. // section of your instance settings. For example, the instance ID is the set
  3679. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  3680. //
  3681. // InstanceId is a required field
  3682. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  3683. // The maximum number of hierarchy groups to return.
  3684. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
  3685. // The token for the next set of results. Use the value returned in the previous
  3686. // response in the next request to retrieve the next set of results.
  3687. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
  3688. }
  3689. // String returns the string representation
  3690. func (s ListUserHierarchyGroupsInput) String() string {
  3691. return awsutil.Prettify(s)
  3692. }
  3693. // GoString returns the string representation
  3694. func (s ListUserHierarchyGroupsInput) GoString() string {
  3695. return s.String()
  3696. }
  3697. // Validate inspects the fields of the type to determine if they are valid.
  3698. func (s *ListUserHierarchyGroupsInput) Validate() error {
  3699. invalidParams := request.ErrInvalidParams{Context: "ListUserHierarchyGroupsInput"}
  3700. if s.InstanceId == nil {
  3701. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  3702. }
  3703. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  3704. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  3705. }
  3706. if s.MaxResults != nil && *s.MaxResults < 1 {
  3707. invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
  3708. }
  3709. if invalidParams.Len() > 0 {
  3710. return invalidParams
  3711. }
  3712. return nil
  3713. }
  3714. // SetInstanceId sets the InstanceId field's value.
  3715. func (s *ListUserHierarchyGroupsInput) SetInstanceId(v string) *ListUserHierarchyGroupsInput {
  3716. s.InstanceId = &v
  3717. return s
  3718. }
  3719. // SetMaxResults sets the MaxResults field's value.
  3720. func (s *ListUserHierarchyGroupsInput) SetMaxResults(v int64) *ListUserHierarchyGroupsInput {
  3721. s.MaxResults = &v
  3722. return s
  3723. }
  3724. // SetNextToken sets the NextToken field's value.
  3725. func (s *ListUserHierarchyGroupsInput) SetNextToken(v string) *ListUserHierarchyGroupsInput {
  3726. s.NextToken = &v
  3727. return s
  3728. }
  3729. type ListUserHierarchyGroupsOutput struct {
  3730. _ struct{} `type:"structure"`
  3731. // A string returned in the response. Use the value returned in the response
  3732. // as the value of the NextToken in a subsequent request to retrieve the next
  3733. // set of results.
  3734. NextToken *string `type:"string"`
  3735. // An array of HierarchyGroupSummary objects.
  3736. UserHierarchyGroupSummaryList []*HierarchyGroupSummary `type:"list"`
  3737. }
  3738. // String returns the string representation
  3739. func (s ListUserHierarchyGroupsOutput) String() string {
  3740. return awsutil.Prettify(s)
  3741. }
  3742. // GoString returns the string representation
  3743. func (s ListUserHierarchyGroupsOutput) GoString() string {
  3744. return s.String()
  3745. }
  3746. // SetNextToken sets the NextToken field's value.
  3747. func (s *ListUserHierarchyGroupsOutput) SetNextToken(v string) *ListUserHierarchyGroupsOutput {
  3748. s.NextToken = &v
  3749. return s
  3750. }
  3751. // SetUserHierarchyGroupSummaryList sets the UserHierarchyGroupSummaryList field's value.
  3752. func (s *ListUserHierarchyGroupsOutput) SetUserHierarchyGroupSummaryList(v []*HierarchyGroupSummary) *ListUserHierarchyGroupsOutput {
  3753. s.UserHierarchyGroupSummaryList = v
  3754. return s
  3755. }
  3756. type ListUsersInput struct {
  3757. _ struct{} `type:"structure"`
  3758. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  3759. // open the AWS console and select Amazon Connect. Select the alias of the instance
  3760. // in the Instance alias column. The instance ID is displayed in the Overview
  3761. // section of your instance settings. For example, the instance ID is the set
  3762. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  3763. //
  3764. // InstanceId is a required field
  3765. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  3766. // The maximum number of results to return in the response.
  3767. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
  3768. // The token for the next set of results. Use the value returned in the previous
  3769. // response in the next request to retrieve the next set of results.
  3770. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
  3771. }
  3772. // String returns the string representation
  3773. func (s ListUsersInput) String() string {
  3774. return awsutil.Prettify(s)
  3775. }
  3776. // GoString returns the string representation
  3777. func (s ListUsersInput) GoString() string {
  3778. return s.String()
  3779. }
  3780. // Validate inspects the fields of the type to determine if they are valid.
  3781. func (s *ListUsersInput) Validate() error {
  3782. invalidParams := request.ErrInvalidParams{Context: "ListUsersInput"}
  3783. if s.InstanceId == nil {
  3784. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  3785. }
  3786. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  3787. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  3788. }
  3789. if s.MaxResults != nil && *s.MaxResults < 1 {
  3790. invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
  3791. }
  3792. if invalidParams.Len() > 0 {
  3793. return invalidParams
  3794. }
  3795. return nil
  3796. }
  3797. // SetInstanceId sets the InstanceId field's value.
  3798. func (s *ListUsersInput) SetInstanceId(v string) *ListUsersInput {
  3799. s.InstanceId = &v
  3800. return s
  3801. }
  3802. // SetMaxResults sets the MaxResults field's value.
  3803. func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput {
  3804. s.MaxResults = &v
  3805. return s
  3806. }
  3807. // SetNextToken sets the NextToken field's value.
  3808. func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput {
  3809. s.NextToken = &v
  3810. return s
  3811. }
  3812. type ListUsersOutput struct {
  3813. _ struct{} `type:"structure"`
  3814. // A string returned in the response. Use the value returned in the response
  3815. // as the value of the NextToken in a subsequent request to retrieve the next
  3816. // set of results.
  3817. NextToken *string `type:"string"`
  3818. // An array of UserSummary objects that contain information about the users
  3819. // in your instance.
  3820. UserSummaryList []*UserSummary `type:"list"`
  3821. }
  3822. // String returns the string representation
  3823. func (s ListUsersOutput) String() string {
  3824. return awsutil.Prettify(s)
  3825. }
  3826. // GoString returns the string representation
  3827. func (s ListUsersOutput) GoString() string {
  3828. return s.String()
  3829. }
  3830. // SetNextToken sets the NextToken field's value.
  3831. func (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput {
  3832. s.NextToken = &v
  3833. return s
  3834. }
  3835. // SetUserSummaryList sets the UserSummaryList field's value.
  3836. func (s *ListUsersOutput) SetUserSummaryList(v []*UserSummary) *ListUsersOutput {
  3837. s.UserSummaryList = v
  3838. return s
  3839. }
  3840. // A QueueReference object that contains the the QueueId and ARN for the queue
  3841. // resource for which metrics are returned.
  3842. type QueueReference struct {
  3843. _ struct{} `type:"structure"`
  3844. // The Amazon Resource Name (ARN) of queue.
  3845. Arn *string `type:"string"`
  3846. // The ID of the queue associated with the metrics returned.
  3847. Id *string `type:"string"`
  3848. }
  3849. // String returns the string representation
  3850. func (s QueueReference) String() string {
  3851. return awsutil.Prettify(s)
  3852. }
  3853. // GoString returns the string representation
  3854. func (s QueueReference) GoString() string {
  3855. return s.String()
  3856. }
  3857. // SetArn sets the Arn field's value.
  3858. func (s *QueueReference) SetArn(v string) *QueueReference {
  3859. s.Arn = &v
  3860. return s
  3861. }
  3862. // SetId sets the Id field's value.
  3863. func (s *QueueReference) SetId(v string) *QueueReference {
  3864. s.Id = &v
  3865. return s
  3866. }
  3867. // A RoutingProfileSummary object that contains information about a routing
  3868. // profile, including ARN, Id, and Name.
  3869. type RoutingProfileSummary struct {
  3870. _ struct{} `type:"structure"`
  3871. // The ARN of the routing profile.
  3872. Arn *string `type:"string"`
  3873. // The identifier of the routing profile.
  3874. Id *string `type:"string"`
  3875. // The name of the routing profile.
  3876. Name *string `min:"1" type:"string"`
  3877. }
  3878. // String returns the string representation
  3879. func (s RoutingProfileSummary) String() string {
  3880. return awsutil.Prettify(s)
  3881. }
  3882. // GoString returns the string representation
  3883. func (s RoutingProfileSummary) GoString() string {
  3884. return s.String()
  3885. }
  3886. // SetArn sets the Arn field's value.
  3887. func (s *RoutingProfileSummary) SetArn(v string) *RoutingProfileSummary {
  3888. s.Arn = &v
  3889. return s
  3890. }
  3891. // SetId sets the Id field's value.
  3892. func (s *RoutingProfileSummary) SetId(v string) *RoutingProfileSummary {
  3893. s.Id = &v
  3894. return s
  3895. }
  3896. // SetName sets the Name field's value.
  3897. func (s *RoutingProfileSummary) SetName(v string) *RoutingProfileSummary {
  3898. s.Name = &v
  3899. return s
  3900. }
  3901. // A SecurityProfileSummary object that contains information about a security
  3902. // profile, including ARN, Id, Name.
  3903. type SecurityProfileSummary struct {
  3904. _ struct{} `type:"structure"`
  3905. // The ARN of the security profile.
  3906. Arn *string `type:"string"`
  3907. // The identifier of the security profile.
  3908. Id *string `type:"string"`
  3909. // The name of the security profile.
  3910. Name *string `type:"string"`
  3911. }
  3912. // String returns the string representation
  3913. func (s SecurityProfileSummary) String() string {
  3914. return awsutil.Prettify(s)
  3915. }
  3916. // GoString returns the string representation
  3917. func (s SecurityProfileSummary) GoString() string {
  3918. return s.String()
  3919. }
  3920. // SetArn sets the Arn field's value.
  3921. func (s *SecurityProfileSummary) SetArn(v string) *SecurityProfileSummary {
  3922. s.Arn = &v
  3923. return s
  3924. }
  3925. // SetId sets the Id field's value.
  3926. func (s *SecurityProfileSummary) SetId(v string) *SecurityProfileSummary {
  3927. s.Id = &v
  3928. return s
  3929. }
  3930. // SetName sets the Name field's value.
  3931. func (s *SecurityProfileSummary) SetName(v string) *SecurityProfileSummary {
  3932. s.Name = &v
  3933. return s
  3934. }
  3935. type StartOutboundVoiceContactInput struct {
  3936. _ struct{} `type:"structure"`
  3937. // Specify a custom key-value pair using an attribute map. The attributes are
  3938. // standard Amazon Connect attributes, and can be accessed in contact flows
  3939. // just like any other contact attributes.
  3940. //
  3941. // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact.
  3942. // Attribute keys can include only alphanumeric, dash, and underscore characters.
  3943. //
  3944. // For example, if you want play a greeting when the customer answers the call,
  3945. // you can pass the customer name in attributes similar to the following:
  3946. Attributes map[string]*string `type:"map"`
  3947. // A unique, case-sensitive identifier that you provide to ensure the idempotency
  3948. // of the request. The token is valid for 7 days after creation. If a contact
  3949. // is already started, the contact ID is returned. If the contact is disconnected,
  3950. // a new contact is started.
  3951. ClientToken *string `type:"string" idempotencyToken:"true"`
  3952. // The identifier for the contact flow to connect the outbound call to.
  3953. //
  3954. // To find the ContactFlowId, open the contact flow you want to use in the Amazon
  3955. // Connect contact flow editor. The ID for the contact flow is displayed in
  3956. // the address bar as part of the URL. For example, the contact flow ID is the
  3957. // set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.
  3958. //
  3959. // ContactFlowId is a required field
  3960. ContactFlowId *string `type:"string" required:"true"`
  3961. // The phone number of the customer in E.164 format.
  3962. //
  3963. // DestinationPhoneNumber is a required field
  3964. DestinationPhoneNumber *string `type:"string" required:"true"`
  3965. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  3966. // open the AWS console and select Amazon Connect. Select the alias of the instance
  3967. // in the Instance alias column. The instance ID is displayed in the Overview
  3968. // section of your instance settings. For example, the instance ID is the set
  3969. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  3970. //
  3971. // InstanceId is a required field
  3972. InstanceId *string `min:"1" type:"string" required:"true"`
  3973. // The queue to add the call to. If you specify a queue, the phone displayed
  3974. // for caller ID is the phone number specified in the queue. If you do not specify
  3975. // a queue, the queue used will be the queue defined in the contact flow.
  3976. //
  3977. // To find the QueueId, open the queue you want to use in the Amazon Connect
  3978. // Queue editor. The ID for the queue is displayed in the address bar as part
  3979. // of the URL. For example, the queue ID is the set of characters at the end
  3980. // of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.
  3981. QueueId *string `type:"string"`
  3982. // The phone number, in E.164 format, associated with your Amazon Connect instance
  3983. // to use for the outbound call.
  3984. SourcePhoneNumber *string `type:"string"`
  3985. }
  3986. // String returns the string representation
  3987. func (s StartOutboundVoiceContactInput) String() string {
  3988. return awsutil.Prettify(s)
  3989. }
  3990. // GoString returns the string representation
  3991. func (s StartOutboundVoiceContactInput) GoString() string {
  3992. return s.String()
  3993. }
  3994. // Validate inspects the fields of the type to determine if they are valid.
  3995. func (s *StartOutboundVoiceContactInput) Validate() error {
  3996. invalidParams := request.ErrInvalidParams{Context: "StartOutboundVoiceContactInput"}
  3997. if s.ContactFlowId == nil {
  3998. invalidParams.Add(request.NewErrParamRequired("ContactFlowId"))
  3999. }
  4000. if s.DestinationPhoneNumber == nil {
  4001. invalidParams.Add(request.NewErrParamRequired("DestinationPhoneNumber"))
  4002. }
  4003. if s.InstanceId == nil {
  4004. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  4005. }
  4006. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  4007. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  4008. }
  4009. if invalidParams.Len() > 0 {
  4010. return invalidParams
  4011. }
  4012. return nil
  4013. }
  4014. // SetAttributes sets the Attributes field's value.
  4015. func (s *StartOutboundVoiceContactInput) SetAttributes(v map[string]*string) *StartOutboundVoiceContactInput {
  4016. s.Attributes = v
  4017. return s
  4018. }
  4019. // SetClientToken sets the ClientToken field's value.
  4020. func (s *StartOutboundVoiceContactInput) SetClientToken(v string) *StartOutboundVoiceContactInput {
  4021. s.ClientToken = &v
  4022. return s
  4023. }
  4024. // SetContactFlowId sets the ContactFlowId field's value.
  4025. func (s *StartOutboundVoiceContactInput) SetContactFlowId(v string) *StartOutboundVoiceContactInput {
  4026. s.ContactFlowId = &v
  4027. return s
  4028. }
  4029. // SetDestinationPhoneNumber sets the DestinationPhoneNumber field's value.
  4030. func (s *StartOutboundVoiceContactInput) SetDestinationPhoneNumber(v string) *StartOutboundVoiceContactInput {
  4031. s.DestinationPhoneNumber = &v
  4032. return s
  4033. }
  4034. // SetInstanceId sets the InstanceId field's value.
  4035. func (s *StartOutboundVoiceContactInput) SetInstanceId(v string) *StartOutboundVoiceContactInput {
  4036. s.InstanceId = &v
  4037. return s
  4038. }
  4039. // SetQueueId sets the QueueId field's value.
  4040. func (s *StartOutboundVoiceContactInput) SetQueueId(v string) *StartOutboundVoiceContactInput {
  4041. s.QueueId = &v
  4042. return s
  4043. }
  4044. // SetSourcePhoneNumber sets the SourcePhoneNumber field's value.
  4045. func (s *StartOutboundVoiceContactInput) SetSourcePhoneNumber(v string) *StartOutboundVoiceContactInput {
  4046. s.SourcePhoneNumber = &v
  4047. return s
  4048. }
  4049. type StartOutboundVoiceContactOutput struct {
  4050. _ struct{} `type:"structure"`
  4051. // The unique identifier of this contact within your Amazon Connect instance.
  4052. ContactId *string `min:"1" type:"string"`
  4053. }
  4054. // String returns the string representation
  4055. func (s StartOutboundVoiceContactOutput) String() string {
  4056. return awsutil.Prettify(s)
  4057. }
  4058. // GoString returns the string representation
  4059. func (s StartOutboundVoiceContactOutput) GoString() string {
  4060. return s.String()
  4061. }
  4062. // SetContactId sets the ContactId field's value.
  4063. func (s *StartOutboundVoiceContactOutput) SetContactId(v string) *StartOutboundVoiceContactOutput {
  4064. s.ContactId = &v
  4065. return s
  4066. }
  4067. type StopContactInput struct {
  4068. _ struct{} `type:"structure"`
  4069. // The unique identifier of the contact to end.
  4070. //
  4071. // ContactId is a required field
  4072. ContactId *string `min:"1" type:"string" required:"true"`
  4073. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  4074. // open the AWS console and select Amazon Connect. Select the alias of the instance
  4075. // in the Instance alias column. The instance ID is displayed in the Overview
  4076. // section of your instance settings. For example, the instance ID is the set
  4077. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  4078. //
  4079. // InstanceId is a required field
  4080. InstanceId *string `min:"1" type:"string" required:"true"`
  4081. }
  4082. // String returns the string representation
  4083. func (s StopContactInput) String() string {
  4084. return awsutil.Prettify(s)
  4085. }
  4086. // GoString returns the string representation
  4087. func (s StopContactInput) GoString() string {
  4088. return s.String()
  4089. }
  4090. // Validate inspects the fields of the type to determine if they are valid.
  4091. func (s *StopContactInput) Validate() error {
  4092. invalidParams := request.ErrInvalidParams{Context: "StopContactInput"}
  4093. if s.ContactId == nil {
  4094. invalidParams.Add(request.NewErrParamRequired("ContactId"))
  4095. }
  4096. if s.ContactId != nil && len(*s.ContactId) < 1 {
  4097. invalidParams.Add(request.NewErrParamMinLen("ContactId", 1))
  4098. }
  4099. if s.InstanceId == nil {
  4100. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  4101. }
  4102. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  4103. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  4104. }
  4105. if invalidParams.Len() > 0 {
  4106. return invalidParams
  4107. }
  4108. return nil
  4109. }
  4110. // SetContactId sets the ContactId field's value.
  4111. func (s *StopContactInput) SetContactId(v string) *StopContactInput {
  4112. s.ContactId = &v
  4113. return s
  4114. }
  4115. // SetInstanceId sets the InstanceId field's value.
  4116. func (s *StopContactInput) SetInstanceId(v string) *StopContactInput {
  4117. s.InstanceId = &v
  4118. return s
  4119. }
  4120. type StopContactOutput struct {
  4121. _ struct{} `type:"structure"`
  4122. }
  4123. // String returns the string representation
  4124. func (s StopContactOutput) String() string {
  4125. return awsutil.Prettify(s)
  4126. }
  4127. // GoString returns the string representation
  4128. func (s StopContactOutput) GoString() string {
  4129. return s.String()
  4130. }
  4131. // A Threshold object that includes a comparison and ThresholdValue to compare
  4132. // to. Used with service level metrics.
  4133. type Threshold struct {
  4134. _ struct{} `type:"structure"`
  4135. // The Threshold to use to compare service level metrics to. Only "Less than"
  4136. // (LT) comparisons are supported.
  4137. Comparison *string `type:"string" enum:"Comparison"`
  4138. // The value of the threshold to compare the metric to. Only "Less than" (LT)
  4139. // comparisons are supported.
  4140. ThresholdValue *float64 `type:"double"`
  4141. }
  4142. // String returns the string representation
  4143. func (s Threshold) String() string {
  4144. return awsutil.Prettify(s)
  4145. }
  4146. // GoString returns the string representation
  4147. func (s Threshold) GoString() string {
  4148. return s.String()
  4149. }
  4150. // SetComparison sets the Comparison field's value.
  4151. func (s *Threshold) SetComparison(v string) *Threshold {
  4152. s.Comparison = &v
  4153. return s
  4154. }
  4155. // SetThresholdValue sets the ThresholdValue field's value.
  4156. func (s *Threshold) SetThresholdValue(v float64) *Threshold {
  4157. s.ThresholdValue = &v
  4158. return s
  4159. }
  4160. type UpdateContactAttributesInput struct {
  4161. _ struct{} `type:"structure"`
  4162. // Specify a custom key-value pair using an attribute map. The attributes are
  4163. // standard Amazon Connect attributes, and can be accessed in contact flows
  4164. // just like any other contact attributes.
  4165. //
  4166. // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact.
  4167. // Attribute keys can include only alphanumeric, dash, and underscore characters.
  4168. //
  4169. // Attributes is a required field
  4170. Attributes map[string]*string `type:"map" required:"true"`
  4171. // The unique identifier of the contact for which to update attributes. This
  4172. // is the identifier for the contact associated with the first interaction with
  4173. // the contact center.
  4174. //
  4175. // InitialContactId is a required field
  4176. InitialContactId *string `min:"1" type:"string" required:"true"`
  4177. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  4178. // open the AWS console and select Amazon Connect. Select the alias of the instance
  4179. // in the Instance alias column. The instance ID is displayed in the Overview
  4180. // section of your instance settings. For example, the instance ID is the set
  4181. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  4182. //
  4183. // InstanceId is a required field
  4184. InstanceId *string `min:"1" type:"string" required:"true"`
  4185. }
  4186. // String returns the string representation
  4187. func (s UpdateContactAttributesInput) String() string {
  4188. return awsutil.Prettify(s)
  4189. }
  4190. // GoString returns the string representation
  4191. func (s UpdateContactAttributesInput) GoString() string {
  4192. return s.String()
  4193. }
  4194. // Validate inspects the fields of the type to determine if they are valid.
  4195. func (s *UpdateContactAttributesInput) Validate() error {
  4196. invalidParams := request.ErrInvalidParams{Context: "UpdateContactAttributesInput"}
  4197. if s.Attributes == nil {
  4198. invalidParams.Add(request.NewErrParamRequired("Attributes"))
  4199. }
  4200. if s.InitialContactId == nil {
  4201. invalidParams.Add(request.NewErrParamRequired("InitialContactId"))
  4202. }
  4203. if s.InitialContactId != nil && len(*s.InitialContactId) < 1 {
  4204. invalidParams.Add(request.NewErrParamMinLen("InitialContactId", 1))
  4205. }
  4206. if s.InstanceId == nil {
  4207. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  4208. }
  4209. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  4210. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  4211. }
  4212. if invalidParams.Len() > 0 {
  4213. return invalidParams
  4214. }
  4215. return nil
  4216. }
  4217. // SetAttributes sets the Attributes field's value.
  4218. func (s *UpdateContactAttributesInput) SetAttributes(v map[string]*string) *UpdateContactAttributesInput {
  4219. s.Attributes = v
  4220. return s
  4221. }
  4222. // SetInitialContactId sets the InitialContactId field's value.
  4223. func (s *UpdateContactAttributesInput) SetInitialContactId(v string) *UpdateContactAttributesInput {
  4224. s.InitialContactId = &v
  4225. return s
  4226. }
  4227. // SetInstanceId sets the InstanceId field's value.
  4228. func (s *UpdateContactAttributesInput) SetInstanceId(v string) *UpdateContactAttributesInput {
  4229. s.InstanceId = &v
  4230. return s
  4231. }
  4232. type UpdateContactAttributesOutput struct {
  4233. _ struct{} `type:"structure"`
  4234. }
  4235. // String returns the string representation
  4236. func (s UpdateContactAttributesOutput) String() string {
  4237. return awsutil.Prettify(s)
  4238. }
  4239. // GoString returns the string representation
  4240. func (s UpdateContactAttributesOutput) GoString() string {
  4241. return s.String()
  4242. }
  4243. type UpdateUserHierarchyInput struct {
  4244. _ struct{} `type:"structure"`
  4245. // The identifier for the hierarchy group to assign to the user.
  4246. HierarchyGroupId *string `type:"string"`
  4247. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  4248. // open the AWS console and select Amazon Connect. Select the alias of the instance
  4249. // in the Instance alias column. The instance ID is displayed in the Overview
  4250. // section of your instance settings. For example, the instance ID is the set
  4251. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  4252. //
  4253. // InstanceId is a required field
  4254. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  4255. // The identifier of the user account to assign the hierarchy group to.
  4256. //
  4257. // UserId is a required field
  4258. UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
  4259. }
  4260. // String returns the string representation
  4261. func (s UpdateUserHierarchyInput) String() string {
  4262. return awsutil.Prettify(s)
  4263. }
  4264. // GoString returns the string representation
  4265. func (s UpdateUserHierarchyInput) GoString() string {
  4266. return s.String()
  4267. }
  4268. // Validate inspects the fields of the type to determine if they are valid.
  4269. func (s *UpdateUserHierarchyInput) Validate() error {
  4270. invalidParams := request.ErrInvalidParams{Context: "UpdateUserHierarchyInput"}
  4271. if s.InstanceId == nil {
  4272. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  4273. }
  4274. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  4275. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  4276. }
  4277. if s.UserId == nil {
  4278. invalidParams.Add(request.NewErrParamRequired("UserId"))
  4279. }
  4280. if s.UserId != nil && len(*s.UserId) < 1 {
  4281. invalidParams.Add(request.NewErrParamMinLen("UserId", 1))
  4282. }
  4283. if invalidParams.Len() > 0 {
  4284. return invalidParams
  4285. }
  4286. return nil
  4287. }
  4288. // SetHierarchyGroupId sets the HierarchyGroupId field's value.
  4289. func (s *UpdateUserHierarchyInput) SetHierarchyGroupId(v string) *UpdateUserHierarchyInput {
  4290. s.HierarchyGroupId = &v
  4291. return s
  4292. }
  4293. // SetInstanceId sets the InstanceId field's value.
  4294. func (s *UpdateUserHierarchyInput) SetInstanceId(v string) *UpdateUserHierarchyInput {
  4295. s.InstanceId = &v
  4296. return s
  4297. }
  4298. // SetUserId sets the UserId field's value.
  4299. func (s *UpdateUserHierarchyInput) SetUserId(v string) *UpdateUserHierarchyInput {
  4300. s.UserId = &v
  4301. return s
  4302. }
  4303. type UpdateUserHierarchyOutput struct {
  4304. _ struct{} `type:"structure"`
  4305. }
  4306. // String returns the string representation
  4307. func (s UpdateUserHierarchyOutput) String() string {
  4308. return awsutil.Prettify(s)
  4309. }
  4310. // GoString returns the string representation
  4311. func (s UpdateUserHierarchyOutput) GoString() string {
  4312. return s.String()
  4313. }
  4314. type UpdateUserIdentityInfoInput struct {
  4315. _ struct{} `type:"structure"`
  4316. // A UserIdentityInfo object.
  4317. //
  4318. // IdentityInfo is a required field
  4319. IdentityInfo *UserIdentityInfo `type:"structure" required:"true"`
  4320. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  4321. // open the AWS console and select Amazon Connect. Select the alias of the instance
  4322. // in the Instance alias column. The instance ID is displayed in the Overview
  4323. // section of your instance settings. For example, the instance ID is the set
  4324. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  4325. //
  4326. // InstanceId is a required field
  4327. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  4328. // The identifier for the user account to update identity information for.
  4329. //
  4330. // UserId is a required field
  4331. UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
  4332. }
  4333. // String returns the string representation
  4334. func (s UpdateUserIdentityInfoInput) String() string {
  4335. return awsutil.Prettify(s)
  4336. }
  4337. // GoString returns the string representation
  4338. func (s UpdateUserIdentityInfoInput) GoString() string {
  4339. return s.String()
  4340. }
  4341. // Validate inspects the fields of the type to determine if they are valid.
  4342. func (s *UpdateUserIdentityInfoInput) Validate() error {
  4343. invalidParams := request.ErrInvalidParams{Context: "UpdateUserIdentityInfoInput"}
  4344. if s.IdentityInfo == nil {
  4345. invalidParams.Add(request.NewErrParamRequired("IdentityInfo"))
  4346. }
  4347. if s.InstanceId == nil {
  4348. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  4349. }
  4350. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  4351. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  4352. }
  4353. if s.UserId == nil {
  4354. invalidParams.Add(request.NewErrParamRequired("UserId"))
  4355. }
  4356. if s.UserId != nil && len(*s.UserId) < 1 {
  4357. invalidParams.Add(request.NewErrParamMinLen("UserId", 1))
  4358. }
  4359. if s.IdentityInfo != nil {
  4360. if err := s.IdentityInfo.Validate(); err != nil {
  4361. invalidParams.AddNested("IdentityInfo", err.(request.ErrInvalidParams))
  4362. }
  4363. }
  4364. if invalidParams.Len() > 0 {
  4365. return invalidParams
  4366. }
  4367. return nil
  4368. }
  4369. // SetIdentityInfo sets the IdentityInfo field's value.
  4370. func (s *UpdateUserIdentityInfoInput) SetIdentityInfo(v *UserIdentityInfo) *UpdateUserIdentityInfoInput {
  4371. s.IdentityInfo = v
  4372. return s
  4373. }
  4374. // SetInstanceId sets the InstanceId field's value.
  4375. func (s *UpdateUserIdentityInfoInput) SetInstanceId(v string) *UpdateUserIdentityInfoInput {
  4376. s.InstanceId = &v
  4377. return s
  4378. }
  4379. // SetUserId sets the UserId field's value.
  4380. func (s *UpdateUserIdentityInfoInput) SetUserId(v string) *UpdateUserIdentityInfoInput {
  4381. s.UserId = &v
  4382. return s
  4383. }
  4384. type UpdateUserIdentityInfoOutput struct {
  4385. _ struct{} `type:"structure"`
  4386. }
  4387. // String returns the string representation
  4388. func (s UpdateUserIdentityInfoOutput) String() string {
  4389. return awsutil.Prettify(s)
  4390. }
  4391. // GoString returns the string representation
  4392. func (s UpdateUserIdentityInfoOutput) GoString() string {
  4393. return s.String()
  4394. }
  4395. type UpdateUserPhoneConfigInput struct {
  4396. _ struct{} `type:"structure"`
  4397. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  4398. // open the AWS console and select Amazon Connect. Select the alias of the instance
  4399. // in the Instance alias column. The instance ID is displayed in the Overview
  4400. // section of your instance settings. For example, the instance ID is the set
  4401. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  4402. //
  4403. // InstanceId is a required field
  4404. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  4405. // A UserPhoneConfig object that contains settings for AfterContactWorkTimeLimit,
  4406. // AutoAccept, DeskPhoneNumber, and PhoneType to assign to the user.
  4407. //
  4408. // PhoneConfig is a required field
  4409. PhoneConfig *UserPhoneConfig `type:"structure" required:"true"`
  4410. // The identifier for the user account to change phone settings for.
  4411. //
  4412. // UserId is a required field
  4413. UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
  4414. }
  4415. // String returns the string representation
  4416. func (s UpdateUserPhoneConfigInput) String() string {
  4417. return awsutil.Prettify(s)
  4418. }
  4419. // GoString returns the string representation
  4420. func (s UpdateUserPhoneConfigInput) GoString() string {
  4421. return s.String()
  4422. }
  4423. // Validate inspects the fields of the type to determine if they are valid.
  4424. func (s *UpdateUserPhoneConfigInput) Validate() error {
  4425. invalidParams := request.ErrInvalidParams{Context: "UpdateUserPhoneConfigInput"}
  4426. if s.InstanceId == nil {
  4427. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  4428. }
  4429. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  4430. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  4431. }
  4432. if s.PhoneConfig == nil {
  4433. invalidParams.Add(request.NewErrParamRequired("PhoneConfig"))
  4434. }
  4435. if s.UserId == nil {
  4436. invalidParams.Add(request.NewErrParamRequired("UserId"))
  4437. }
  4438. if s.UserId != nil && len(*s.UserId) < 1 {
  4439. invalidParams.Add(request.NewErrParamMinLen("UserId", 1))
  4440. }
  4441. if s.PhoneConfig != nil {
  4442. if err := s.PhoneConfig.Validate(); err != nil {
  4443. invalidParams.AddNested("PhoneConfig", err.(request.ErrInvalidParams))
  4444. }
  4445. }
  4446. if invalidParams.Len() > 0 {
  4447. return invalidParams
  4448. }
  4449. return nil
  4450. }
  4451. // SetInstanceId sets the InstanceId field's value.
  4452. func (s *UpdateUserPhoneConfigInput) SetInstanceId(v string) *UpdateUserPhoneConfigInput {
  4453. s.InstanceId = &v
  4454. return s
  4455. }
  4456. // SetPhoneConfig sets the PhoneConfig field's value.
  4457. func (s *UpdateUserPhoneConfigInput) SetPhoneConfig(v *UserPhoneConfig) *UpdateUserPhoneConfigInput {
  4458. s.PhoneConfig = v
  4459. return s
  4460. }
  4461. // SetUserId sets the UserId field's value.
  4462. func (s *UpdateUserPhoneConfigInput) SetUserId(v string) *UpdateUserPhoneConfigInput {
  4463. s.UserId = &v
  4464. return s
  4465. }
  4466. type UpdateUserPhoneConfigOutput struct {
  4467. _ struct{} `type:"structure"`
  4468. }
  4469. // String returns the string representation
  4470. func (s UpdateUserPhoneConfigOutput) String() string {
  4471. return awsutil.Prettify(s)
  4472. }
  4473. // GoString returns the string representation
  4474. func (s UpdateUserPhoneConfigOutput) GoString() string {
  4475. return s.String()
  4476. }
  4477. type UpdateUserRoutingProfileInput struct {
  4478. _ struct{} `type:"structure"`
  4479. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  4480. // open the AWS console and select Amazon Connect. Select the alias of the instance
  4481. // in the Instance alias column. The instance ID is displayed in the Overview
  4482. // section of your instance settings. For example, the instance ID is the set
  4483. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  4484. //
  4485. // InstanceId is a required field
  4486. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  4487. // The identifier of the routing profile to assign to the user.
  4488. //
  4489. // RoutingProfileId is a required field
  4490. RoutingProfileId *string `type:"string" required:"true"`
  4491. // The identifier for the user account to assign the routing profile to.
  4492. //
  4493. // UserId is a required field
  4494. UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
  4495. }
  4496. // String returns the string representation
  4497. func (s UpdateUserRoutingProfileInput) String() string {
  4498. return awsutil.Prettify(s)
  4499. }
  4500. // GoString returns the string representation
  4501. func (s UpdateUserRoutingProfileInput) GoString() string {
  4502. return s.String()
  4503. }
  4504. // Validate inspects the fields of the type to determine if they are valid.
  4505. func (s *UpdateUserRoutingProfileInput) Validate() error {
  4506. invalidParams := request.ErrInvalidParams{Context: "UpdateUserRoutingProfileInput"}
  4507. if s.InstanceId == nil {
  4508. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  4509. }
  4510. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  4511. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  4512. }
  4513. if s.RoutingProfileId == nil {
  4514. invalidParams.Add(request.NewErrParamRequired("RoutingProfileId"))
  4515. }
  4516. if s.UserId == nil {
  4517. invalidParams.Add(request.NewErrParamRequired("UserId"))
  4518. }
  4519. if s.UserId != nil && len(*s.UserId) < 1 {
  4520. invalidParams.Add(request.NewErrParamMinLen("UserId", 1))
  4521. }
  4522. if invalidParams.Len() > 0 {
  4523. return invalidParams
  4524. }
  4525. return nil
  4526. }
  4527. // SetInstanceId sets the InstanceId field's value.
  4528. func (s *UpdateUserRoutingProfileInput) SetInstanceId(v string) *UpdateUserRoutingProfileInput {
  4529. s.InstanceId = &v
  4530. return s
  4531. }
  4532. // SetRoutingProfileId sets the RoutingProfileId field's value.
  4533. func (s *UpdateUserRoutingProfileInput) SetRoutingProfileId(v string) *UpdateUserRoutingProfileInput {
  4534. s.RoutingProfileId = &v
  4535. return s
  4536. }
  4537. // SetUserId sets the UserId field's value.
  4538. func (s *UpdateUserRoutingProfileInput) SetUserId(v string) *UpdateUserRoutingProfileInput {
  4539. s.UserId = &v
  4540. return s
  4541. }
  4542. type UpdateUserRoutingProfileOutput struct {
  4543. _ struct{} `type:"structure"`
  4544. }
  4545. // String returns the string representation
  4546. func (s UpdateUserRoutingProfileOutput) String() string {
  4547. return awsutil.Prettify(s)
  4548. }
  4549. // GoString returns the string representation
  4550. func (s UpdateUserRoutingProfileOutput) GoString() string {
  4551. return s.String()
  4552. }
  4553. type UpdateUserSecurityProfilesInput struct {
  4554. _ struct{} `type:"structure"`
  4555. // The identifier for your Amazon Connect instance. To find the ID of your instance,
  4556. // open the AWS console and select Amazon Connect. Select the alias of the instance
  4557. // in the Instance alias column. The instance ID is displayed in the Overview
  4558. // section of your instance settings. For example, the instance ID is the set
  4559. // of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  4560. //
  4561. // InstanceId is a required field
  4562. InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"`
  4563. // The identifiers for the security profiles to assign to the user.
  4564. //
  4565. // SecurityProfileIds is a required field
  4566. SecurityProfileIds []*string `min:"1" type:"list" required:"true"`
  4567. // The identifier of the user account to assign the security profiles.
  4568. //
  4569. // UserId is a required field
  4570. UserId *string `location:"uri" locationName:"UserId" type:"string" required:"true"`
  4571. }
  4572. // String returns the string representation
  4573. func (s UpdateUserSecurityProfilesInput) String() string {
  4574. return awsutil.Prettify(s)
  4575. }
  4576. // GoString returns the string representation
  4577. func (s UpdateUserSecurityProfilesInput) GoString() string {
  4578. return s.String()
  4579. }
  4580. // Validate inspects the fields of the type to determine if they are valid.
  4581. func (s *UpdateUserSecurityProfilesInput) Validate() error {
  4582. invalidParams := request.ErrInvalidParams{Context: "UpdateUserSecurityProfilesInput"}
  4583. if s.InstanceId == nil {
  4584. invalidParams.Add(request.NewErrParamRequired("InstanceId"))
  4585. }
  4586. if s.InstanceId != nil && len(*s.InstanceId) < 1 {
  4587. invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1))
  4588. }
  4589. if s.SecurityProfileIds == nil {
  4590. invalidParams.Add(request.NewErrParamRequired("SecurityProfileIds"))
  4591. }
  4592. if s.SecurityProfileIds != nil && len(s.SecurityProfileIds) < 1 {
  4593. invalidParams.Add(request.NewErrParamMinLen("SecurityProfileIds", 1))
  4594. }
  4595. if s.UserId == nil {
  4596. invalidParams.Add(request.NewErrParamRequired("UserId"))
  4597. }
  4598. if s.UserId != nil && len(*s.UserId) < 1 {
  4599. invalidParams.Add(request.NewErrParamMinLen("UserId", 1))
  4600. }
  4601. if invalidParams.Len() > 0 {
  4602. return invalidParams
  4603. }
  4604. return nil
  4605. }
  4606. // SetInstanceId sets the InstanceId field's value.
  4607. func (s *UpdateUserSecurityProfilesInput) SetInstanceId(v string) *UpdateUserSecurityProfilesInput {
  4608. s.InstanceId = &v
  4609. return s
  4610. }
  4611. // SetSecurityProfileIds sets the SecurityProfileIds field's value.
  4612. func (s *UpdateUserSecurityProfilesInput) SetSecurityProfileIds(v []*string) *UpdateUserSecurityProfilesInput {
  4613. s.SecurityProfileIds = v
  4614. return s
  4615. }
  4616. // SetUserId sets the UserId field's value.
  4617. func (s *UpdateUserSecurityProfilesInput) SetUserId(v string) *UpdateUserSecurityProfilesInput {
  4618. s.UserId = &v
  4619. return s
  4620. }
  4621. type UpdateUserSecurityProfilesOutput struct {
  4622. _ struct{} `type:"structure"`
  4623. }
  4624. // String returns the string representation
  4625. func (s UpdateUserSecurityProfilesOutput) String() string {
  4626. return awsutil.Prettify(s)
  4627. }
  4628. // GoString returns the string representation
  4629. func (s UpdateUserSecurityProfilesOutput) GoString() string {
  4630. return s.String()
  4631. }
  4632. // A User object that contains information about a user account in your Amazon
  4633. // Connect instance, including configuration settings.
  4634. type User struct {
  4635. _ struct{} `type:"structure"`
  4636. // The ARN of the user account.
  4637. Arn *string `type:"string"`
  4638. // The directory Id for the user account in the existing directory used for
  4639. // identity management.
  4640. DirectoryUserId *string `type:"string"`
  4641. // The identifier for the hierarchy group assigned to the user.
  4642. HierarchyGroupId *string `type:"string"`
  4643. // The identifier of the user account.
  4644. Id *string `type:"string"`
  4645. // A UserIdentityInfo object.
  4646. IdentityInfo *UserIdentityInfo `type:"structure"`
  4647. // A UserPhoneConfig object.
  4648. PhoneConfig *UserPhoneConfig `type:"structure"`
  4649. // The identifier of the routing profile assigned to the user.
  4650. RoutingProfileId *string `type:"string"`
  4651. // The identifier(s) for the security profile assigned to the user.
  4652. SecurityProfileIds []*string `min:"1" type:"list"`
  4653. // The user name assigned to the user account.
  4654. Username *string `min:"1" type:"string"`
  4655. }
  4656. // String returns the string representation
  4657. func (s User) String() string {
  4658. return awsutil.Prettify(s)
  4659. }
  4660. // GoString returns the string representation
  4661. func (s User) GoString() string {
  4662. return s.String()
  4663. }
  4664. // SetArn sets the Arn field's value.
  4665. func (s *User) SetArn(v string) *User {
  4666. s.Arn = &v
  4667. return s
  4668. }
  4669. // SetDirectoryUserId sets the DirectoryUserId field's value.
  4670. func (s *User) SetDirectoryUserId(v string) *User {
  4671. s.DirectoryUserId = &v
  4672. return s
  4673. }
  4674. // SetHierarchyGroupId sets the HierarchyGroupId field's value.
  4675. func (s *User) SetHierarchyGroupId(v string) *User {
  4676. s.HierarchyGroupId = &v
  4677. return s
  4678. }
  4679. // SetId sets the Id field's value.
  4680. func (s *User) SetId(v string) *User {
  4681. s.Id = &v
  4682. return s
  4683. }
  4684. // SetIdentityInfo sets the IdentityInfo field's value.
  4685. func (s *User) SetIdentityInfo(v *UserIdentityInfo) *User {
  4686. s.IdentityInfo = v
  4687. return s
  4688. }
  4689. // SetPhoneConfig sets the PhoneConfig field's value.
  4690. func (s *User) SetPhoneConfig(v *UserPhoneConfig) *User {
  4691. s.PhoneConfig = v
  4692. return s
  4693. }
  4694. // SetRoutingProfileId sets the RoutingProfileId field's value.
  4695. func (s *User) SetRoutingProfileId(v string) *User {
  4696. s.RoutingProfileId = &v
  4697. return s
  4698. }
  4699. // SetSecurityProfileIds sets the SecurityProfileIds field's value.
  4700. func (s *User) SetSecurityProfileIds(v []*string) *User {
  4701. s.SecurityProfileIds = v
  4702. return s
  4703. }
  4704. // SetUsername sets the Username field's value.
  4705. func (s *User) SetUsername(v string) *User {
  4706. s.Username = &v
  4707. return s
  4708. }
  4709. // A UserIdentityInfo object that contains information about the user's identity,
  4710. // including email address, first name, and last name.
  4711. type UserIdentityInfo struct {
  4712. _ struct{} `type:"structure"`
  4713. // The email address added to the user account. If you are using SAML for identity
  4714. // management and include this parameter, an InvalidRequestException is returned.
  4715. Email *string `type:"string"`
  4716. // The first name used in the user account. This is required if you are using
  4717. // Amazon Connect or SAML for identity management.
  4718. FirstName *string `min:"1" type:"string"`
  4719. // The last name used in the user account. This is required if you are using
  4720. // Amazon Connect or SAML for identity management.
  4721. LastName *string `min:"1" type:"string"`
  4722. }
  4723. // String returns the string representation
  4724. func (s UserIdentityInfo) String() string {
  4725. return awsutil.Prettify(s)
  4726. }
  4727. // GoString returns the string representation
  4728. func (s UserIdentityInfo) GoString() string {
  4729. return s.String()
  4730. }
  4731. // Validate inspects the fields of the type to determine if they are valid.
  4732. func (s *UserIdentityInfo) Validate() error {
  4733. invalidParams := request.ErrInvalidParams{Context: "UserIdentityInfo"}
  4734. if s.FirstName != nil && len(*s.FirstName) < 1 {
  4735. invalidParams.Add(request.NewErrParamMinLen("FirstName", 1))
  4736. }
  4737. if s.LastName != nil && len(*s.LastName) < 1 {
  4738. invalidParams.Add(request.NewErrParamMinLen("LastName", 1))
  4739. }
  4740. if invalidParams.Len() > 0 {
  4741. return invalidParams
  4742. }
  4743. return nil
  4744. }
  4745. // SetEmail sets the Email field's value.
  4746. func (s *UserIdentityInfo) SetEmail(v string) *UserIdentityInfo {
  4747. s.Email = &v
  4748. return s
  4749. }
  4750. // SetFirstName sets the FirstName field's value.
  4751. func (s *UserIdentityInfo) SetFirstName(v string) *UserIdentityInfo {
  4752. s.FirstName = &v
  4753. return s
  4754. }
  4755. // SetLastName sets the LastName field's value.
  4756. func (s *UserIdentityInfo) SetLastName(v string) *UserIdentityInfo {
  4757. s.LastName = &v
  4758. return s
  4759. }
  4760. // A UserPhoneConfig object that contains information about the user phone configuration
  4761. // settings.
  4762. type UserPhoneConfig struct {
  4763. _ struct{} `type:"structure"`
  4764. // The After Call Work (ACW) timeout setting, in seconds, for the user.
  4765. AfterContactWorkTimeLimit *int64 `type:"integer"`
  4766. // The Auto accept setting for the user, Yes or No.
  4767. AutoAccept *bool `type:"boolean"`
  4768. // The phone number for the user's desk phone.
  4769. DeskPhoneNumber *string `type:"string"`
  4770. // The phone type selected for the user, either Soft phone or Desk phone.
  4771. //
  4772. // PhoneType is a required field
  4773. PhoneType *string `type:"string" required:"true" enum:"PhoneType"`
  4774. }
  4775. // String returns the string representation
  4776. func (s UserPhoneConfig) String() string {
  4777. return awsutil.Prettify(s)
  4778. }
  4779. // GoString returns the string representation
  4780. func (s UserPhoneConfig) GoString() string {
  4781. return s.String()
  4782. }
  4783. // Validate inspects the fields of the type to determine if they are valid.
  4784. func (s *UserPhoneConfig) Validate() error {
  4785. invalidParams := request.ErrInvalidParams{Context: "UserPhoneConfig"}
  4786. if s.PhoneType == nil {
  4787. invalidParams.Add(request.NewErrParamRequired("PhoneType"))
  4788. }
  4789. if invalidParams.Len() > 0 {
  4790. return invalidParams
  4791. }
  4792. return nil
  4793. }
  4794. // SetAfterContactWorkTimeLimit sets the AfterContactWorkTimeLimit field's value.
  4795. func (s *UserPhoneConfig) SetAfterContactWorkTimeLimit(v int64) *UserPhoneConfig {
  4796. s.AfterContactWorkTimeLimit = &v
  4797. return s
  4798. }
  4799. // SetAutoAccept sets the AutoAccept field's value.
  4800. func (s *UserPhoneConfig) SetAutoAccept(v bool) *UserPhoneConfig {
  4801. s.AutoAccept = &v
  4802. return s
  4803. }
  4804. // SetDeskPhoneNumber sets the DeskPhoneNumber field's value.
  4805. func (s *UserPhoneConfig) SetDeskPhoneNumber(v string) *UserPhoneConfig {
  4806. s.DeskPhoneNumber = &v
  4807. return s
  4808. }
  4809. // SetPhoneType sets the PhoneType field's value.
  4810. func (s *UserPhoneConfig) SetPhoneType(v string) *UserPhoneConfig {
  4811. s.PhoneType = &v
  4812. return s
  4813. }
  4814. // A UserSummary object that contains Information about a user, including ARN,
  4815. // Id, and user name.
  4816. type UserSummary struct {
  4817. _ struct{} `type:"structure"`
  4818. // The ARN for the user account.
  4819. Arn *string `type:"string"`
  4820. // The identifier for the user account.
  4821. Id *string `type:"string"`
  4822. // The Amazon Connect user name for the user account.
  4823. Username *string `min:"1" type:"string"`
  4824. }
  4825. // String returns the string representation
  4826. func (s UserSummary) String() string {
  4827. return awsutil.Prettify(s)
  4828. }
  4829. // GoString returns the string representation
  4830. func (s UserSummary) GoString() string {
  4831. return s.String()
  4832. }
  4833. // SetArn sets the Arn field's value.
  4834. func (s *UserSummary) SetArn(v string) *UserSummary {
  4835. s.Arn = &v
  4836. return s
  4837. }
  4838. // SetId sets the Id field's value.
  4839. func (s *UserSummary) SetId(v string) *UserSummary {
  4840. s.Id = &v
  4841. return s
  4842. }
  4843. // SetUsername sets the Username field's value.
  4844. func (s *UserSummary) SetUsername(v string) *UserSummary {
  4845. s.Username = &v
  4846. return s
  4847. }
  4848. const (
  4849. // ChannelVoice is a Channel enum value
  4850. ChannelVoice = "VOICE"
  4851. )
  4852. const (
  4853. // ComparisonLt is a Comparison enum value
  4854. ComparisonLt = "LT"
  4855. )
  4856. // A list of current metric names.
  4857. const (
  4858. // CurrentMetricNameAgentsOnline is a CurrentMetricName enum value
  4859. CurrentMetricNameAgentsOnline = "AGENTS_ONLINE"
  4860. // CurrentMetricNameAgentsAvailable is a CurrentMetricName enum value
  4861. CurrentMetricNameAgentsAvailable = "AGENTS_AVAILABLE"
  4862. // CurrentMetricNameAgentsOnCall is a CurrentMetricName enum value
  4863. CurrentMetricNameAgentsOnCall = "AGENTS_ON_CALL"
  4864. // CurrentMetricNameAgentsNonProductive is a CurrentMetricName enum value
  4865. CurrentMetricNameAgentsNonProductive = "AGENTS_NON_PRODUCTIVE"
  4866. // CurrentMetricNameAgentsAfterContactWork is a CurrentMetricName enum value
  4867. CurrentMetricNameAgentsAfterContactWork = "AGENTS_AFTER_CONTACT_WORK"
  4868. // CurrentMetricNameAgentsError is a CurrentMetricName enum value
  4869. CurrentMetricNameAgentsError = "AGENTS_ERROR"
  4870. // CurrentMetricNameAgentsStaffed is a CurrentMetricName enum value
  4871. CurrentMetricNameAgentsStaffed = "AGENTS_STAFFED"
  4872. // CurrentMetricNameContactsInQueue is a CurrentMetricName enum value
  4873. CurrentMetricNameContactsInQueue = "CONTACTS_IN_QUEUE"
  4874. // CurrentMetricNameOldestContactAge is a CurrentMetricName enum value
  4875. CurrentMetricNameOldestContactAge = "OLDEST_CONTACT_AGE"
  4876. // CurrentMetricNameContactsScheduled is a CurrentMetricName enum value
  4877. CurrentMetricNameContactsScheduled = "CONTACTS_SCHEDULED"
  4878. )
  4879. const (
  4880. // GroupingQueue is a Grouping enum value
  4881. GroupingQueue = "QUEUE"
  4882. // GroupingChannel is a Grouping enum value
  4883. GroupingChannel = "CHANNEL"
  4884. )
  4885. // A list of historical metric names.
  4886. const (
  4887. // HistoricalMetricNameContactsQueued is a HistoricalMetricName enum value
  4888. HistoricalMetricNameContactsQueued = "CONTACTS_QUEUED"
  4889. // HistoricalMetricNameContactsHandled is a HistoricalMetricName enum value
  4890. HistoricalMetricNameContactsHandled = "CONTACTS_HANDLED"
  4891. // HistoricalMetricNameContactsAbandoned is a HistoricalMetricName enum value
  4892. HistoricalMetricNameContactsAbandoned = "CONTACTS_ABANDONED"
  4893. // HistoricalMetricNameContactsConsulted is a HistoricalMetricName enum value
  4894. HistoricalMetricNameContactsConsulted = "CONTACTS_CONSULTED"
  4895. // HistoricalMetricNameContactsAgentHungUpFirst is a HistoricalMetricName enum value
  4896. HistoricalMetricNameContactsAgentHungUpFirst = "CONTACTS_AGENT_HUNG_UP_FIRST"
  4897. // HistoricalMetricNameContactsHandledIncoming is a HistoricalMetricName enum value
  4898. HistoricalMetricNameContactsHandledIncoming = "CONTACTS_HANDLED_INCOMING"
  4899. // HistoricalMetricNameContactsHandledOutbound is a HistoricalMetricName enum value
  4900. HistoricalMetricNameContactsHandledOutbound = "CONTACTS_HANDLED_OUTBOUND"
  4901. // HistoricalMetricNameContactsHoldAbandons is a HistoricalMetricName enum value
  4902. HistoricalMetricNameContactsHoldAbandons = "CONTACTS_HOLD_ABANDONS"
  4903. // HistoricalMetricNameContactsTransferredIn is a HistoricalMetricName enum value
  4904. HistoricalMetricNameContactsTransferredIn = "CONTACTS_TRANSFERRED_IN"
  4905. // HistoricalMetricNameContactsTransferredOut is a HistoricalMetricName enum value
  4906. HistoricalMetricNameContactsTransferredOut = "CONTACTS_TRANSFERRED_OUT"
  4907. // HistoricalMetricNameContactsTransferredInFromQueue is a HistoricalMetricName enum value
  4908. HistoricalMetricNameContactsTransferredInFromQueue = "CONTACTS_TRANSFERRED_IN_FROM_QUEUE"
  4909. // HistoricalMetricNameContactsTransferredOutFromQueue is a HistoricalMetricName enum value
  4910. HistoricalMetricNameContactsTransferredOutFromQueue = "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE"
  4911. // HistoricalMetricNameContactsMissed is a HistoricalMetricName enum value
  4912. HistoricalMetricNameContactsMissed = "CONTACTS_MISSED"
  4913. // HistoricalMetricNameCallbackContactsHandled is a HistoricalMetricName enum value
  4914. HistoricalMetricNameCallbackContactsHandled = "CALLBACK_CONTACTS_HANDLED"
  4915. // HistoricalMetricNameApiContactsHandled is a HistoricalMetricName enum value
  4916. HistoricalMetricNameApiContactsHandled = "API_CONTACTS_HANDLED"
  4917. // HistoricalMetricNameOccupancy is a HistoricalMetricName enum value
  4918. HistoricalMetricNameOccupancy = "OCCUPANCY"
  4919. // HistoricalMetricNameHandleTime is a HistoricalMetricName enum value
  4920. HistoricalMetricNameHandleTime = "HANDLE_TIME"
  4921. // HistoricalMetricNameAfterContactWorkTime is a HistoricalMetricName enum value
  4922. HistoricalMetricNameAfterContactWorkTime = "AFTER_CONTACT_WORK_TIME"
  4923. // HistoricalMetricNameQueuedTime is a HistoricalMetricName enum value
  4924. HistoricalMetricNameQueuedTime = "QUEUED_TIME"
  4925. // HistoricalMetricNameAbandonTime is a HistoricalMetricName enum value
  4926. HistoricalMetricNameAbandonTime = "ABANDON_TIME"
  4927. // HistoricalMetricNameQueueAnswerTime is a HistoricalMetricName enum value
  4928. HistoricalMetricNameQueueAnswerTime = "QUEUE_ANSWER_TIME"
  4929. // HistoricalMetricNameHoldTime is a HistoricalMetricName enum value
  4930. HistoricalMetricNameHoldTime = "HOLD_TIME"
  4931. // HistoricalMetricNameInteractionTime is a HistoricalMetricName enum value
  4932. HistoricalMetricNameInteractionTime = "INTERACTION_TIME"
  4933. // HistoricalMetricNameInteractionAndHoldTime is a HistoricalMetricName enum value
  4934. HistoricalMetricNameInteractionAndHoldTime = "INTERACTION_AND_HOLD_TIME"
  4935. // HistoricalMetricNameServiceLevel is a HistoricalMetricName enum value
  4936. HistoricalMetricNameServiceLevel = "SERVICE_LEVEL"
  4937. )
  4938. const (
  4939. // PhoneTypeSoftPhone is a PhoneType enum value
  4940. PhoneTypeSoftPhone = "SOFT_PHONE"
  4941. // PhoneTypeDeskPhone is a PhoneType enum value
  4942. PhoneTypeDeskPhone = "DESK_PHONE"
  4943. )
  4944. const (
  4945. // StatisticSum is a Statistic enum value
  4946. StatisticSum = "SUM"
  4947. // StatisticMax is a Statistic enum value
  4948. StatisticMax = "MAX"
  4949. // StatisticAvg is a Statistic enum value
  4950. StatisticAvg = "AVG"
  4951. )
  4952. const (
  4953. // UnitSeconds is a Unit enum value
  4954. UnitSeconds = "SECONDS"
  4955. // UnitCount is a Unit enum value
  4956. UnitCount = "COUNT"
  4957. // UnitPercent is a Unit enum value
  4958. UnitPercent = "PERCENT"
  4959. )