12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637 |
- import {Request} from '../lib/request';
- import {Response} from '../lib/response';
- import {AWSError} from '../lib/error';
- import {Service} from '../lib/service';
- import {ServiceConfigurationOptions} from '../lib/service';
- import {ConfigBase as Config} from '../lib/config-base';
- interface Blob {}
- declare class PinpointSMSVoiceV2 extends Service {
- /**
- * Constructs a service object. This object has one method for each API operation.
- */
- constructor(options?: PinpointSMSVoiceV2.Types.ClientConfiguration)
- config: Config & PinpointSMSVoiceV2.Types.ClientConfiguration;
- /**
- * Associates the specified origination identity with a pool. If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools. If the origination identity configuration doesn't match the pool's configuration, an error is returned.
- */
- associateOriginationIdentity(params: PinpointSMSVoiceV2.Types.AssociateOriginationIdentityRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.AssociateOriginationIdentityResult) => void): Request<PinpointSMSVoiceV2.Types.AssociateOriginationIdentityResult, AWSError>;
- /**
- * Associates the specified origination identity with a pool. If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools. If the origination identity configuration doesn't match the pool's configuration, an error is returned.
- */
- associateOriginationIdentity(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.AssociateOriginationIdentityResult) => void): Request<PinpointSMSVoiceV2.Types.AssociateOriginationIdentityResult, AWSError>;
- /**
- * Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.
- */
- associateProtectConfiguration(params: PinpointSMSVoiceV2.Types.AssociateProtectConfigurationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.AssociateProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.AssociateProtectConfigurationResult, AWSError>;
- /**
- * Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.
- */
- associateProtectConfiguration(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.AssociateProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.AssociateProtectConfigurationResult, AWSError>;
- /**
- * Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it. A configuration set is a set of rules that you apply to the SMS and voice messages that you send. When you send a message, you can optionally specify a single configuration set.
- */
- createConfigurationSet(params: PinpointSMSVoiceV2.Types.CreateConfigurationSetRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateConfigurationSetResult) => void): Request<PinpointSMSVoiceV2.Types.CreateConfigurationSetResult, AWSError>;
- /**
- * Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it. A configuration set is a set of rules that you apply to the SMS and voice messages that you send. When you send a message, you can optionally specify a single configuration set.
- */
- createConfigurationSet(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateConfigurationSetResult) => void): Request<PinpointSMSVoiceV2.Types.CreateConfigurationSetResult, AWSError>;
- /**
- * Creates a new event destination in a configuration set. An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic. Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
- */
- createEventDestination(params: PinpointSMSVoiceV2.Types.CreateEventDestinationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateEventDestinationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateEventDestinationResult, AWSError>;
- /**
- * Creates a new event destination in a configuration set. An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic. Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
- */
- createEventDestination(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateEventDestinationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateEventDestinationResult, AWSError>;
- /**
- * Creates a new opt-out list. If the opt-out list name already exists, an error is returned. An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
- */
- createOptOutList(params: PinpointSMSVoiceV2.Types.CreateOptOutListRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateOptOutListResult) => void): Request<PinpointSMSVoiceV2.Types.CreateOptOutListResult, AWSError>;
- /**
- * Creates a new opt-out list. If the opt-out list name already exists, an error is returned. An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
- */
- createOptOutList(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateOptOutListResult) => void): Request<PinpointSMSVoiceV2.Types.CreateOptOutListResult, AWSError>;
- /**
- * Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account. The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false. If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
- */
- createPool(params: PinpointSMSVoiceV2.Types.CreatePoolRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreatePoolResult) => void): Request<PinpointSMSVoiceV2.Types.CreatePoolResult, AWSError>;
- /**
- * Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account. The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false. If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
- */
- createPool(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreatePoolResult) => void): Request<PinpointSMSVoiceV2.Types.CreatePoolResult, AWSError>;
- /**
- * Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.
- */
- createProtectConfiguration(params: PinpointSMSVoiceV2.Types.CreateProtectConfigurationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateProtectConfigurationResult, AWSError>;
- /**
- * Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.
- */
- createProtectConfiguration(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateProtectConfigurationResult, AWSError>;
- /**
- * Creates a new registration based on the RegistrationType field.
- */
- createRegistration(params: PinpointSMSVoiceV2.Types.CreateRegistrationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationResult, AWSError>;
- /**
- * Creates a new registration based on the RegistrationType field.
- */
- createRegistration(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationResult, AWSError>;
- /**
- * Associate the registration with an origination identity such as a phone number or sender ID.
- */
- createRegistrationAssociation(params: PinpointSMSVoiceV2.Types.CreateRegistrationAssociationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationAssociationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationAssociationResult, AWSError>;
- /**
- * Associate the registration with an origination identity such as a phone number or sender ID.
- */
- createRegistrationAssociation(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationAssociationResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationAssociationResult, AWSError>;
- /**
- * Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
- */
- createRegistrationAttachment(params: PinpointSMSVoiceV2.Types.CreateRegistrationAttachmentRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationAttachmentResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationAttachmentResult, AWSError>;
- /**
- * Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
- */
- createRegistrationAttachment(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationAttachmentResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationAttachmentResult, AWSError>;
- /**
- * Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
- */
- createRegistrationVersion(params: PinpointSMSVoiceV2.Types.CreateRegistrationVersionRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationVersionResult, AWSError>;
- /**
- * Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
- */
- createRegistrationVersion(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.CreateRegistrationVersionResult, AWSError>;
- /**
- * You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
- */
- createVerifiedDestinationNumber(params: PinpointSMSVoiceV2.Types.CreateVerifiedDestinationNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateVerifiedDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.CreateVerifiedDestinationNumberResult, AWSError>;
- /**
- * You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
- */
- createVerifiedDestinationNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.CreateVerifiedDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.CreateVerifiedDestinationNumberResult, AWSError>;
- /**
- * Removes the current account default protect configuration.
- */
- deleteAccountDefaultProtectConfiguration(params: PinpointSMSVoiceV2.Types.DeleteAccountDefaultProtectConfigurationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteAccountDefaultProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteAccountDefaultProtectConfigurationResult, AWSError>;
- /**
- * Removes the current account default protect configuration.
- */
- deleteAccountDefaultProtectConfiguration(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteAccountDefaultProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteAccountDefaultProtectConfigurationResult, AWSError>;
- /**
- * Deletes an existing configuration set. A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
- */
- deleteConfigurationSet(params: PinpointSMSVoiceV2.Types.DeleteConfigurationSetRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteConfigurationSetResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteConfigurationSetResult, AWSError>;
- /**
- * Deletes an existing configuration set. A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
- */
- deleteConfigurationSet(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteConfigurationSetResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteConfigurationSetResult, AWSError>;
- /**
- * Deletes an existing default message type on a configuration set. A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
- */
- deleteDefaultMessageType(params: PinpointSMSVoiceV2.Types.DeleteDefaultMessageTypeRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteDefaultMessageTypeResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteDefaultMessageTypeResult, AWSError>;
- /**
- * Deletes an existing default message type on a configuration set. A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
- */
- deleteDefaultMessageType(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteDefaultMessageTypeResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteDefaultMessageTypeResult, AWSError>;
- /**
- * Deletes an existing default sender ID on a configuration set. A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
- */
- deleteDefaultSenderId(params: PinpointSMSVoiceV2.Types.DeleteDefaultSenderIdRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteDefaultSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteDefaultSenderIdResult, AWSError>;
- /**
- * Deletes an existing default sender ID on a configuration set. A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
- */
- deleteDefaultSenderId(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteDefaultSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteDefaultSenderIdResult, AWSError>;
- /**
- * Deletes an existing event destination. An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
- */
- deleteEventDestination(params: PinpointSMSVoiceV2.Types.DeleteEventDestinationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteEventDestinationResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteEventDestinationResult, AWSError>;
- /**
- * Deletes an existing event destination. An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
- */
- deleteEventDestination(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteEventDestinationResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteEventDestinationResult, AWSError>;
- /**
- * Deletes an existing keyword from an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. Keywords "HELP" and "STOP" can't be deleted or modified.
- */
- deleteKeyword(params: PinpointSMSVoiceV2.Types.DeleteKeywordRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteKeywordResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteKeywordResult, AWSError>;
- /**
- * Deletes an existing keyword from an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. Keywords "HELP" and "STOP" can't be deleted or modified.
- */
- deleteKeyword(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteKeywordResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteKeywordResult, AWSError>;
- /**
- * Deletes an account-level monthly spending limit override for sending multimedia messages (MMS). Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas for Server Migration Service in the Server Migration Service User Guide.
- */
- deleteMediaMessageSpendLimitOverride(params: PinpointSMSVoiceV2.Types.DeleteMediaMessageSpendLimitOverrideRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteMediaMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteMediaMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Deletes an account-level monthly spending limit override for sending multimedia messages (MMS). Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas for Server Migration Service in the Server Migration Service User Guide.
- */
- deleteMediaMessageSpendLimitOverride(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteMediaMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteMediaMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted. If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.
- */
- deleteOptOutList(params: PinpointSMSVoiceV2.Types.DeleteOptOutListRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteOptOutListResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteOptOutListResult, AWSError>;
- /**
- * Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted. If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.
- */
- deleteOptOutList(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteOptOutListResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteOptOutListResult, AWSError>;
- /**
- * Deletes an existing opted out destination phone number from the specified opt-out list. Each destination phone number can only be deleted once every 30 days. If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.
- */
- deleteOptedOutNumber(params: PinpointSMSVoiceV2.Types.DeleteOptedOutNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteOptedOutNumberResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteOptedOutNumberResult, AWSError>;
- /**
- * Deletes an existing opted out destination phone number from the specified opt-out list. Each destination phone number can only be deleted once every 30 days. If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.
- */
- deleteOptedOutNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteOptedOutNumberResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteOptedOutNumberResult, AWSError>;
- /**
- * Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool. If the pool status isn't active or if deletion protection is enabled, an error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
- */
- deletePool(params: PinpointSMSVoiceV2.Types.DeletePoolRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeletePoolResult) => void): Request<PinpointSMSVoiceV2.Types.DeletePoolResult, AWSError>;
- /**
- * Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool. If the pool status isn't active or if deletion protection is enabled, an error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
- */
- deletePool(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeletePoolResult) => void): Request<PinpointSMSVoiceV2.Types.DeletePoolResult, AWSError>;
- /**
- * Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.
- */
- deleteProtectConfiguration(params: PinpointSMSVoiceV2.Types.DeleteProtectConfigurationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteProtectConfigurationResult, AWSError>;
- /**
- * Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.
- */
- deleteProtectConfiguration(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteProtectConfigurationResult, AWSError>;
- /**
- * Permanently delete an existing registration from your account.
- */
- deleteRegistration(params: PinpointSMSVoiceV2.Types.DeleteRegistrationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationResult, AWSError>;
- /**
- * Permanently delete an existing registration from your account.
- */
- deleteRegistration(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationResult, AWSError>;
- /**
- * Permanently delete the specified registration attachment.
- */
- deleteRegistrationAttachment(params: PinpointSMSVoiceV2.Types.DeleteRegistrationAttachmentRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationAttachmentResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationAttachmentResult, AWSError>;
- /**
- * Permanently delete the specified registration attachment.
- */
- deleteRegistrationAttachment(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationAttachmentResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationAttachmentResult, AWSError>;
- /**
- * Delete the value in a registration form field.
- */
- deleteRegistrationFieldValue(params: PinpointSMSVoiceV2.Types.DeleteRegistrationFieldValueRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationFieldValueResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationFieldValueResult, AWSError>;
- /**
- * Delete the value in a registration form field.
- */
- deleteRegistrationFieldValue(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteRegistrationFieldValueResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteRegistrationFieldValueResult, AWSError>;
- /**
- * Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
- */
- deleteTextMessageSpendLimitOverride(params: PinpointSMSVoiceV2.Types.DeleteTextMessageSpendLimitOverrideRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteTextMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteTextMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
- */
- deleteTextMessageSpendLimitOverride(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteTextMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteTextMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Delete a verified destination phone number.
- */
- deleteVerifiedDestinationNumber(params: PinpointSMSVoiceV2.Types.DeleteVerifiedDestinationNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteVerifiedDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteVerifiedDestinationNumberResult, AWSError>;
- /**
- * Delete a verified destination phone number.
- */
- deleteVerifiedDestinationNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteVerifiedDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteVerifiedDestinationNumberResult, AWSError>;
- /**
- * Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
- */
- deleteVoiceMessageSpendLimitOverride(params: PinpointSMSVoiceV2.Types.DeleteVoiceMessageSpendLimitOverrideRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteVoiceMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteVoiceMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
- */
- deleteVoiceMessageSpendLimitOverride(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DeleteVoiceMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.DeleteVoiceMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request. New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
- */
- describeAccountAttributes(params: PinpointSMSVoiceV2.Types.DescribeAccountAttributesRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeAccountAttributesResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeAccountAttributesResult, AWSError>;
- /**
- * Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request. New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
- */
- describeAccountAttributes(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeAccountAttributesResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeAccountAttributesResult, AWSError>;
- /**
- * Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
- */
- describeAccountLimits(params: PinpointSMSVoiceV2.Types.DescribeAccountLimitsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeAccountLimitsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeAccountLimitsResult, AWSError>;
- /**
- * Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
- */
- describeAccountLimits(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeAccountLimitsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeAccountLimitsResult, AWSError>;
- /**
- * Describes the specified configuration sets or all in your account. If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets. If you specify a configuration set name that isn't valid, an error is returned.
- */
- describeConfigurationSets(params: PinpointSMSVoiceV2.Types.DescribeConfigurationSetsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeConfigurationSetsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeConfigurationSetsResult, AWSError>;
- /**
- * Describes the specified configuration sets or all in your account. If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets. If you specify a configuration set name that isn't valid, an error is returned.
- */
- describeConfigurationSets(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeConfigurationSetsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeConfigurationSetsResult, AWSError>;
- /**
- * Describes the specified keywords or all keywords on your origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an error is returned.
- */
- describeKeywords(params: PinpointSMSVoiceV2.Types.DescribeKeywordsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeKeywordsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeKeywordsResult, AWSError>;
- /**
- * Describes the specified keywords or all keywords on your origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an error is returned.
- */
- describeKeywords(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeKeywordsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeKeywordsResult, AWSError>;
- /**
- * Describes the specified opt-out list or all opt-out lists in your account. If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists. If you specify an opt-out list name that isn't valid, an error is returned.
- */
- describeOptOutLists(params: PinpointSMSVoiceV2.Types.DescribeOptOutListsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeOptOutListsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeOptOutListsResult, AWSError>;
- /**
- * Describes the specified opt-out list or all opt-out lists in your account. If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists. If you specify an opt-out list name that isn't valid, an error is returned.
- */
- describeOptOutLists(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeOptOutListsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeOptOutListsResult, AWSError>;
- /**
- * Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list. If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list. If you specify an opted out number that isn't valid, an error is returned.
- */
- describeOptedOutNumbers(params: PinpointSMSVoiceV2.Types.DescribeOptedOutNumbersRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeOptedOutNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeOptedOutNumbersResult, AWSError>;
- /**
- * Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list. If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list. If you specify an opted out number that isn't valid, an error is returned.
- */
- describeOptedOutNumbers(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeOptedOutNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeOptedOutNumbersResult, AWSError>;
- /**
- * Describes the specified origination phone number, or all the phone numbers in your account. If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers. If you specify a phone number ID that isn't valid, an error is returned.
- */
- describePhoneNumbers(params: PinpointSMSVoiceV2.Types.DescribePhoneNumbersRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribePhoneNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribePhoneNumbersResult, AWSError>;
- /**
- * Describes the specified origination phone number, or all the phone numbers in your account. If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers. If you specify a phone number ID that isn't valid, an error is returned.
- */
- describePhoneNumbers(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribePhoneNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribePhoneNumbersResult, AWSError>;
- /**
- * Retrieves the specified pools or all pools associated with your Amazon Web Services account. If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools. If you specify a pool ID that isn't valid, an error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
- */
- describePools(params: PinpointSMSVoiceV2.Types.DescribePoolsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribePoolsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribePoolsResult, AWSError>;
- /**
- * Retrieves the specified pools or all pools associated with your Amazon Web Services account. If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools. If you specify a pool ID that isn't valid, an error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
- */
- describePools(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribePoolsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribePoolsResult, AWSError>;
- /**
- * Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
- */
- describeProtectConfigurations(params: PinpointSMSVoiceV2.Types.DescribeProtectConfigurationsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeProtectConfigurationsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeProtectConfigurationsResult, AWSError>;
- /**
- * Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
- */
- describeProtectConfigurations(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeProtectConfigurationsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeProtectConfigurationsResult, AWSError>;
- /**
- * Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
- */
- describeRegistrationAttachments(params: PinpointSMSVoiceV2.Types.DescribeRegistrationAttachmentsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationAttachmentsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationAttachmentsResult, AWSError>;
- /**
- * Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
- */
- describeRegistrationAttachments(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationAttachmentsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationAttachmentsResult, AWSError>;
- /**
- * Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
- */
- describeRegistrationFieldDefinitions(params: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldDefinitionsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationFieldDefinitionsResult, AWSError>;
- /**
- * Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
- */
- describeRegistrationFieldDefinitions(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationFieldDefinitionsResult, AWSError>;
- /**
- * Retrieves the specified registration field values.
- */
- describeRegistrationFieldValues(params: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldValuesRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldValuesResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationFieldValuesResult, AWSError>;
- /**
- * Retrieves the specified registration field values.
- */
- describeRegistrationFieldValues(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationFieldValuesResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationFieldValuesResult, AWSError>;
- /**
- * Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
- */
- describeRegistrationSectionDefinitions(params: PinpointSMSVoiceV2.Types.DescribeRegistrationSectionDefinitionsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationSectionDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationSectionDefinitionsResult, AWSError>;
- /**
- * Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
- */
- describeRegistrationSectionDefinitions(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationSectionDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationSectionDefinitionsResult, AWSError>;
- /**
- * Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
- */
- describeRegistrationTypeDefinitions(params: PinpointSMSVoiceV2.Types.DescribeRegistrationTypeDefinitionsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationTypeDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationTypeDefinitionsResult, AWSError>;
- /**
- * Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
- */
- describeRegistrationTypeDefinitions(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationTypeDefinitionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationTypeDefinitionsResult, AWSError>;
- /**
- * Retrieves the specified registration version.
- */
- describeRegistrationVersions(params: PinpointSMSVoiceV2.Types.DescribeRegistrationVersionsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationVersionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationVersionsResult, AWSError>;
- /**
- * Retrieves the specified registration version.
- */
- describeRegistrationVersions(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationVersionsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationVersionsResult, AWSError>;
- /**
- * Retrieves the specified registrations.
- */
- describeRegistrations(params: PinpointSMSVoiceV2.Types.DescribeRegistrationsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationsResult, AWSError>;
- /**
- * Retrieves the specified registrations.
- */
- describeRegistrations(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeRegistrationsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeRegistrationsResult, AWSError>;
- /**
- * Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account. If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds. f you specify a sender ID that isn't valid, an error is returned.
- */
- describeSenderIds(params: PinpointSMSVoiceV2.Types.DescribeSenderIdsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeSenderIdsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeSenderIdsResult, AWSError>;
- /**
- * Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account. If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds. f you specify a sender ID that isn't valid, an error is returned.
- */
- describeSenderIds(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeSenderIdsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeSenderIdsResult, AWSError>;
- /**
- * Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
- */
- describeSpendLimits(params: PinpointSMSVoiceV2.Types.DescribeSpendLimitsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeSpendLimitsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeSpendLimitsResult, AWSError>;
- /**
- * Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
- */
- describeSpendLimits(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeSpendLimitsResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeSpendLimitsResult, AWSError>;
- /**
- * Retrieves the specified verified destiona numbers.
- */
- describeVerifiedDestinationNumbers(params: PinpointSMSVoiceV2.Types.DescribeVerifiedDestinationNumbersRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeVerifiedDestinationNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeVerifiedDestinationNumbersResult, AWSError>;
- /**
- * Retrieves the specified verified destiona numbers.
- */
- describeVerifiedDestinationNumbers(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DescribeVerifiedDestinationNumbersResult) => void): Request<PinpointSMSVoiceV2.Types.DescribeVerifiedDestinationNumbersResult, AWSError>;
- /**
- * Removes the specified origination identity from an existing pool. If the origination identity isn't associated with the specified pool, an error is returned.
- */
- disassociateOriginationIdentity(params: PinpointSMSVoiceV2.Types.DisassociateOriginationIdentityRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DisassociateOriginationIdentityResult) => void): Request<PinpointSMSVoiceV2.Types.DisassociateOriginationIdentityResult, AWSError>;
- /**
- * Removes the specified origination identity from an existing pool. If the origination identity isn't associated with the specified pool, an error is returned.
- */
- disassociateOriginationIdentity(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DisassociateOriginationIdentityResult) => void): Request<PinpointSMSVoiceV2.Types.DisassociateOriginationIdentityResult, AWSError>;
- /**
- * Disassociate a protect configuration from a configuration set.
- */
- disassociateProtectConfiguration(params: PinpointSMSVoiceV2.Types.DisassociateProtectConfigurationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DisassociateProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.DisassociateProtectConfigurationResult, AWSError>;
- /**
- * Disassociate a protect configuration from a configuration set.
- */
- disassociateProtectConfiguration(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DisassociateProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.DisassociateProtectConfigurationResult, AWSError>;
- /**
- * Discard the current version of the registration.
- */
- discardRegistrationVersion(params: PinpointSMSVoiceV2.Types.DiscardRegistrationVersionRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DiscardRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.DiscardRegistrationVersionResult, AWSError>;
- /**
- * Discard the current version of the registration.
- */
- discardRegistrationVersion(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.DiscardRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.DiscardRegistrationVersionResult, AWSError>;
- /**
- * Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
- */
- getProtectConfigurationCountryRuleSet(params: PinpointSMSVoiceV2.Types.GetProtectConfigurationCountryRuleSetRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.GetProtectConfigurationCountryRuleSetResult) => void): Request<PinpointSMSVoiceV2.Types.GetProtectConfigurationCountryRuleSetResult, AWSError>;
- /**
- * Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
- */
- getProtectConfigurationCountryRuleSet(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.GetProtectConfigurationCountryRuleSetResult) => void): Request<PinpointSMSVoiceV2.Types.GetProtectConfigurationCountryRuleSetResult, AWSError>;
- /**
- * Lists all associated origination identities in your pool. If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
- */
- listPoolOriginationIdentities(params: PinpointSMSVoiceV2.Types.ListPoolOriginationIdentitiesRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ListPoolOriginationIdentitiesResult) => void): Request<PinpointSMSVoiceV2.Types.ListPoolOriginationIdentitiesResult, AWSError>;
- /**
- * Lists all associated origination identities in your pool. If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
- */
- listPoolOriginationIdentities(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ListPoolOriginationIdentitiesResult) => void): Request<PinpointSMSVoiceV2.Types.ListPoolOriginationIdentitiesResult, AWSError>;
- /**
- * Retreive all of the origination identies that are associated with a registration.
- */
- listRegistrationAssociations(params: PinpointSMSVoiceV2.Types.ListRegistrationAssociationsRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ListRegistrationAssociationsResult) => void): Request<PinpointSMSVoiceV2.Types.ListRegistrationAssociationsResult, AWSError>;
- /**
- * Retreive all of the origination identies that are associated with a registration.
- */
- listRegistrationAssociations(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ListRegistrationAssociationsResult) => void): Request<PinpointSMSVoiceV2.Types.ListRegistrationAssociationsResult, AWSError>;
- /**
- * List all tags associated with a resource.
- */
- listTagsForResource(params: PinpointSMSVoiceV2.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ListTagsForResourceResult) => void): Request<PinpointSMSVoiceV2.Types.ListTagsForResourceResult, AWSError>;
- /**
- * List all tags associated with a resource.
- */
- listTagsForResource(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ListTagsForResourceResult) => void): Request<PinpointSMSVoiceV2.Types.ListTagsForResourceResult, AWSError>;
- /**
- * Creates or updates a keyword configuration on an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an error is returned.
- */
- putKeyword(params: PinpointSMSVoiceV2.Types.PutKeywordRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutKeywordResult) => void): Request<PinpointSMSVoiceV2.Types.PutKeywordResult, AWSError>;
- /**
- * Creates or updates a keyword configuration on an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an error is returned.
- */
- putKeyword(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutKeywordResult) => void): Request<PinpointSMSVoiceV2.Types.PutKeywordResult, AWSError>;
- /**
- * Creates an opted out destination phone number in the opt-out list. If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
- */
- putOptedOutNumber(params: PinpointSMSVoiceV2.Types.PutOptedOutNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutOptedOutNumberResult) => void): Request<PinpointSMSVoiceV2.Types.PutOptedOutNumberResult, AWSError>;
- /**
- * Creates an opted out destination phone number in the opt-out list. If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
- */
- putOptedOutNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutOptedOutNumberResult) => void): Request<PinpointSMSVoiceV2.Types.PutOptedOutNumberResult, AWSError>;
- /**
- * Creates or updates a field value for a registration.
- */
- putRegistrationFieldValue(params: PinpointSMSVoiceV2.Types.PutRegistrationFieldValueRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutRegistrationFieldValueResult) => void): Request<PinpointSMSVoiceV2.Types.PutRegistrationFieldValueResult, AWSError>;
- /**
- * Creates or updates a field value for a registration.
- */
- putRegistrationFieldValue(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.PutRegistrationFieldValueResult) => void): Request<PinpointSMSVoiceV2.Types.PutRegistrationFieldValueResult, AWSError>;
- /**
- * Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages. If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
- */
- releasePhoneNumber(params: PinpointSMSVoiceV2.Types.ReleasePhoneNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ReleasePhoneNumberResult) => void): Request<PinpointSMSVoiceV2.Types.ReleasePhoneNumberResult, AWSError>;
- /**
- * Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages. If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
- */
- releasePhoneNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ReleasePhoneNumberResult) => void): Request<PinpointSMSVoiceV2.Types.ReleasePhoneNumberResult, AWSError>;
- /**
- * Releases an existing sender ID in your account.
- */
- releaseSenderId(params: PinpointSMSVoiceV2.Types.ReleaseSenderIdRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ReleaseSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.ReleaseSenderIdResult, AWSError>;
- /**
- * Releases an existing sender ID in your account.
- */
- releaseSenderId(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.ReleaseSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.ReleaseSenderIdResult, AWSError>;
- /**
- * Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
- */
- requestPhoneNumber(params: PinpointSMSVoiceV2.Types.RequestPhoneNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.RequestPhoneNumberResult) => void): Request<PinpointSMSVoiceV2.Types.RequestPhoneNumberResult, AWSError>;
- /**
- * Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
- */
- requestPhoneNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.RequestPhoneNumberResult) => void): Request<PinpointSMSVoiceV2.Types.RequestPhoneNumberResult, AWSError>;
- /**
- * Request a new sender ID that doesn't require registration.
- */
- requestSenderId(params: PinpointSMSVoiceV2.Types.RequestSenderIdRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.RequestSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.RequestSenderIdResult, AWSError>;
- /**
- * Request a new sender ID that doesn't require registration.
- */
- requestSenderId(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.RequestSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.RequestSenderIdResult, AWSError>;
- /**
- * Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
- */
- sendDestinationNumberVerificationCode(params: PinpointSMSVoiceV2.Types.SendDestinationNumberVerificationCodeRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendDestinationNumberVerificationCodeResult) => void): Request<PinpointSMSVoiceV2.Types.SendDestinationNumberVerificationCodeResult, AWSError>;
- /**
- * Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
- */
- sendDestinationNumberVerificationCode(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendDestinationNumberVerificationCodeResult) => void): Request<PinpointSMSVoiceV2.Types.SendDestinationNumberVerificationCodeResult, AWSError>;
- /**
- * Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
- */
- sendMediaMessage(params: PinpointSMSVoiceV2.Types.SendMediaMessageRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendMediaMessageResult) => void): Request<PinpointSMSVoiceV2.Types.SendMediaMessageResult, AWSError>;
- /**
- * Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
- */
- sendMediaMessage(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendMediaMessageResult) => void): Request<PinpointSMSVoiceV2.Types.SendMediaMessageResult, AWSError>;
- /**
- * Creates a new text message and sends it to a recipient's phone number. SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
- */
- sendTextMessage(params: PinpointSMSVoiceV2.Types.SendTextMessageRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendTextMessageResult) => void): Request<PinpointSMSVoiceV2.Types.SendTextMessageResult, AWSError>;
- /**
- * Creates a new text message and sends it to a recipient's phone number. SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
- */
- sendTextMessage(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendTextMessageResult) => void): Request<PinpointSMSVoiceV2.Types.SendTextMessageResult, AWSError>;
- /**
- * Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
- */
- sendVoiceMessage(params: PinpointSMSVoiceV2.Types.SendVoiceMessageRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendVoiceMessageResult) => void): Request<PinpointSMSVoiceV2.Types.SendVoiceMessageResult, AWSError>;
- /**
- * Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
- */
- sendVoiceMessage(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SendVoiceMessageResult) => void): Request<PinpointSMSVoiceV2.Types.SendVoiceMessageResult, AWSError>;
- /**
- * Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.
- */
- setAccountDefaultProtectConfiguration(params: PinpointSMSVoiceV2.Types.SetAccountDefaultProtectConfigurationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetAccountDefaultProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.SetAccountDefaultProtectConfigurationResult, AWSError>;
- /**
- * Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.
- */
- setAccountDefaultProtectConfiguration(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetAccountDefaultProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.SetAccountDefaultProtectConfigurationResult, AWSError>;
- /**
- * Sets the default message type on a configuration set. Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
- */
- setDefaultMessageType(params: PinpointSMSVoiceV2.Types.SetDefaultMessageTypeRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetDefaultMessageTypeResult) => void): Request<PinpointSMSVoiceV2.Types.SetDefaultMessageTypeResult, AWSError>;
- /**
- * Sets the default message type on a configuration set. Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
- */
- setDefaultMessageType(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetDefaultMessageTypeResult) => void): Request<PinpointSMSVoiceV2.Types.SetDefaultMessageTypeResult, AWSError>;
- /**
- * Sets default sender ID on a configuration set. When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
- */
- setDefaultSenderId(params: PinpointSMSVoiceV2.Types.SetDefaultSenderIdRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetDefaultSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.SetDefaultSenderIdResult, AWSError>;
- /**
- * Sets default sender ID on a configuration set. When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
- */
- setDefaultSenderId(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetDefaultSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.SetDefaultSenderIdResult, AWSError>;
- /**
- * Sets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
- */
- setMediaMessageSpendLimitOverride(params: PinpointSMSVoiceV2.Types.SetMediaMessageSpendLimitOverrideRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetMediaMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.SetMediaMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Sets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
- */
- setMediaMessageSpendLimitOverride(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetMediaMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.SetMediaMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
- */
- setTextMessageSpendLimitOverride(params: PinpointSMSVoiceV2.Types.SetTextMessageSpendLimitOverrideRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetTextMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.SetTextMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
- */
- setTextMessageSpendLimitOverride(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetTextMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.SetTextMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
- */
- setVoiceMessageSpendLimitOverride(params: PinpointSMSVoiceV2.Types.SetVoiceMessageSpendLimitOverrideRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetVoiceMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.SetVoiceMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
- */
- setVoiceMessageSpendLimitOverride(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SetVoiceMessageSpendLimitOverrideResult) => void): Request<PinpointSMSVoiceV2.Types.SetVoiceMessageSpendLimitOverrideResult, AWSError>;
- /**
- * Submit the specified registration for review and approval.
- */
- submitRegistrationVersion(params: PinpointSMSVoiceV2.Types.SubmitRegistrationVersionRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SubmitRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.SubmitRegistrationVersionResult, AWSError>;
- /**
- * Submit the specified registration for review and approval.
- */
- submitRegistrationVersion(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.SubmitRegistrationVersionResult) => void): Request<PinpointSMSVoiceV2.Types.SubmitRegistrationVersionResult, AWSError>;
- /**
- * Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
- */
- tagResource(params: PinpointSMSVoiceV2.Types.TagResourceRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.TagResourceResult) => void): Request<PinpointSMSVoiceV2.Types.TagResourceResult, AWSError>;
- /**
- * Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
- */
- tagResource(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.TagResourceResult) => void): Request<PinpointSMSVoiceV2.Types.TagResourceResult, AWSError>;
- /**
- * Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
- */
- untagResource(params: PinpointSMSVoiceV2.Types.UntagResourceRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UntagResourceResult) => void): Request<PinpointSMSVoiceV2.Types.UntagResourceResult, AWSError>;
- /**
- * Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
- */
- untagResource(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UntagResourceResult) => void): Request<PinpointSMSVoiceV2.Types.UntagResourceResult, AWSError>;
- /**
- * Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination. You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
- */
- updateEventDestination(params: PinpointSMSVoiceV2.Types.UpdateEventDestinationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdateEventDestinationResult) => void): Request<PinpointSMSVoiceV2.Types.UpdateEventDestinationResult, AWSError>;
- /**
- * Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination. You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
- */
- updateEventDestination(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdateEventDestinationResult) => void): Request<PinpointSMSVoiceV2.Types.UpdateEventDestinationResult, AWSError>;
- /**
- * Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection. If the origination phone number is associated with a pool, an error is returned.
- */
- updatePhoneNumber(params: PinpointSMSVoiceV2.Types.UpdatePhoneNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdatePhoneNumberResult) => void): Request<PinpointSMSVoiceV2.Types.UpdatePhoneNumberResult, AWSError>;
- /**
- * Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection. If the origination phone number is associated with a pool, an error is returned.
- */
- updatePhoneNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdatePhoneNumberResult) => void): Request<PinpointSMSVoiceV2.Types.UpdatePhoneNumberResult, AWSError>;
- /**
- * Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
- */
- updatePool(params: PinpointSMSVoiceV2.Types.UpdatePoolRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdatePoolResult) => void): Request<PinpointSMSVoiceV2.Types.UpdatePoolResult, AWSError>;
- /**
- * Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
- */
- updatePool(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdatePoolResult) => void): Request<PinpointSMSVoiceV2.Types.UpdatePoolResult, AWSError>;
- /**
- * Update the setting for an existing protect configuration.
- */
- updateProtectConfiguration(params: PinpointSMSVoiceV2.Types.UpdateProtectConfigurationRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdateProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.UpdateProtectConfigurationResult, AWSError>;
- /**
- * Update the setting for an existing protect configuration.
- */
- updateProtectConfiguration(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdateProtectConfigurationResult) => void): Request<PinpointSMSVoiceV2.Types.UpdateProtectConfigurationResult, AWSError>;
- /**
- * Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.
- */
- updateProtectConfigurationCountryRuleSet(params: PinpointSMSVoiceV2.Types.UpdateProtectConfigurationCountryRuleSetRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdateProtectConfigurationCountryRuleSetResult) => void): Request<PinpointSMSVoiceV2.Types.UpdateProtectConfigurationCountryRuleSetResult, AWSError>;
- /**
- * Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.
- */
- updateProtectConfigurationCountryRuleSet(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdateProtectConfigurationCountryRuleSetResult) => void): Request<PinpointSMSVoiceV2.Types.UpdateProtectConfigurationCountryRuleSetResult, AWSError>;
- /**
- * Updates the configuration of an existing sender ID.
- */
- updateSenderId(params: PinpointSMSVoiceV2.Types.UpdateSenderIdRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdateSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.UpdateSenderIdResult, AWSError>;
- /**
- * Updates the configuration of an existing sender ID.
- */
- updateSenderId(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.UpdateSenderIdResult) => void): Request<PinpointSMSVoiceV2.Types.UpdateSenderIdResult, AWSError>;
- /**
- * Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
- */
- verifyDestinationNumber(params: PinpointSMSVoiceV2.Types.VerifyDestinationNumberRequest, callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.VerifyDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.VerifyDestinationNumberResult, AWSError>;
- /**
- * Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
- */
- verifyDestinationNumber(callback?: (err: AWSError, data: PinpointSMSVoiceV2.Types.VerifyDestinationNumberResult) => void): Request<PinpointSMSVoiceV2.Types.VerifyDestinationNumberResult, AWSError>;
- }
- declare namespace PinpointSMSVoiceV2 {
- export interface AccountAttribute {
- /**
- * The name of the account attribute.
- */
- Name: AccountAttributeName;
- /**
- * The value associated with the account attribute name.
- */
- Value: String;
- }
- export type AccountAttributeList = AccountAttribute[];
- export type AccountAttributeName = "ACCOUNT_TIER"|"DEFAULT_PROTECT_CONFIGURATION_ID"|string;
- export interface AccountLimit {
- /**
- * The name of the attribute to apply the account limit to.
- */
- Name: AccountLimitName;
- /**
- * The current amount that has been spent, in US dollars.
- */
- Used: PrimitiveLong;
- /**
- * The Amazon Web Services set limit for that resource type, in US dollars.
- */
- Max: PrimitiveLong;
- }
- export type AccountLimitList = AccountLimit[];
- export type AccountLimitName = "PHONE_NUMBERS"|"POOLS"|"CONFIGURATION_SETS"|"OPT_OUT_LISTS"|"SENDER_IDS"|"REGISTRATIONS"|"REGISTRATION_ATTACHMENTS"|"VERIFIED_DESTINATION_NUMBERS"|string;
- export type AmazonResourceName = string;
- export interface AssociateOriginationIdentityRequest {
- /**
- * The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.
- */
- PoolId: PoolIdOrArn;
- /**
- * The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
- */
- OriginationIdentity: PhoneOrSenderIdOrArn;
- /**
- * The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- }
- export interface AssociateOriginationIdentityResult {
- /**
- * The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
- */
- PoolArn?: String;
- /**
- * The PoolId of the pool that is now associated with the origination identity.
- */
- PoolId?: String;
- /**
- * The PhoneNumberArn or SenderIdArn of the origination identity.
- */
- OriginationIdentityArn?: String;
- /**
- * The PhoneNumberId or SenderId of the origination identity.
- */
- OriginationIdentity?: String;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode?: IsoCountryCode;
- }
- export interface AssociateProtectConfigurationRequest {
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationIdOrArn;
- /**
- * The name of the ConfigurationSet.
- */
- ConfigurationSetName: ConfigurationSetNameOrArn;
- }
- export interface AssociateProtectConfigurationResult {
- /**
- * The Amazon Resource Name (ARN) of the configuration set.
- */
- ConfigurationSetArn: String;
- /**
- * The name of the ConfigurationSet.
- */
- ConfigurationSetName: ConfigurationSetName;
- /**
- * The Amazon Resource Name (ARN) of the protect configuration.
- */
- ProtectConfigurationArn: ProtectConfigurationArn;
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationId;
- }
- export type AttachmentBody = Buffer|Uint8Array|Blob|string;
- export type AttachmentStatus = "UPLOAD_IN_PROGRESS"|"UPLOAD_COMPLETE"|"UPLOAD_FAILED"|"DELETED"|string;
- export type AttachmentUploadErrorReason = "INTERNAL_ERROR"|string;
- export type AttachmentUrl = string;
- export type Boolean = boolean;
- export type ClientToken = string;
- export interface CloudWatchLogsDestination {
- /**
- * The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
- */
- IamRoleArn: IamRoleArn;
- /**
- * The name of the Amazon CloudWatch log group that you want to record events in.
- */
- LogGroupArn: LogGroupArn;
- }
- export interface ConfigurationSetFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: ConfigurationSetFilterName;
- /**
- * An array values to filter for.
- */
- Values: FilterValueList;
- }
- export type ConfigurationSetFilterList = ConfigurationSetFilter[];
- export type ConfigurationSetFilterName = "event-destination-name"|"matching-event-types"|"default-message-type"|"default-sender-id"|"protect-configuration-id"|string;
- export interface ConfigurationSetInformation {
- /**
- * The Resource Name (ARN) of the ConfigurationSet.
- */
- ConfigurationSetArn: String;
- /**
- * The name of the ConfigurationSet.
- */
- ConfigurationSetName: ConfigurationSetName;
- /**
- * An array of EventDestination objects that describe any events to log and where to log them.
- */
- EventDestinations: EventDestinationList;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- DefaultMessageType?: MessageType;
- /**
- * The default sender ID used by the ConfigurationSet.
- */
- DefaultSenderId?: SenderId;
- /**
- * The time when the ConfigurationSet was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId?: ProtectConfigurationIdOrArn;
- }
- export type ConfigurationSetInformationList = ConfigurationSetInformation[];
- export type ConfigurationSetName = string;
- export type ConfigurationSetNameList = ConfigurationSetNameOrArn[];
- export type ConfigurationSetNameOrArn = string;
- export type ContextKey = string;
- export type ContextMap = {[key: string]: ContextValue};
- export type ContextValue = string;
- export interface CreateConfigurationSetRequest {
- /**
- * The name to use for the new configuration set.
- */
- ConfigurationSetName: ConfigurationSetName;
- /**
- * An array of key and value pair tags that's associated with the new configuration set.
- */
- Tags?: TagList;
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- }
- export interface CreateConfigurationSetResult {
- /**
- * The Amazon Resource Name (ARN) of the newly created configuration set.
- */
- ConfigurationSetArn?: String;
- /**
- * The name of the new configuration set.
- */
- ConfigurationSetName?: ConfigurationSetName;
- /**
- * An array of key and value pair tags that's associated with the configuration set.
- */
- Tags?: TagList;
- /**
- * The time when the configuration set was created, in UNIX epoch time format.
- */
- CreatedTimestamp?: Timestamp;
- }
- export interface CreateEventDestinationRequest {
- /**
- * Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
- */
- ConfigurationSetName: ConfigurationSetNameOrArn;
- /**
- * The name that identifies the event destination.
- */
- EventDestinationName: EventDestinationName;
- /**
- * An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type. The TEXT_SENT event type is not supported.
- */
- MatchingEventTypes: EventTypeList;
- /**
- * An object that contains information about an event destination for logging to Amazon CloudWatch Logs.
- */
- CloudWatchLogsDestination?: CloudWatchLogsDestination;
- /**
- * An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
- */
- KinesisFirehoseDestination?: KinesisFirehoseDestination;
- /**
- * An object that contains information about an event destination for logging to Amazon SNS.
- */
- SnsDestination?: SnsDestination;
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- }
- export interface CreateEventDestinationResult {
- /**
- * The ARN of the configuration set.
- */
- ConfigurationSetArn?: String;
- /**
- * The name of the configuration set.
- */
- ConfigurationSetName?: ConfigurationSetName;
- /**
- * The details of the destination where events are logged.
- */
- EventDestination?: EventDestination;
- }
- export interface CreateOptOutListRequest {
- /**
- * The name of the new OptOutList.
- */
- OptOutListName: OptOutListName;
- /**
- * An array of tags (key and value pairs) to associate with the new OptOutList.
- */
- Tags?: TagList;
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- }
- export interface CreateOptOutListResult {
- /**
- * The Amazon Resource Name (ARN) for the OptOutList.
- */
- OptOutListArn?: String;
- /**
- * The name of the new OptOutList.
- */
- OptOutListName?: OptOutListName;
- /**
- * An array of tags (key and value pairs) associated with the new OptOutList.
- */
- Tags?: TagList;
- /**
- * The time when the pool was created, in UNIX epoch time format.
- */
- CreatedTimestamp?: Timestamp;
- }
- export interface CreatePoolRequest {
- /**
- * The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
- */
- OriginationIdentity: PhoneOrSenderIdOrArn;
- /**
- * The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageType: MessageType;
- /**
- * By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.
- */
- DeletionProtectionEnabled?: Boolean;
- /**
- * An array of tags (key and value pairs) associated with the pool.
- */
- Tags?: TagList;
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- }
- export interface CreatePoolResult {
- /**
- * The Amazon Resource Name (ARN) for the pool.
- */
- PoolArn?: String;
- /**
- * The unique identifier for the pool.
- */
- PoolId?: String;
- /**
- * The current status of the pool. CREATING: The pool is currently being created and isn't yet available for use. ACTIVE: The pool is active and available for use. DELETING: The pool is being deleted.
- */
- Status?: PoolStatus;
- /**
- * The type of message for the pool to use.
- */
- MessageType?: MessageType;
- /**
- * By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- */
- TwoWayEnabled?: PrimitiveBoolean;
- /**
- * The Amazon Resource Name (ARN) of the two way channel.
- */
- TwoWayChannelArn?: TwoWayChannelArn;
- /**
- * An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- */
- TwoWayChannelRole?: IamRoleArn;
- /**
- * By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- */
- SelfManagedOptOutsEnabled?: PrimitiveBoolean;
- /**
- * The name of the OptOutList associated with the pool.
- */
- OptOutListName?: OptOutListName;
- /**
- * Indicates whether shared routes are enabled for the pool.
- */
- SharedRoutesEnabled?: PrimitiveBoolean;
- /**
- * When set to true deletion protection is enabled. By default this is set to false.
- */
- DeletionProtectionEnabled?: PrimitiveBoolean;
- /**
- * An array of tags (key and value pairs) associated with the pool.
- */
- Tags?: TagList;
- /**
- * The time when the pool was created, in UNIX epoch time format.
- */
- CreatedTimestamp?: Timestamp;
- }
- export interface CreateProtectConfigurationRequest {
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- /**
- * When set to true deletion protection is enabled. By default this is set to false.
- */
- DeletionProtectionEnabled?: Boolean;
- /**
- * An array of key and value pair tags that are associated with the resource.
- */
- Tags?: TagList;
- }
- export interface CreateProtectConfigurationResult {
- /**
- * The Amazon Resource Name (ARN) of the protect configuration.
- */
- ProtectConfigurationArn: ProtectConfigurationArn;
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationId;
- /**
- * The time when the protect configuration was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- /**
- * This is true if the protect configuration is set as your account default protect configuration.
- */
- AccountDefault: PrimitiveBoolean;
- /**
- * When set to true deletion protection is enabled. By default this is set to false.
- */
- DeletionProtectionEnabled: PrimitiveBoolean;
- /**
- * An array of key and value pair tags that are associated with the resource.
- */
- Tags?: TagList;
- }
- export interface CreateRegistrationAssociationRequest {
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: RegistrationIdOrArn;
- /**
- * The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
- */
- ResourceId: ResourceIdOrArn;
- }
- export interface CreateRegistrationAssociationResult {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationType: RegistrationType;
- /**
- * The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
- */
- ResourceArn: String;
- /**
- * The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
- */
- ResourceId: String;
- /**
- * The registration type or origination identity type.
- */
- ResourceType: String;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode?: IsoCountryCode;
- /**
- * The phone number associated with the registration in E.164 format.
- */
- PhoneNumber?: PhoneNumber;
- }
- export interface CreateRegistrationAttachmentRequest {
- /**
- * The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.
- */
- AttachmentBody?: AttachmentBody;
- /**
- * A URL to the required registration file. For example, you can provide the S3 object URL.
- */
- AttachmentUrl?: AttachmentUrl;
- /**
- * An array of tags (key and value pairs) to associate with the registration attachment.
- */
- Tags?: TagList;
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- }
- export interface CreateRegistrationAttachmentResult {
- /**
- * The Amazon Resource Name (ARN) for the registration attachment.
- */
- RegistrationAttachmentArn: String;
- /**
- * The unique identifier for the registration attachment.
- */
- RegistrationAttachmentId: String;
- /**
- * The status of the registration attachment. UPLOAD_IN_PROGRESS The attachment is being uploaded. UPLOAD_COMPLETE The attachment has been uploaded. UPLOAD_FAILED The attachment failed to uploaded. DELETED The attachment has been deleted..
- */
- AttachmentStatus: AttachmentStatus;
- /**
- * An array of tags (key and value pairs) to associate with the registration attachment.
- */
- Tags?: TagList;
- /**
- * The time when the registration attachment was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export interface CreateRegistrationRequest {
- /**
- * The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationType: RegistrationType;
- /**
- * An array of tags (key and value pairs) to associate with the registration.
- */
- Tags?: TagList;
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- }
- export interface CreateRegistrationResult {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationType: RegistrationType;
- /**
- * The status of the registration. CREATED: Your registration is created but not submitted. SUBMITTED: Your registration has been submitted and is awaiting review. REVIEWING: Your registration has been accepted and is being reviewed. PROVISIONING: Your registration has been approved and your origination identity is being created. COMPLETE: Your registration has been approved and and your origination identity has been created. REQUIRES_UPDATES: You must fix your registration and resubmit it. CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. DELETED: The registration has been deleted.
- */
- RegistrationStatus: RegistrationStatus;
- /**
- * The current version number of the registration.
- */
- CurrentVersionNumber: RegistrationVersionNumber;
- /**
- * Metadata about a given registration which is specific to that registration type.
- */
- AdditionalAttributes?: StringMap;
- /**
- * An array of tags (key and value pairs) to associate with the registration.
- */
- Tags?: TagList;
- /**
- * The time when the registration was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export interface CreateRegistrationVersionRequest {
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: RegistrationIdOrArn;
- }
- export interface CreateRegistrationVersionResult {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * The new version number of the registration.
- */
- VersionNumber: RegistrationVersionNumber;
- /**
- * The status of the registration. DRAFT: The initial status of a registration version after it’s created. SUBMITTED: Your registration has been submitted. REVIEWING: Your registration has been accepted and is being reviewed. APPROVED: Your registration has been approved. DISCARDED: You've abandon this version of their registration to start over with a new version. DENIED: You must fix your registration and resubmit it. REVOKED: Your previously approved registration has been revoked. ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
- */
- RegistrationVersionStatus: RegistrationVersionStatus;
- /**
- * A RegistrationVersionStatusHistory object that contains timestamps for the registration.
- */
- RegistrationVersionStatusHistory: RegistrationVersionStatusHistory;
- }
- export interface CreateVerifiedDestinationNumberRequest {
- /**
- * The verified destination phone number, in E.164 format.
- */
- DestinationPhoneNumber: PhoneNumber;
- /**
- * An array of tags (key and value pairs) to associate with the destination number.
- */
- Tags?: TagList;
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- }
- export interface CreateVerifiedDestinationNumberResult {
- /**
- * The Amazon Resource Name (ARN) for the verified destination phone number.
- */
- VerifiedDestinationNumberArn: String;
- /**
- * The unique identifier for the verified destination phone number.
- */
- VerifiedDestinationNumberId: String;
- /**
- * The verified destination phone number, in E.164 format.
- */
- DestinationPhoneNumber: PhoneNumber;
- /**
- * The status of the verified destination phone number. PENDING: The phone number hasn't been verified yet. VERIFIED: The phone number is verified and can receive messages.
- */
- Status: VerificationStatus;
- /**
- * An array of tags (key and value pairs) to associate with the destination number.
- */
- Tags?: TagList;
- /**
- * The time when the verified phone number was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export interface DeleteAccountDefaultProtectConfigurationRequest {
- }
- export interface DeleteAccountDefaultProtectConfigurationResult {
- /**
- * The Amazon Resource Name (ARN) of the account default protect configuration.
- */
- DefaultProtectConfigurationArn: ProtectConfigurationArn;
- /**
- * The unique identifier of the account default protect configuration.
- */
- DefaultProtectConfigurationId: ProtectConfigurationId;
- }
- export interface DeleteConfigurationSetRequest {
- /**
- * The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
- */
- ConfigurationSetName: ConfigurationSetNameOrArn;
- }
- export interface DeleteConfigurationSetResult {
- /**
- * The Amazon Resource Name (ARN) of the deleted configuration set.
- */
- ConfigurationSetArn?: String;
- /**
- * The name of the deleted configuration set.
- */
- ConfigurationSetName?: ConfigurationSetName;
- /**
- * An array of any EventDestination objects that were associated with the deleted configuration set.
- */
- EventDestinations?: EventDestinationList;
- /**
- * The default message type of the configuration set that was deleted.
- */
- DefaultMessageType?: MessageType;
- /**
- * The default Sender ID of the configuration set that was deleted.
- */
- DefaultSenderId?: SenderId;
- /**
- * The time that the deleted configuration set was created in UNIX epoch time format.
- */
- CreatedTimestamp?: Timestamp;
- }
- export interface DeleteDefaultMessageTypeRequest {
- /**
- * The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
- */
- ConfigurationSetName: ConfigurationSetNameOrArn;
- }
- export interface DeleteDefaultMessageTypeResult {
- /**
- * The Amazon Resource Name (ARN) of the configuration set.
- */
- ConfigurationSetArn?: String;
- /**
- * The name of the configuration set.
- */
- ConfigurationSetName?: ConfigurationSetName;
- /**
- * The current message type for the configuration set.
- */
- MessageType?: MessageType;
- }
- export interface DeleteDefaultSenderIdRequest {
- /**
- * The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
- */
- ConfigurationSetName: ConfigurationSetNameOrArn;
- }
- export interface DeleteDefaultSenderIdResult {
- /**
- * The Amazon Resource Name (ARN) of the configuration set.
- */
- ConfigurationSetArn?: String;
- /**
- * The name of the configuration set.
- */
- ConfigurationSetName?: ConfigurationSetName;
- /**
- * The current sender ID for the configuration set.
- */
- SenderId?: SenderId;
- }
- export interface DeleteEventDestinationRequest {
- /**
- * The name of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
- */
- ConfigurationSetName: ConfigurationSetNameOrArn;
- /**
- * The name of the event destination to delete.
- */
- EventDestinationName: EventDestinationName;
- }
- export interface DeleteEventDestinationResult {
- /**
- * The Amazon Resource Name (ARN) of the configuration set.
- */
- ConfigurationSetArn?: String;
- /**
- * The name of the configuration set the event destination was deleted from.
- */
- ConfigurationSetName?: ConfigurationSetName;
- /**
- * The event destination object that was deleted.
- */
- EventDestination?: EventDestination;
- }
- export interface DeleteKeywordRequest {
- /**
- * The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.
- */
- OriginationIdentity: PhoneOrPoolIdOrArn;
- /**
- * The keyword to delete.
- */
- Keyword: Keyword;
- }
- export interface DeleteKeywordResult {
- /**
- * The PhoneNumberArn or PoolArn that the keyword was associated with.
- */
- OriginationIdentityArn?: String;
- /**
- * The PhoneNumberId or PoolId that the keyword was associated with.
- */
- OriginationIdentity?: String;
- /**
- * The keyword that was deleted.
- */
- Keyword?: Keyword;
- /**
- * The message that was associated with the deleted keyword.
- */
- KeywordMessage?: KeywordMessage;
- /**
- * The action that was associated with the deleted keyword.
- */
- KeywordAction?: KeywordAction;
- }
- export interface DeleteMediaMessageSpendLimitOverrideRequest {
- }
- export interface DeleteMediaMessageSpendLimitOverrideResult {
- /**
- * The current monthly limit, in US dollars.
- */
- MonthlyLimit?: MonthlyLimit;
- }
- export interface DeleteOptOutListRequest {
- /**
- * The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
- */
- OptOutListName: OptOutListNameOrArn;
- }
- export interface DeleteOptOutListResult {
- /**
- * The Amazon Resource Name (ARN) of the OptOutList that was removed.
- */
- OptOutListArn?: String;
- /**
- * The name of the OptOutList that was removed.
- */
- OptOutListName?: OptOutListName;
- /**
- * The time when the OptOutList was created, in UNIX epoch time format.
- */
- CreatedTimestamp?: Timestamp;
- }
- export interface DeleteOptedOutNumberRequest {
- /**
- * The OptOutListName or OptOutListArn to remove the phone number from.
- */
- OptOutListName: OptOutListNameOrArn;
- /**
- * The phone number, in E.164 format, to remove from the OptOutList.
- */
- OptedOutNumber: PhoneNumber;
- }
- export interface DeleteOptedOutNumberResult {
- /**
- * The OptOutListArn that the phone number was removed from.
- */
- OptOutListArn?: String;
- /**
- * The OptOutListName that the phone number was removed from.
- */
- OptOutListName?: OptOutListName;
- /**
- * The phone number that was removed from the OptOutList.
- */
- OptedOutNumber?: PhoneNumber;
- /**
- * The time that the number was removed at, in UNIX epoch time format.
- */
- OptedOutTimestamp?: Timestamp;
- /**
- * This is true if it was the end user who requested their phone number be removed.
- */
- EndUserOptedOut?: PrimitiveBoolean;
- }
- export interface DeletePoolRequest {
- /**
- * The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
- */
- PoolId: PoolIdOrArn;
- }
- export interface DeletePoolResult {
- /**
- * The Amazon Resource Name (ARN) of the pool that was deleted.
- */
- PoolArn?: String;
- /**
- * The PoolId of the pool that was deleted.
- */
- PoolId?: String;
- /**
- * The current status of the pool. CREATING: The pool is currently being created and isn't yet available for use. ACTIVE: The pool is active and available for use. DELETING: The pool is being deleted.
- */
- Status?: PoolStatus;
- /**
- * The message type that was associated with the deleted pool.
- */
- MessageType?: MessageType;
- /**
- * By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- */
- TwoWayEnabled?: PrimitiveBoolean;
- /**
- * The Amazon Resource Name (ARN) of the TwoWayChannel.
- */
- TwoWayChannelArn?: TwoWayChannelArn;
- /**
- * An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- */
- TwoWayChannelRole?: IamRoleArn;
- /**
- * By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- */
- SelfManagedOptOutsEnabled?: PrimitiveBoolean;
- /**
- * The name of the OptOutList that was associated with the deleted pool.
- */
- OptOutListName?: OptOutListName;
- /**
- * Indicates whether shared routes are enabled for the pool.
- */
- SharedRoutesEnabled?: PrimitiveBoolean;
- /**
- * The time when the pool was created, in UNIX epoch time format.
- */
- CreatedTimestamp?: Timestamp;
- }
- export interface DeleteProtectConfigurationRequest {
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationIdOrArn;
- }
- export interface DeleteProtectConfigurationResult {
- /**
- * The Amazon Resource Name (ARN) of the protect configuration.
- */
- ProtectConfigurationArn: ProtectConfigurationArn;
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationId;
- /**
- * The time when the protect configuration was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- /**
- * This is true if the protect configuration is set as your account default protect configuration.
- */
- AccountDefault: PrimitiveBoolean;
- /**
- * The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
- */
- DeletionProtectionEnabled: PrimitiveBoolean;
- }
- export interface DeleteRegistrationAttachmentRequest {
- /**
- * The unique identifier for the registration attachment.
- */
- RegistrationAttachmentId: RegistrationAttachmentIdOrArn;
- }
- export interface DeleteRegistrationAttachmentResult {
- /**
- * The Amazon Resource Name (ARN) for the registration attachment.
- */
- RegistrationAttachmentArn: String;
- /**
- * The unique identifier for the registration attachment.
- */
- RegistrationAttachmentId: String;
- /**
- * The status of the registration attachment. UPLOAD_IN_PROGRESS The attachment is being uploaded. UPLOAD_COMPLETE The attachment has been uploaded. UPLOAD_FAILED The attachment failed to uploaded. DELETED The attachment has been deleted..
- */
- AttachmentStatus: AttachmentStatus;
- /**
- * The error message if the upload failed.
- */
- AttachmentUploadErrorReason?: AttachmentUploadErrorReason;
- /**
- * The time when the registration attachment was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export interface DeleteRegistrationFieldValueRequest {
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: RegistrationIdOrArn;
- /**
- * The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
- */
- FieldPath: FieldPath;
- }
- export interface DeleteRegistrationFieldValueResult {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * The version number of the registration.
- */
- VersionNumber: RegistrationVersionNumber;
- /**
- * The path to the registration form field.
- */
- FieldPath: FieldPath;
- /**
- * An array of values for the form field.
- */
- SelectChoices?: SelectChoiceList;
- /**
- * The text data for a free form field.
- */
- TextValue?: TextValue;
- /**
- * The unique identifier for the registration attachment.
- */
- RegistrationAttachmentId?: String;
- }
- export interface DeleteRegistrationRequest {
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: RegistrationIdOrArn;
- }
- export interface DeleteRegistrationResult {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationType: RegistrationType;
- /**
- * The status of the registration. CREATED: Your registration is created but not submitted. SUBMITTED: Your registration has been submitted and is awaiting review. REVIEWING: Your registration has been accepted and is being reviewed. PROVISIONING: Your registration has been approved and your origination identity is being created. COMPLETE: Your registration has been approved and and your origination identity has been created. REQUIRES_UPDATES: You must fix your registration and resubmit it. CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. DELETED: The registration has been deleted.
- */
- RegistrationStatus: RegistrationStatus;
- /**
- * The current version number of the registration.
- */
- CurrentVersionNumber: RegistrationVersionNumber;
- /**
- * The version number of the registration that was approved.
- */
- ApprovedVersionNumber?: RegistrationVersionNumber;
- /**
- * The latest version number of the registration that was denied.
- */
- LatestDeniedVersionNumber?: RegistrationVersionNumber;
- /**
- * Metadata about a given registration which is specific to that registration type.
- */
- AdditionalAttributes?: StringMap;
- /**
- * The time when the registration was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export interface DeleteTextMessageSpendLimitOverrideRequest {
- }
- export interface DeleteTextMessageSpendLimitOverrideResult {
- /**
- * The current monthly limit, in US dollars.
- */
- MonthlyLimit?: MonthlyLimit;
- }
- export interface DeleteVerifiedDestinationNumberRequest {
- /**
- * The unique identifier for the verified destination phone number.
- */
- VerifiedDestinationNumberId: VerifiedDestinationNumberIdOrArn;
- }
- export interface DeleteVerifiedDestinationNumberResult {
- /**
- * The Amazon Resource Name (ARN) for the verified destination phone number.
- */
- VerifiedDestinationNumberArn: String;
- /**
- * The unique identifier for the verified destination phone number.
- */
- VerifiedDestinationNumberId: String;
- /**
- * The verified destination phone number, in E.164 format.
- */
- DestinationPhoneNumber: PhoneNumber;
- /**
- * The time when the destination phone number was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export interface DeleteVoiceMessageSpendLimitOverrideRequest {
- }
- export interface DeleteVoiceMessageSpendLimitOverrideResult {
- /**
- * The current monthly limit, in US dollars.
- */
- MonthlyLimit?: MonthlyLimit;
- }
- export type DeliveryStreamArn = string;
- export interface DescribeAccountAttributesRequest {
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeAccountAttributesResult {
- /**
- * An array of AccountAttributes objects.
- */
- AccountAttributes?: AccountAttributeList;
- /**
- * The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- */
- NextToken?: NextToken;
- }
- export interface DescribeAccountLimitsRequest {
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeAccountLimitsResult {
- /**
- * An array of AccountLimit objects that show the current spend limits.
- */
- AccountLimits?: AccountLimitList;
- /**
- * The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- */
- NextToken?: NextToken;
- }
- export interface DescribeConfigurationSetsRequest {
- /**
- * An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
- */
- ConfigurationSetNames?: ConfigurationSetNameList;
- /**
- * An array of filters to apply to the results that are returned.
- */
- Filters?: ConfigurationSetFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeConfigurationSetsResult {
- /**
- * An array of ConfigurationSets objects.
- */
- ConfigurationSets?: ConfigurationSetInformationList;
- /**
- * The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- */
- NextToken?: NextToken;
- }
- export interface DescribeKeywordsRequest {
- /**
- * The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
- */
- OriginationIdentity: PhoneOrPoolIdOrArn;
- /**
- * An array of keywords to search for.
- */
- Keywords?: KeywordList;
- /**
- * An array of keyword filters to filter the results.
- */
- Filters?: KeywordFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeKeywordsResult {
- /**
- * The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
- */
- OriginationIdentityArn?: String;
- /**
- * The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
- */
- OriginationIdentity?: String;
- /**
- * An array of KeywordInformation objects that contain the results.
- */
- Keywords?: KeywordInformationList;
- /**
- * The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- */
- NextToken?: NextToken;
- }
- export interface DescribeOptOutListsRequest {
- /**
- * The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
- */
- OptOutListNames?: OptOutListNameList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeOptOutListsResult {
- /**
- * An array of OptOutListInformation objects that contain the details for the requested OptOutLists.
- */
- OptOutLists?: OptOutListInformationList;
- /**
- * The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- */
- NextToken?: NextToken;
- }
- export interface DescribeOptedOutNumbersRequest {
- /**
- * The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
- */
- OptOutListName: OptOutListNameOrArn;
- /**
- * An array of phone numbers to search for in the OptOutList.
- */
- OptedOutNumbers?: OptedOutNumberList;
- /**
- * An array of OptedOutFilter objects to filter the results on.
- */
- Filters?: OptedOutFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeOptedOutNumbersResult {
- /**
- * The Amazon Resource Name (ARN) of the OptOutList.
- */
- OptOutListArn?: String;
- /**
- * The name of the OptOutList.
- */
- OptOutListName?: OptOutListName;
- /**
- * An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
- */
- OptedOutNumbers?: OptedOutNumberInformationList;
- /**
- * The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- */
- NextToken?: NextToken;
- }
- export interface DescribePhoneNumbersRequest {
- /**
- * The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
- */
- PhoneNumberIds?: PhoneNumberIdList;
- /**
- * An array of PhoneNumberFilter objects to filter the results.
- */
- Filters?: PhoneNumberFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribePhoneNumbersResult {
- /**
- * An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
- */
- PhoneNumbers?: PhoneNumberInformationList;
- /**
- * The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- */
- NextToken?: NextToken;
- }
- export interface DescribePoolsRequest {
- /**
- * The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
- */
- PoolIds?: PoolIdList;
- /**
- * An array of PoolFilter objects to filter the results.
- */
- Filters?: PoolFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribePoolsResult {
- /**
- * An array of PoolInformation objects that contain the details for the requested pools.
- */
- Pools?: PoolInformationList;
- /**
- * The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- */
- NextToken?: NextToken;
- }
- export interface DescribeProtectConfigurationsRequest {
- /**
- * An array of protect configuration identifiers to search for.
- */
- ProtectConfigurationIds?: ProtectConfigurationIdList;
- /**
- * An array of ProtectConfigurationFilter objects to filter the results.
- */
- Filters?: ProtectConfigurationFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeProtectConfigurationsResult {
- /**
- * An array of ProtectConfigurationInformation objects that contain the details for the request.
- */
- ProtectConfigurations?: ProtectConfigurationInformationList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- }
- export interface DescribeRegistrationAttachmentsRequest {
- /**
- * The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.
- */
- RegistrationAttachmentIds?: RegistrationAttachmentIdList;
- /**
- * An array of RegistrationAttachmentFilter objects to filter the results.
- */
- Filters?: RegistrationAttachmentFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeRegistrationAttachmentsResult {
- /**
- * An array of RegistrationAttachments objects that contain the details for the requested registration attachments.
- */
- RegistrationAttachments: RegistrationAttachmentsInformationList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- }
- export interface DescribeRegistrationFieldDefinitionsRequest {
- /**
- * The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationType: RegistrationType;
- /**
- * The path to the section of the registration.
- */
- SectionPath?: SectionPath;
- /**
- * An array of paths to the registration form field.
- */
- FieldPaths?: FieldPathList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeRegistrationFieldDefinitionsResult {
- /**
- * The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationType: RegistrationType;
- /**
- * An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.
- */
- RegistrationFieldDefinitions: RegistrationFieldDefinitionList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- }
- export interface DescribeRegistrationFieldValuesRequest {
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: RegistrationIdOrArn;
- /**
- * The version number of the registration.
- */
- VersionNumber?: RegistrationVersionNumber;
- /**
- * The path to the section of the registration.
- */
- SectionPath?: SectionPath;
- /**
- * An array of paths to the registration form field.
- */
- FieldPaths?: FieldPathList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeRegistrationFieldValuesResult {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * The current version of the registration.
- */
- VersionNumber: RegistrationVersionNumber;
- /**
- * An array of RegistrationFieldValues objects that contain the values for the requested registration.
- */
- RegistrationFieldValues: RegistrationFieldValueInformationList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- }
- export interface DescribeRegistrationSectionDefinitionsRequest {
- /**
- * The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationType: RegistrationType;
- /**
- * An array of paths for the registration form section.
- */
- SectionPaths?: SectionPathList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeRegistrationSectionDefinitionsResult {
- /**
- * The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationType: RegistrationType;
- /**
- * An array of RegistrationSectionDefinition objects.
- */
- RegistrationSectionDefinitions: RegistrationSectionDefinitionList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- }
- export interface DescribeRegistrationTypeDefinitionsRequest {
- /**
- * The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationTypes?: RegistrationTypeList;
- /**
- * An array of RegistrationFilter objects to filter the results.
- */
- Filters?: RegistrationTypeFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeRegistrationTypeDefinitionsResult {
- /**
- * The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationTypeDefinitions: RegistrationTypeDefinitionList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- }
- export interface DescribeRegistrationVersionsRequest {
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: RegistrationIdOrArn;
- /**
- * An array of registration version numbers.
- */
- VersionNumbers?: RegistrationVersionNumberList;
- /**
- * An array of RegistrationVersionFilter objects to filter the results.
- */
- Filters?: RegistrationVersionFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeRegistrationVersionsResult {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * An array of RegistrationVersions objects.
- */
- RegistrationVersions: RegistrationVersionInformationList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- }
- export interface DescribeRegistrationsRequest {
- /**
- * An array of unique identifiers for each registration.
- */
- RegistrationIds?: RegistrationIdList;
- /**
- * An array of RegistrationFilter objects to filter the results.
- */
- Filters?: RegistrationFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeRegistrationsResult {
- /**
- * An array of RegistrationInformation objects.
- */
- Registrations: RegistrationInformationList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- }
- export interface DescribeSenderIdsRequest {
- /**
- * An array of SenderIdAndCountry objects to search for.
- */
- SenderIds?: SenderIdList;
- /**
- * An array of SenderIdFilter objects to filter the results.
- */
- Filters?: SenderIdFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeSenderIdsResult {
- /**
- * An array of SernderIdInformation objects that contain the details for the requested SenderIds.
- */
- SenderIds?: SenderIdInformationList;
- /**
- * The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- */
- NextToken?: NextToken;
- }
- export interface DescribeSpendLimitsRequest {
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeSpendLimitsResult {
- /**
- * An array of SpendLimit objects that contain the details for the requested spend limits.
- */
- SpendLimits?: SpendLimitList;
- /**
- * The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- */
- NextToken?: NextToken;
- }
- export interface DescribeVerifiedDestinationNumbersRequest {
- /**
- * An array of VerifiedDestinationNumberid to retreive.
- */
- VerifiedDestinationNumberIds?: VerifiedDestinationNumberIdList;
- /**
- * An array of verified destination phone number, in E.164 format.
- */
- DestinationPhoneNumbers?: DestinationPhoneNumberList;
- /**
- * An array of VerifiedDestinationNumberFilter objects to filter the results.
- */
- Filters?: VerifiedDestinationNumberFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeVerifiedDestinationNumbersResult {
- /**
- * An array of VerifiedDestinationNumberInformation objects
- */
- VerifiedDestinationNumbers: VerifiedDestinationNumberInformationList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- }
- export type DestinationCountryParameterKey = "IN_TEMPLATE_ID"|"IN_ENTITY_ID"|string;
- export type DestinationCountryParameterValue = string;
- export type DestinationCountryParameters = {[key: string]: DestinationCountryParameterValue};
- export type DestinationPhoneNumberList = PhoneNumber[];
- export interface DisassociateOriginationIdentityRequest {
- /**
- * The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
- */
- PoolId: PoolIdOrArn;
- /**
- * The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.
- */
- OriginationIdentity: PhoneOrSenderIdOrArn;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- }
- export interface DisassociateOriginationIdentityResult {
- /**
- * The Amazon Resource Name (ARN) of the pool.
- */
- PoolArn?: String;
- /**
- * The PoolId of the pool no longer associated with the origination identity.
- */
- PoolId?: String;
- /**
- * The PhoneNumberArn or SenderIdArn of the origination identity.
- */
- OriginationIdentityArn?: String;
- /**
- * The PhoneNumberId or SenderId of the origination identity.
- */
- OriginationIdentity?: String;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode?: IsoCountryCode;
- }
- export interface DisassociateProtectConfigurationRequest {
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationIdOrArn;
- /**
- * The name of the ConfigurationSet.
- */
- ConfigurationSetName: ConfigurationSetNameOrArn;
- }
- export interface DisassociateProtectConfigurationResult {
- /**
- * The Amazon Resource Name (ARN) of the configuration set.
- */
- ConfigurationSetArn: String;
- /**
- * The name of the ConfigurationSet.
- */
- ConfigurationSetName: ConfigurationSetName;
- /**
- * The Amazon Resource Name (ARN) of the protect configuration.
- */
- ProtectConfigurationArn: ProtectConfigurationArn;
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationId;
- }
- export interface DiscardRegistrationVersionRequest {
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: RegistrationIdOrArn;
- }
- export interface DiscardRegistrationVersionResult {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * The version number of the registration.
- */
- VersionNumber: RegistrationVersionNumber;
- /**
- * The status of the registration version. DRAFT: The initial status of a registration version after it’s created. SUBMITTED: Your registration has been submitted. REVIEWING: Your registration has been accepted and is being reviewed. APPROVED: Your registration has been approved. DISCARDED: You've abandon this version of their registration to start over with a new version. DENIED: You must fix your registration and resubmit it. REVOKED: Your previously approved registration has been revoked. ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
- */
- RegistrationVersionStatus: RegistrationVersionStatus;
- /**
- * The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
- */
- RegistrationVersionStatusHistory: RegistrationVersionStatusHistory;
- }
- export interface EventDestination {
- /**
- * The name of the EventDestination.
- */
- EventDestinationName: EventDestinationName;
- /**
- * When set to true events will be logged.
- */
- Enabled: Boolean;
- /**
- * An array of event types that determine which events to log. The TEXT_SENT event type is not supported.
- */
- MatchingEventTypes: EventTypeList;
- /**
- * An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
- */
- CloudWatchLogsDestination?: CloudWatchLogsDestination;
- /**
- * An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
- */
- KinesisFirehoseDestination?: KinesisFirehoseDestination;
- /**
- * An object that contains information about an event destination that sends logging events to Amazon SNS.
- */
- SnsDestination?: SnsDestination;
- }
- export type EventDestinationList = EventDestination[];
- export type EventDestinationName = string;
- export type EventType = "ALL"|"TEXT_ALL"|"TEXT_SENT"|"TEXT_PENDING"|"TEXT_QUEUED"|"TEXT_SUCCESSFUL"|"TEXT_DELIVERED"|"TEXT_INVALID"|"TEXT_INVALID_MESSAGE"|"TEXT_UNREACHABLE"|"TEXT_CARRIER_UNREACHABLE"|"TEXT_BLOCKED"|"TEXT_CARRIER_BLOCKED"|"TEXT_SPAM"|"TEXT_UNKNOWN"|"TEXT_TTL_EXPIRED"|"VOICE_ALL"|"VOICE_INITIATED"|"VOICE_RINGING"|"VOICE_ANSWERED"|"VOICE_COMPLETED"|"VOICE_BUSY"|"VOICE_NO_ANSWER"|"VOICE_FAILED"|"VOICE_TTL_EXPIRED"|"MEDIA_ALL"|"MEDIA_PENDING"|"MEDIA_QUEUED"|"MEDIA_SUCCESSFUL"|"MEDIA_DELIVERED"|"MEDIA_INVALID"|"MEDIA_INVALID_MESSAGE"|"MEDIA_UNREACHABLE"|"MEDIA_CARRIER_UNREACHABLE"|"MEDIA_BLOCKED"|"MEDIA_CARRIER_BLOCKED"|"MEDIA_SPAM"|"MEDIA_UNKNOWN"|"MEDIA_TTL_EXPIRED"|"MEDIA_FILE_INACCESSIBLE"|"MEDIA_FILE_TYPE_UNSUPPORTED"|"MEDIA_FILE_SIZE_EXCEEDED"|string;
- export type EventTypeList = EventType[];
- export type FieldPath = string;
- export type FieldPathList = FieldPath[];
- export type FieldRequirement = "REQUIRED"|"CONDITIONAL"|"OPTIONAL"|string;
- export type FieldType = "SELECT"|"TEXT"|"ATTACHMENT"|string;
- export type FilterValue = string;
- export type FilterValueList = FilterValue[];
- export interface GetProtectConfigurationCountryRuleSetRequest {
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationIdOrArn;
- /**
- * The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS.
- */
- NumberCapability: NumberCapability;
- }
- export interface GetProtectConfigurationCountryRuleSetResult {
- /**
- * The Amazon Resource Name (ARN) of the protect configuration.
- */
- ProtectConfigurationArn: ProtectConfigurationArn;
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationId;
- /**
- * The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects.
- */
- NumberCapability: NumberCapability;
- /**
- * A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.
- */
- CountryRuleSet: ProtectConfigurationCountryRuleSet;
- }
- export type IamRoleArn = string;
- export type Integer = number;
- export type IsoCountryCode = string;
- export type Keyword = string;
- export type KeywordAction = "AUTOMATIC_RESPONSE"|"OPT_OUT"|"OPT_IN"|string;
- export interface KeywordFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: KeywordFilterName;
- /**
- * An array values to filter for.
- */
- Values: FilterValueList;
- }
- export type KeywordFilterList = KeywordFilter[];
- export type KeywordFilterName = "keyword-action"|string;
- export interface KeywordInformation {
- /**
- * The keyword as a string.
- */
- Keyword: Keyword;
- /**
- * A custom message that can be used with the keyword.
- */
- KeywordMessage: KeywordMessage;
- /**
- * The action to perform for the keyword.
- */
- KeywordAction: KeywordAction;
- }
- export type KeywordInformationList = KeywordInformation[];
- export type KeywordList = Keyword[];
- export type KeywordMessage = string;
- export interface KinesisFirehoseDestination {
- /**
- * The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis Data Firehose destination.
- */
- IamRoleArn: IamRoleArn;
- /**
- * The Amazon Resource Name (ARN) of the delivery stream.
- */
- DeliveryStreamArn: DeliveryStreamArn;
- }
- export type LanguageCode = "DE_DE"|"EN_GB"|"EN_US"|"ES_419"|"ES_ES"|"FR_CA"|"FR_FR"|"IT_IT"|"JA_JP"|"KO_KR"|"PT_BR"|"ZH_CN"|"ZH_TW"|string;
- export interface ListPoolOriginationIdentitiesRequest {
- /**
- * The unique identifier for the pool. This value can be either the PoolId or PoolArn.
- */
- PoolId: PoolIdOrArn;
- /**
- * An array of PoolOriginationIdentitiesFilter objects to filter the results..
- */
- Filters?: PoolOriginationIdentitiesFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface ListPoolOriginationIdentitiesResult {
- /**
- * The Amazon Resource Name (ARN) for the pool.
- */
- PoolArn?: String;
- /**
- * The unique PoolId of the pool.
- */
- PoolId?: String;
- /**
- * An array of any OriginationIdentityMetadata objects.
- */
- OriginationIdentities?: OriginationIdentityMetadataList;
- /**
- * The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- */
- NextToken?: NextToken;
- }
- export interface ListRegistrationAssociationsRequest {
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: RegistrationIdOrArn;
- /**
- * An array of RegistrationAssociationFilter to apply to the results that are returned.
- */
- Filters?: RegistrationAssociationFilterList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return per each request.
- */
- MaxResults?: MaxResults;
- }
- export interface ListRegistrationAssociationsResult {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationType: RegistrationType;
- /**
- * An array of RegistrationAssociationMetadata objects.
- */
- RegistrationAssociations: RegistrationAssociationMetadataList;
- /**
- * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- */
- NextToken?: NextToken;
- }
- export interface ListTagsForResourceRequest {
- /**
- * The Amazon Resource Name (ARN) of the resource to query for.
- */
- ResourceArn: AmazonResourceName;
- }
- export interface ListTagsForResourceResult {
- /**
- * The ARN of the resource.
- */
- ResourceArn?: AmazonResourceName;
- /**
- * An array of key and value pair tags that are associated with the resource.
- */
- Tags?: TagList;
- }
- export type LogGroupArn = string;
- export type MaxPrice = string;
- export type MaxResults = number;
- export type MediaMessageOriginationIdentity = string;
- export type MediaUrlList = MediaUrlValue[];
- export type MediaUrlValue = string;
- export type MessageType = "TRANSACTIONAL"|"PROMOTIONAL"|string;
- export type MessageTypeList = MessageType[];
- export type MonthlyLimit = number;
- export type NextToken = string;
- export type NonEmptyTagList = Tag[];
- export type NumberCapability = "SMS"|"VOICE"|"MMS"|string;
- export type NumberCapabilityList = NumberCapability[];
- export type NumberStatus = "PENDING"|"ACTIVE"|"ASSOCIATING"|"DISASSOCIATING"|"DELETED"|string;
- export type NumberType = "SHORT_CODE"|"LONG_CODE"|"TOLL_FREE"|"TEN_DLC"|"SIMULATOR"|string;
- export interface OptOutListInformation {
- /**
- * The Amazon Resource Name (ARN) of the OptOutList.
- */
- OptOutListArn: String;
- /**
- * The name of the OptOutList.
- */
- OptOutListName: OptOutListName;
- /**
- * The time when the OutOutList was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export type OptOutListInformationList = OptOutListInformation[];
- export type OptOutListName = string;
- export type OptOutListNameList = OptOutListNameOrArn[];
- export type OptOutListNameOrArn = string;
- export interface OptedOutFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: OptedOutFilterName;
- /**
- * An array of values to filter for.
- */
- Values: FilterValueList;
- }
- export type OptedOutFilterList = OptedOutFilter[];
- export type OptedOutFilterName = "end-user-opted-out"|string;
- export interface OptedOutNumberInformation {
- /**
- * The phone number that is opted out.
- */
- OptedOutNumber: PhoneNumber;
- /**
- * The time that the op tout occurred, in UNIX epoch time format.
- */
- OptedOutTimestamp: Timestamp;
- /**
- * This is set to true if it was the end recipient that opted out.
- */
- EndUserOptedOut: PrimitiveBoolean;
- }
- export type OptedOutNumberInformationList = OptedOutNumberInformation[];
- export type OptedOutNumberList = PhoneNumber[];
- export interface OriginationIdentityMetadata {
- /**
- * The Amazon Resource Name (ARN) associated with the origination identity.
- */
- OriginationIdentityArn: String;
- /**
- * The unique identifier of the origination identity.
- */
- OriginationIdentity: String;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * Describes if the origination identity can be used for text messages, voice calls or both.
- */
- NumberCapabilities: NumberCapabilityList;
- /**
- * The phone number in E.164 format.
- */
- PhoneNumber?: PhoneNumber;
- }
- export type OriginationIdentityMetadataList = OriginationIdentityMetadata[];
- export type PhoneNumber = string;
- export interface PhoneNumberFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: PhoneNumberFilterName;
- /**
- * An array values to filter for.
- */
- Values: FilterValueList;
- }
- export type PhoneNumberFilterList = PhoneNumberFilter[];
- export type PhoneNumberFilterName = "status"|"iso-country-code"|"message-type"|"number-capability"|"number-type"|"two-way-enabled"|"self-managed-opt-outs-enabled"|"opt-out-list-name"|"deletion-protection-enabled"|"two-way-channel-arn"|string;
- export type PhoneNumberIdList = PhoneNumberIdOrArn[];
- export type PhoneNumberIdOrArn = string;
- export interface PhoneNumberInformation {
- /**
- * The Amazon Resource Name (ARN) associated with the phone number.
- */
- PhoneNumberArn: String;
- /**
- * The unique identifier for the phone number.
- */
- PhoneNumberId?: String;
- /**
- * The phone number in E.164 format.
- */
- PhoneNumber: PhoneNumber;
- /**
- * The current status of the phone number.
- */
- Status: NumberStatus;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageType: MessageType;
- /**
- * Describes if the origination identity can be used for text messages, voice calls or both.
- */
- NumberCapabilities: NumberCapabilityList;
- /**
- * The type of phone number.
- */
- NumberType: NumberType;
- /**
- * The price, in US dollars, to lease the phone number.
- */
- MonthlyLeasingPrice: String;
- /**
- * By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
- */
- TwoWayEnabled: PrimitiveBoolean;
- /**
- * The Amazon Resource Name (ARN) of the two way channel.
- */
- TwoWayChannelArn?: TwoWayChannelArn;
- /**
- * An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- */
- TwoWayChannelRole?: IamRoleArn;
- /**
- * When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
- */
- SelfManagedOptOutsEnabled: PrimitiveBoolean;
- /**
- * The name of the OptOutList associated with the phone number.
- */
- OptOutListName: OptOutListName;
- /**
- * When set to true the phone number can't be deleted.
- */
- DeletionProtectionEnabled: PrimitiveBoolean;
- /**
- * The unique identifier of the pool associated with the phone number.
- */
- PoolId?: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId?: String;
- /**
- * The time when the phone number was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export type PhoneNumberInformationList = PhoneNumberInformation[];
- export type PhoneOrPoolIdOrArn = string;
- export type PhoneOrSenderIdOrArn = string;
- export interface PoolFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: PoolFilterName;
- /**
- * An array values to filter for.
- */
- Values: FilterValueList;
- }
- export type PoolFilterList = PoolFilter[];
- export type PoolFilterName = "status"|"message-type"|"two-way-enabled"|"self-managed-opt-outs-enabled"|"opt-out-list-name"|"shared-routes-enabled"|"deletion-protection-enabled"|"two-way-channel-arn"|string;
- export type PoolIdList = PoolIdOrArn[];
- export type PoolIdOrArn = string;
- export interface PoolInformation {
- /**
- * The Amazon Resource Name (ARN) for the pool.
- */
- PoolArn: String;
- /**
- * The unique identifier for the pool.
- */
- PoolId: String;
- /**
- * The current status of the pool.
- */
- Status: PoolStatus;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageType: MessageType;
- /**
- * When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
- */
- TwoWayEnabled: PrimitiveBoolean;
- /**
- * The Amazon Resource Name (ARN) of the two way channel.
- */
- TwoWayChannelArn?: TwoWayChannelArn;
- /**
- * An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- */
- TwoWayChannelRole?: IamRoleArn;
- /**
- * When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs
- */
- SelfManagedOptOutsEnabled: PrimitiveBoolean;
- /**
- * The name of the OptOutList associated with the pool.
- */
- OptOutListName: OptOutListName;
- /**
- * Allows you to enable shared routes on your pool. By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.
- */
- SharedRoutesEnabled: PrimitiveBoolean;
- /**
- * When set to true the pool can't be deleted.
- */
- DeletionProtectionEnabled: PrimitiveBoolean;
- /**
- * The time when the pool was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export type PoolInformationList = PoolInformation[];
- export interface PoolOriginationIdentitiesFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: PoolOriginationIdentitiesFilterName;
- /**
- * An array values to filter for.
- */
- Values: FilterValueList;
- }
- export type PoolOriginationIdentitiesFilterList = PoolOriginationIdentitiesFilter[];
- export type PoolOriginationIdentitiesFilterName = "iso-country-code"|"number-capability"|string;
- export type PoolStatus = "CREATING"|"ACTIVE"|"DELETING"|string;
- export type PrimitiveBoolean = boolean;
- export type PrimitiveLong = number;
- export type ProtectConfigurationArn = string;
- export type ProtectConfigurationCountryRuleSet = {[key: string]: ProtectConfigurationCountryRuleSetInformation};
- export interface ProtectConfigurationCountryRuleSetInformation {
- /**
- * The types of protection that can be used.
- */
- ProtectStatus: ProtectStatus;
- }
- export interface ProtectConfigurationFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: ProtectConfigurationFilterName;
- /**
- * An array of values to filter for.
- */
- Values: FilterValueList;
- }
- export type ProtectConfigurationFilterList = ProtectConfigurationFilter[];
- export type ProtectConfigurationFilterName = "account-default"|"deletion-protection-enabled"|string;
- export type ProtectConfigurationId = string;
- export type ProtectConfigurationIdList = ProtectConfigurationIdOrArn[];
- export type ProtectConfigurationIdOrArn = string;
- export interface ProtectConfigurationInformation {
- /**
- * The Amazon Resource Name (ARN) of the protect configuration.
- */
- ProtectConfigurationArn: ProtectConfigurationArn;
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationId;
- /**
- * The time when the protect configuration was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- /**
- * This is true if the protect configuration is set as your account default protect configuration.
- */
- AccountDefault: PrimitiveBoolean;
- /**
- * The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
- */
- DeletionProtectionEnabled: PrimitiveBoolean;
- }
- export type ProtectConfigurationInformationList = ProtectConfigurationInformation[];
- export type ProtectStatus = "ALLOW"|"BLOCK"|string;
- export interface PutKeywordRequest {
- /**
- * The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
- */
- OriginationIdentity: PhoneOrPoolIdOrArn;
- /**
- * The new keyword to add.
- */
- Keyword: Keyword;
- /**
- * The message associated with the keyword.
- */
- KeywordMessage: KeywordMessage;
- /**
- * The action to perform for the new keyword when it is received. AUTOMATIC_RESPONSE: A message is sent to the recipient. OPT_OUT: Keeps the recipient from receiving future messages. OPT_IN: The recipient wants to receive future messages.
- */
- KeywordAction?: KeywordAction;
- }
- export interface PutKeywordResult {
- /**
- * The PhoneNumberArn or PoolArn that the keyword was associated with.
- */
- OriginationIdentityArn?: String;
- /**
- * The PhoneNumberId or PoolId that the keyword was associated with.
- */
- OriginationIdentity?: String;
- /**
- * The keyword that was added.
- */
- Keyword?: Keyword;
- /**
- * The message associated with the keyword.
- */
- KeywordMessage?: KeywordMessage;
- /**
- * The action to perform when the keyword is used.
- */
- KeywordAction?: KeywordAction;
- }
- export interface PutOptedOutNumberRequest {
- /**
- * The OptOutListName or OptOutListArn to add the phone number to.
- */
- OptOutListName: OptOutListNameOrArn;
- /**
- * The phone number to add to the OptOutList in E.164 format.
- */
- OptedOutNumber: PhoneNumber;
- }
- export interface PutOptedOutNumberResult {
- /**
- * The OptOutListArn that the phone number was removed from.
- */
- OptOutListArn?: String;
- /**
- * The OptOutListName that the phone number was removed from.
- */
- OptOutListName?: OptOutListName;
- /**
- * The phone number that was added to the OptOutList.
- */
- OptedOutNumber?: PhoneNumber;
- /**
- * The time that the phone number was added to the OptOutList, in UNIX epoch time format.
- */
- OptedOutTimestamp?: Timestamp;
- /**
- * This is true if it was the end user who requested their phone number be removed.
- */
- EndUserOptedOut?: PrimitiveBoolean;
- }
- export interface PutRegistrationFieldValueRequest {
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: RegistrationIdOrArn;
- /**
- * The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
- */
- FieldPath: FieldPath;
- /**
- * An array of values for the form field.
- */
- SelectChoices?: SelectChoiceList;
- /**
- * The text data for a free form field.
- */
- TextValue?: TextValue;
- /**
- * The unique identifier for the registration attachment.
- */
- RegistrationAttachmentId?: RegistrationAttachmentIdOrArn;
- }
- export interface PutRegistrationFieldValueResult {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * The version number of the registration.
- */
- VersionNumber: RegistrationVersionNumber;
- /**
- * The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
- */
- FieldPath: FieldPath;
- /**
- * An array of values for the form field.
- */
- SelectChoices?: SelectChoiceList;
- /**
- * The text data for a free form field.
- */
- TextValue?: TextValue;
- /**
- * The unique identifier for the registration attachment.
- */
- RegistrationAttachmentId?: String;
- }
- export type RegistrationAssociationBehavior = "ASSOCIATE_BEFORE_SUBMIT"|"ASSOCIATE_ON_APPROVAL"|"ASSOCIATE_AFTER_COMPLETE"|string;
- export interface RegistrationAssociationFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: RegistrationAssociationFilterName;
- /**
- * An array of values to filter for.
- */
- Values: FilterValueList;
- }
- export type RegistrationAssociationFilterList = RegistrationAssociationFilter[];
- export type RegistrationAssociationFilterName = "resource-type"|"iso-country-code"|string;
- export interface RegistrationAssociationMetadata {
- /**
- * The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
- */
- ResourceArn: String;
- /**
- * The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
- */
- ResourceId: String;
- /**
- * The origination identity type.
- */
- ResourceType: String;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode?: IsoCountryCode;
- /**
- * The phone number associated with the registration in E.164 format.
- */
- PhoneNumber?: PhoneNumber;
- }
- export type RegistrationAssociationMetadataList = RegistrationAssociationMetadata[];
- export interface RegistrationAttachmentFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: RegistrationAttachmentFilterName;
- /**
- * An array of values to filter on.
- */
- Values: FilterValueList;
- }
- export type RegistrationAttachmentFilterList = RegistrationAttachmentFilter[];
- export type RegistrationAttachmentFilterName = "attachment-status"|string;
- export type RegistrationAttachmentIdList = RegistrationIdOrArn[];
- export type RegistrationAttachmentIdOrArn = string;
- export interface RegistrationAttachmentsInformation {
- /**
- * The Amazon Resource Name (ARN) for the registration attachment.
- */
- RegistrationAttachmentArn: String;
- /**
- * The unique identifier for the registration attachment.
- */
- RegistrationAttachmentId: String;
- /**
- * The status of the registration attachment. UPLOAD_IN_PROGRESS The attachment is being uploaded. UPLOAD_COMPLETE The attachment has been uploaded. UPLOAD_FAILED The attachment failed to uploaded. DELETED The attachment has been deleted..
- */
- AttachmentStatus: AttachmentStatus;
- /**
- * A description of why the upload didn't successfully complete.
- */
- AttachmentUploadErrorReason?: AttachmentUploadErrorReason;
- /**
- * The time when the registration attachment was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export type RegistrationAttachmentsInformationList = RegistrationAttachmentsInformation[];
- export interface RegistrationDeniedReasonInformation {
- /**
- * The reason a registration was rejected.
- */
- Reason: String;
- /**
- * A short description of the rejection reason.
- */
- ShortDescription: String;
- /**
- * A long description of the rejection reason.
- */
- LongDescription?: String;
- /**
- * The title of the document.
- */
- DocumentationTitle?: String;
- /**
- * The link to the document.
- */
- DocumentationLink?: String;
- }
- export type RegistrationDeniedReasonInformationList = RegistrationDeniedReasonInformation[];
- export type RegistrationDisassociationBehavior = "DISASSOCIATE_ALL_CLOSES_REGISTRATION"|"DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION"|"DELETE_REGISTRATION_DISASSOCIATES"|string;
- export interface RegistrationFieldDefinition {
- /**
- * The section path of the field.
- */
- SectionPath: SectionPath;
- /**
- * The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
- */
- FieldPath: FieldPath;
- /**
- * The type of field.
- */
- FieldType: FieldType;
- /**
- * Specifies if the field for the registration form is required, conditional or optional.
- */
- FieldRequirement: FieldRequirement;
- /**
- * The validation rules for a select field.
- */
- SelectValidation?: SelectValidation;
- /**
- * The validation rules for a text field.
- */
- TextValidation?: TextValidation;
- /**
- * An array of RegistrationFieldDisplayHints objects for the field.
- */
- DisplayHints: RegistrationFieldDisplayHints;
- }
- export type RegistrationFieldDefinitionList = RegistrationFieldDefinition[];
- export interface RegistrationFieldDisplayHints {
- /**
- * The title of the display hint.
- */
- Title: String;
- /**
- * A short description of the display hint.
- */
- ShortDescription: String;
- /**
- * A full description of the display hint.
- */
- LongDescription?: String;
- /**
- * The title of the document the display hint is associated with.
- */
- DocumentationTitle?: String;
- /**
- * The link to the document the display hint is associated with.
- */
- DocumentationLink?: String;
- /**
- * An array of SelectOptionDescription objects.
- */
- SelectOptionDescriptions?: SelectOptionDescriptionsList;
- /**
- * The validation rules for the text field.
- */
- TextValidationDescription?: String;
- /**
- * Example text of what the value of a field should contain.
- */
- ExampleTextValue?: String;
- }
- export interface RegistrationFieldValueInformation {
- /**
- * The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
- */
- FieldPath: FieldPath;
- /**
- * An array of values for the form field.
- */
- SelectChoices?: SelectChoiceList;
- /**
- * The text data for a free form field.
- */
- TextValue?: TextValue;
- /**
- * The unique identifier for the registration attachment.
- */
- RegistrationAttachmentId?: RegistrationAttachmentIdOrArn;
- /**
- * A description of why the registration was denied.
- */
- DeniedReason?: String;
- }
- export type RegistrationFieldValueInformationList = RegistrationFieldValueInformation[];
- export interface RegistrationFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: RegistrationFilterName;
- /**
- * An array of values to filter on.
- */
- Values: FilterValueList;
- }
- export type RegistrationFilterList = RegistrationFilter[];
- export type RegistrationFilterName = "registration-type"|"registration-status"|string;
- export type RegistrationIdList = RegistrationIdOrArn[];
- export type RegistrationIdOrArn = string;
- export interface RegistrationInformation {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationType: RegistrationType;
- /**
- * The status of the registration. CREATED: Your registration is created but not submitted. SUBMITTED: Your registration has been submitted and is awaiting review. REVIEWING: Your registration has been accepted and is being reviewed. PROVISIONING: Your registration has been approved and your origination identity is being created. COMPLETE: Your registration has been approved and and your origination identity has been created. REQUIRES_UPDATES: You must fix your registration and resubmit it. CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. DELETED: The registration has been deleted.
- */
- RegistrationStatus: RegistrationStatus;
- /**
- * The current version number of the registration.
- */
- CurrentVersionNumber: RegistrationVersionNumber;
- /**
- * The version number of the registration that was approved.
- */
- ApprovedVersionNumber?: RegistrationVersionNumber;
- /**
- * The latest version number of the registration that was denied.
- */
- LatestDeniedVersionNumber?: RegistrationVersionNumber;
- /**
- * Metadata about a given registration which is specific to that registration type.
- */
- AdditionalAttributes?: StringMap;
- /**
- * The time when the registration was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export type RegistrationInformationList = RegistrationInformation[];
- export interface RegistrationSectionDefinition {
- /**
- * The path to the section of the registration.
- */
- SectionPath: SectionPath;
- /**
- * The path to the section of the registration.
- */
- DisplayHints: RegistrationSectionDisplayHints;
- }
- export type RegistrationSectionDefinitionList = RegistrationSectionDefinition[];
- export interface RegistrationSectionDisplayHints {
- /**
- * The title of the display hint.
- */
- Title: String;
- /**
- * A short description of the display hint.
- */
- ShortDescription: String;
- /**
- * A full description of the display hint.
- */
- LongDescription?: String;
- /**
- * The title of the document the display hint is associated with.
- */
- DocumentationTitle?: String;
- /**
- * The link to the document the display hint is associated with.
- */
- DocumentationLink?: String;
- }
- export type RegistrationStatus = "CREATED"|"SUBMITTED"|"REVIEWING"|"PROVISIONING"|"COMPLETE"|"REQUIRES_UPDATES"|"CLOSED"|"DELETED"|string;
- export type RegistrationType = string;
- export interface RegistrationTypeDefinition {
- /**
- * The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- */
- RegistrationType: RegistrationType;
- /**
- * The supported association behavior for the registration type.
- */
- SupportedAssociations?: SupportedAssociationList;
- /**
- * Provides help information on the registration.
- */
- DisplayHints: RegistrationTypeDisplayHints;
- }
- export type RegistrationTypeDefinitionList = RegistrationTypeDefinition[];
- export interface RegistrationTypeDisplayHints {
- /**
- * The title of the display hint.
- */
- Title: String;
- /**
- * A short description of the display hint.
- */
- ShortDescription?: String;
- /**
- * A full description of the display hint.
- */
- LongDescription?: String;
- /**
- * The title of the document the display hint is associated with.
- */
- DocumentationTitle?: String;
- /**
- * The link to the document the display hint is associated with.
- */
- DocumentationLink?: String;
- }
- export interface RegistrationTypeFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: RegistrationTypeFilterName;
- /**
- * An array of values to filter on.
- */
- Values: FilterValueList;
- }
- export type RegistrationTypeFilterList = RegistrationTypeFilter[];
- export type RegistrationTypeFilterName = "supported-association-resource-type"|"supported-association-iso-country-code"|string;
- export type RegistrationTypeList = RegistrationType[];
- export interface RegistrationVersionFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: RegistrationVersionFilterName;
- /**
- * An array of values to filter on.
- */
- Values: FilterValueList;
- }
- export type RegistrationVersionFilterList = RegistrationVersionFilter[];
- export type RegistrationVersionFilterName = "registration-version-status"|string;
- export interface RegistrationVersionInformation {
- /**
- * The version number of the registration.
- */
- VersionNumber: RegistrationVersionNumber;
- /**
- * The status of the registration. DRAFT: The initial status of a registration version after it’s created. SUBMITTED: Your registration has been submitted. REVIEWING: Your registration has been accepted and is being reviewed. APPROVED: Your registration has been approved. DISCARDED: You've abandon this version of their registration to start over with a new version. DENIED: You must fix your registration and resubmit it. REVOKED: Your previously approved registration has been revoked. ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
- */
- RegistrationVersionStatus: RegistrationVersionStatus;
- /**
- * The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
- */
- RegistrationVersionStatusHistory: RegistrationVersionStatusHistory;
- /**
- * An array of RegistrationDeniedReasonInformation objects.
- */
- DeniedReasons?: RegistrationDeniedReasonInformationList;
- }
- export type RegistrationVersionInformationList = RegistrationVersionInformation[];
- export type RegistrationVersionNumber = number;
- export type RegistrationVersionNumberList = RegistrationVersionNumber[];
- export type RegistrationVersionStatus = "DRAFT"|"SUBMITTED"|"REVIEWING"|"APPROVED"|"DISCARDED"|"DENIED"|"REVOKED"|"ARCHIVED"|string;
- export interface RegistrationVersionStatusHistory {
- /**
- * The time when the registration was in the draft state, in UNIX epoch time format.
- */
- DraftTimestamp: Timestamp;
- /**
- * The time when the registration was in the submitted state, in UNIX epoch time format.
- */
- SubmittedTimestamp?: Timestamp;
- /**
- * The time when the registration was in the reviewing state, in UNIX epoch time format.
- */
- ReviewingTimestamp?: Timestamp;
- /**
- * The time when the registration was in the approved state, in UNIX epoch time format.
- */
- ApprovedTimestamp?: Timestamp;
- /**
- * The time when the registration was in the discarded state, in UNIX epoch time format.
- */
- DiscardedTimestamp?: Timestamp;
- /**
- * The time when the registration was in the denied state, in UNIX epoch time format.
- */
- DeniedTimestamp?: Timestamp;
- /**
- * The time when the registration was in the revoked state, in UNIX epoch time format.
- */
- RevokedTimestamp?: Timestamp;
- /**
- * The time when the registration was in the archived state, in UNIX epoch time format.
- */
- ArchivedTimestamp?: Timestamp;
- }
- export interface ReleasePhoneNumberRequest {
- /**
- * The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
- */
- PhoneNumberId: PhoneNumberIdOrArn;
- }
- export interface ReleasePhoneNumberResult {
- /**
- * The PhoneNumberArn of the phone number that was released.
- */
- PhoneNumberArn?: String;
- /**
- * The PhoneNumberId of the phone number that was released.
- */
- PhoneNumberId?: String;
- /**
- * The phone number that was released.
- */
- PhoneNumber?: PhoneNumber;
- /**
- * The current status of the request.
- */
- Status?: NumberStatus;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode?: IsoCountryCode;
- /**
- * The message type that was associated with the phone number.
- */
- MessageType?: MessageType;
- /**
- * Specifies if the number could be used for text messages, voice, or both.
- */
- NumberCapabilities?: NumberCapabilityList;
- /**
- * The type of number that was released.
- */
- NumberType?: NumberType;
- /**
- * The monthly price of the phone number, in US dollars.
- */
- MonthlyLeasingPrice?: String;
- /**
- * By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- */
- TwoWayEnabled?: PrimitiveBoolean;
- /**
- * The Amazon Resource Name (ARN) of the TwoWayChannel.
- */
- TwoWayChannelArn?: TwoWayChannelArn;
- /**
- * An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- */
- TwoWayChannelRole?: IamRoleArn;
- /**
- * By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- */
- SelfManagedOptOutsEnabled?: PrimitiveBoolean;
- /**
- * The name of the OptOutList that was associated with the phone number.
- */
- OptOutListName?: OptOutListName;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId?: String;
- /**
- * The time when the phone number was created, in UNIX epoch time format.
- */
- CreatedTimestamp?: Timestamp;
- }
- export interface ReleaseSenderIdRequest {
- /**
- * The sender ID to release.
- */
- SenderId: SenderIdOrArn;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- }
- export interface ReleaseSenderIdResult {
- /**
- * The Amazon Resource Name (ARN) associated with the SenderId.
- */
- SenderIdArn: String;
- /**
- * The sender ID that was released.
- */
- SenderId: SenderId;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageTypes: MessageTypeList;
- /**
- * The monthly price, in US dollars, to lease the sender ID.
- */
- MonthlyLeasingPrice: String;
- /**
- * True if the sender ID is registered.
- */
- Registered: PrimitiveBoolean;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId?: String;
- }
- export interface RequestPhoneNumberRequest {
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageType: MessageType;
- /**
- * Indicates if the phone number will be used for text messages, voice messages, or both.
- */
- NumberCapabilities: NumberCapabilityList;
- /**
- * The type of phone number to request.
- */
- NumberType: RequestableNumberType;
- /**
- * The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
- */
- OptOutListName?: OptOutListNameOrArn;
- /**
- * The pool to associated with the phone number. You can use the PoolId or PoolArn.
- */
- PoolId?: PoolIdOrArn;
- /**
- * Use this field to attach your phone number for an external registration process.
- */
- RegistrationId?: RegistrationIdOrArn;
- /**
- * By default this is set to false. When set to true the phone number can't be deleted.
- */
- DeletionProtectionEnabled?: Boolean;
- /**
- * An array of tags (key and value pairs) associate with the requested phone number.
- */
- Tags?: TagList;
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- }
- export interface RequestPhoneNumberResult {
- /**
- * The Amazon Resource Name (ARN) of the requested phone number.
- */
- PhoneNumberArn?: String;
- /**
- * The unique identifier of the new phone number.
- */
- PhoneNumberId?: String;
- /**
- * The new phone number that was requested.
- */
- PhoneNumber?: PhoneNumber;
- /**
- * The current status of the request.
- */
- Status?: NumberStatus;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode?: IsoCountryCode;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageType?: MessageType;
- /**
- * Indicates if the phone number will be used for text messages, voice messages or both.
- */
- NumberCapabilities?: NumberCapabilityList;
- /**
- * The type of number that was released.
- */
- NumberType?: RequestableNumberType;
- /**
- * The monthly price, in US dollars, to lease the phone number.
- */
- MonthlyLeasingPrice?: String;
- /**
- * By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- */
- TwoWayEnabled?: PrimitiveBoolean;
- /**
- * The ARN used to identify the two way channel.
- */
- TwoWayChannelArn?: TwoWayChannelArn;
- /**
- * An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- */
- TwoWayChannelRole?: IamRoleArn;
- /**
- * By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- */
- SelfManagedOptOutsEnabled?: PrimitiveBoolean;
- /**
- * The name of the OptOutList that is associated with the requested phone number.
- */
- OptOutListName?: OptOutListName;
- /**
- * By default this is set to false. When set to true the phone number can't be deleted.
- */
- DeletionProtectionEnabled?: PrimitiveBoolean;
- /**
- * The unique identifier of the pool associated with the phone number
- */
- PoolId?: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId?: String;
- /**
- * An array of key and value pair tags that are associated with the phone number.
- */
- Tags?: TagList;
- /**
- * The time when the phone number was created, in UNIX epoch time format.
- */
- CreatedTimestamp?: Timestamp;
- }
- export interface RequestSenderIdRequest {
- /**
- * The sender ID string to request.
- */
- SenderId: SenderId;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageTypes?: MessageTypeList;
- /**
- * By default this is set to false. When set to true the sender ID can't be deleted.
- */
- DeletionProtectionEnabled?: Boolean;
- /**
- * An array of tags (key and value pairs) to associate with the sender ID.
- */
- Tags?: TagList;
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- */
- ClientToken?: ClientToken;
- }
- export interface RequestSenderIdResult {
- /**
- * The Amazon Resource Name (ARN) associated with the SenderId.
- */
- SenderIdArn: String;
- /**
- * The sender ID that was requested.
- */
- SenderId: SenderId;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageTypes: MessageTypeList;
- /**
- * The monthly price, in US dollars, to lease the sender ID.
- */
- MonthlyLeasingPrice: String;
- /**
- * By default this is set to false. When set to true the sender ID can't be deleted.
- */
- DeletionProtectionEnabled: PrimitiveBoolean;
- /**
- * True if the sender ID is registered.
- */
- Registered: PrimitiveBoolean;
- /**
- * An array of tags (key and value pairs) to associate with the sender ID.
- */
- Tags?: TagList;
- }
- export type RequestableNumberType = "LONG_CODE"|"TOLL_FREE"|"TEN_DLC"|"SIMULATOR"|string;
- export type ResourceIdOrArn = string;
- export type SectionPath = string;
- export type SectionPathList = SectionPath[];
- export type SelectChoice = string;
- export type SelectChoiceList = SelectChoice[];
- export interface SelectOptionDescription {
- /**
- * The value of the option.
- */
- Option: String;
- /**
- * The title of the select option.
- */
- Title?: String;
- /**
- * A description of the option meaning.
- */
- Description?: String;
- }
- export type SelectOptionDescriptionsList = SelectOptionDescription[];
- export interface SelectValidation {
- /**
- * The minimum number of choices for the select.
- */
- MinChoices: Integer;
- /**
- * The maximum number of choices for the select.
- */
- MaxChoices: Integer;
- /**
- * An array of strings for the possible selection options.
- */
- Options: StringList;
- }
- export interface SendDestinationNumberVerificationCodeRequest {
- /**
- * The unique identifier for the verified destination phone number.
- */
- VerifiedDestinationNumberId: VerifiedDestinationNumberIdOrArn;
- /**
- * Choose to send the verification code as an SMS or voice message.
- */
- VerificationChannel: VerificationChannel;
- /**
- * Choose the language to use for the message.
- */
- LanguageCode?: LanguageCode;
- /**
- * The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
- */
- OriginationIdentity?: VerificationMessageOriginationIdentity;
- /**
- * The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
- */
- ConfigurationSetName?: ConfigurationSetNameOrArn;
- /**
- * You can specify custom data in this field. If you do, that data is logged to the event destination.
- */
- Context?: ContextMap;
- /**
- * This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
- */
- DestinationCountryParameters?: DestinationCountryParameters;
- }
- export interface SendDestinationNumberVerificationCodeResult {
- /**
- * The unique identifier for the message.
- */
- MessageId: String;
- }
- export interface SendMediaMessageRequest {
- /**
- * The destination phone number in E.164 format.
- */
- DestinationPhoneNumber: PhoneNumber;
- /**
- * The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
- */
- OriginationIdentity: MediaMessageOriginationIdentity;
- /**
- * The text body of the message.
- */
- MessageBody?: TextMessageBody;
- /**
- * An array of URLs to each media file to send. The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
- */
- MediaUrls?: MediaUrlList;
- /**
- * The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
- */
- ConfigurationSetName?: ConfigurationSetNameOrArn;
- /**
- * The maximum amount that you want to spend, in US dollars, per each MMS message.
- */
- MaxPrice?: MaxPrice;
- /**
- * How long the text message is valid for. By default this is 72 hours.
- */
- TimeToLive?: TimeToLive;
- /**
- * You can specify custom data in this field. If you do, that data is logged to the event destination.
- */
- Context?: ContextMap;
- /**
- * When set to true, the message is checked and validated, but isn't sent to the end recipient.
- */
- DryRun?: PrimitiveBoolean;
- /**
- * The unique identifier of the protect configuration to use.
- */
- ProtectConfigurationId?: ProtectConfigurationIdOrArn;
- }
- export interface SendMediaMessageResult {
- /**
- * The unique identifier for the message.
- */
- MessageId?: String;
- }
- export interface SendTextMessageRequest {
- /**
- * The destination phone number in E.164 format.
- */
- DestinationPhoneNumber: PhoneNumber;
- /**
- * The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
- */
- OriginationIdentity?: TextMessageOriginationIdentity;
- /**
- * The body of the text message.
- */
- MessageBody?: TextMessageBody;
- /**
- * The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageType?: MessageType;
- /**
- * When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
- */
- Keyword?: Keyword;
- /**
- * The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
- */
- ConfigurationSetName?: ConfigurationSetNameOrArn;
- /**
- * The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
- */
- MaxPrice?: MaxPrice;
- /**
- * How long the text message is valid for. By default this is 72 hours.
- */
- TimeToLive?: TimeToLive;
- /**
- * You can specify custom data in this field. If you do, that data is logged to the event destination.
- */
- Context?: ContextMap;
- /**
- * This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
- */
- DestinationCountryParameters?: DestinationCountryParameters;
- /**
- * When set to true, the message is checked and validated, but isn't sent to the end recipient.
- */
- DryRun?: PrimitiveBoolean;
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId?: ProtectConfigurationIdOrArn;
- }
- export interface SendTextMessageResult {
- /**
- * The unique identifier for the message.
- */
- MessageId?: String;
- }
- export interface SendVoiceMessageRequest {
- /**
- * The destination phone number in E.164 format.
- */
- DestinationPhoneNumber: PhoneNumber;
- /**
- * The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
- */
- OriginationIdentity: VoiceMessageOriginationIdentity;
- /**
- * The text to convert to a voice message.
- */
- MessageBody?: VoiceMessageBody;
- /**
- * Specifies if the MessageBody field contains text or speech synthesis markup language (SSML). TEXT: This is the default value. When used the maximum character limit is 3000. SSML: When used the maximum character limit is 6000 including SSML tagging.
- */
- MessageBodyTextType?: VoiceMessageBodyTextType;
- /**
- * The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
- */
- VoiceId?: VoiceId;
- /**
- * The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
- */
- ConfigurationSetName?: ConfigurationSetNameOrArn;
- /**
- * The maximum amount to spend per voice message, in US dollars.
- */
- MaxPricePerMinute?: MaxPrice;
- /**
- * How long the voice message is valid for. By default this is 72 hours.
- */
- TimeToLive?: TimeToLive;
- /**
- * You can specify custom data in this field. If you do, that data is logged to the event destination.
- */
- Context?: ContextMap;
- /**
- * When set to true, the message is checked and validated, but isn't sent to the end recipient.
- */
- DryRun?: PrimitiveBoolean;
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId?: ProtectConfigurationIdOrArn;
- }
- export interface SendVoiceMessageResult {
- /**
- * The unique identifier for the message.
- */
- MessageId?: String;
- }
- export type SenderId = string;
- export interface SenderIdAndCountry {
- /**
- * The unique identifier of the sender.
- */
- SenderId: SenderIdOrArn;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- }
- export interface SenderIdFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: SenderIdFilterName;
- /**
- * An array of values to filter for.
- */
- Values: FilterValueList;
- }
- export type SenderIdFilterList = SenderIdFilter[];
- export type SenderIdFilterName = "sender-id"|"iso-country-code"|"message-type"|"deletion-protection-enabled"|"registered"|string;
- export interface SenderIdInformation {
- /**
- * The Amazon Resource Name (ARN) associated with the SenderId.
- */
- SenderIdArn: String;
- /**
- * The alphanumeric sender ID in a specific country that you'd like to describe.
- */
- SenderId: SenderId;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageTypes: MessageTypeList;
- /**
- * The monthly leasing price, in US dollars.
- */
- MonthlyLeasingPrice: String;
- /**
- * By default this is set to false. When set to true the sender ID can't be deleted.
- */
- DeletionProtectionEnabled: PrimitiveBoolean;
- /**
- * True if the sender ID is registered.
- */
- Registered: PrimitiveBoolean;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId?: String;
- }
- export type SenderIdInformationList = SenderIdInformation[];
- export type SenderIdList = SenderIdAndCountry[];
- export type SenderIdOrArn = string;
- export interface SetAccountDefaultProtectConfigurationRequest {
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationIdOrArn;
- }
- export interface SetAccountDefaultProtectConfigurationResult {
- /**
- * The Amazon Resource Name (ARN) of the account default protect configuration.
- */
- DefaultProtectConfigurationArn: ProtectConfigurationArn;
- /**
- * The unique identifier of the account default protect configuration.
- */
- DefaultProtectConfigurationId: ProtectConfigurationId;
- }
- export interface SetDefaultMessageTypeRequest {
- /**
- * The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.
- */
- ConfigurationSetName: ConfigurationSetNameOrArn;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageType: MessageType;
- }
- export interface SetDefaultMessageTypeResult {
- /**
- * The Amazon Resource Name (ARN) of the updated configuration set.
- */
- ConfigurationSetArn?: String;
- /**
- * The name of the configuration set that was updated.
- */
- ConfigurationSetName?: ConfigurationSetName;
- /**
- * The new default message type of the configuration set.
- */
- MessageType?: MessageType;
- }
- export interface SetDefaultSenderIdRequest {
- /**
- * The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.
- */
- ConfigurationSetName: ConfigurationSetNameOrArn;
- /**
- * The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'.
- */
- SenderId: SenderId;
- }
- export interface SetDefaultSenderIdResult {
- /**
- * The Amazon Resource Name (ARN) of the updated configuration set.
- */
- ConfigurationSetArn?: String;
- /**
- * The name of the configuration set that was updated.
- */
- ConfigurationSetName?: ConfigurationSetName;
- /**
- * The default sender ID to set for the ConfigurationSet.
- */
- SenderId?: SenderId;
- }
- export interface SetMediaMessageSpendLimitOverrideRequest {
- /**
- * The new monthly limit to enforce on text messages.
- */
- MonthlyLimit: MonthlyLimit;
- }
- export interface SetMediaMessageSpendLimitOverrideResult {
- /**
- * The current monthly limit to enforce on sending text messages.
- */
- MonthlyLimit?: MonthlyLimit;
- }
- export interface SetTextMessageSpendLimitOverrideRequest {
- /**
- * The new monthly limit to enforce on text messages.
- */
- MonthlyLimit: MonthlyLimit;
- }
- export interface SetTextMessageSpendLimitOverrideResult {
- /**
- * The current monthly limit to enforce on sending text messages.
- */
- MonthlyLimit?: MonthlyLimit;
- }
- export interface SetVoiceMessageSpendLimitOverrideRequest {
- /**
- * The new monthly limit to enforce on voice messages.
- */
- MonthlyLimit: MonthlyLimit;
- }
- export interface SetVoiceMessageSpendLimitOverrideResult {
- /**
- * The current monthly limit to enforce on sending voice messages.
- */
- MonthlyLimit?: MonthlyLimit;
- }
- export interface SnsDestination {
- /**
- * The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
- */
- TopicArn: SnsTopicArn;
- }
- export type SnsTopicArn = string;
- export interface SpendLimit {
- /**
- * The name for the SpendLimit.
- */
- Name: SpendLimitName;
- /**
- * The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true.
- */
- EnforcedLimit: PrimitiveLong;
- /**
- * The maximum amount of money that you are able to spend to send messages each month, in US dollars.
- */
- MaxLimit: PrimitiveLong;
- /**
- * When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.
- */
- Overridden: PrimitiveBoolean;
- }
- export type SpendLimitList = SpendLimit[];
- export type SpendLimitName = "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT"|"VOICE_MESSAGE_MONTHLY_SPEND_LIMIT"|"MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT"|string;
- export type String = string;
- export type StringList = String[];
- export type StringMap = {[key: string]: String};
- export interface SubmitRegistrationVersionRequest {
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: RegistrationIdOrArn;
- }
- export interface SubmitRegistrationVersionResult {
- /**
- * The Amazon Resource Name (ARN) for the registration.
- */
- RegistrationArn: String;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId: String;
- /**
- * The version number of the registration.
- */
- VersionNumber: RegistrationVersionNumber;
- /**
- * The status of the registration version. DRAFT: The initial status of a registration version after it’s created. SUBMITTED: Your registration has been submitted. REVIEWING: Your registration has been accepted and is being reviewed. APPROVED: Your registration has been approved. DISCARDED: You've abandon this version of their registration to start over with a new version. DENIED: You must fix your registration and resubmit it. REVOKED: Your previously approved registration has been revoked. ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
- */
- RegistrationVersionStatus: RegistrationVersionStatus;
- /**
- * The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
- */
- RegistrationVersionStatusHistory: RegistrationVersionStatusHistory;
- }
- export interface SupportedAssociation {
- /**
- * Defines the behavior of when an origination identity and registration can be associated with each other.
- */
- ResourceType: String;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode?: IsoCountryCode;
- /**
- * The association behavior. ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration. ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved. ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
- */
- AssociationBehavior: RegistrationAssociationBehavior;
- /**
- * The disassociation behavior. DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed. DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted. DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.
- */
- DisassociationBehavior: RegistrationDisassociationBehavior;
- }
- export type SupportedAssociationList = SupportedAssociation[];
- export interface Tag {
- /**
- * The key identifier, or name, of the tag.
- */
- Key: TagKey;
- /**
- * The string value associated with the key of the tag.
- */
- Value: TagValue;
- }
- export type TagKey = string;
- export type TagKeyList = TagKey[];
- export type TagList = Tag[];
- export interface TagResourceRequest {
- /**
- * The Amazon Resource Name (ARN) of the resource.
- */
- ResourceArn: AmazonResourceName;
- /**
- * An array of key and value pair tags that are associated with the resource.
- */
- Tags: NonEmptyTagList;
- }
- export interface TagResourceResult {
- }
- export type TagValue = string;
- export type TextMessageBody = string;
- export type TextMessageOriginationIdentity = string;
- export interface TextValidation {
- /**
- * The minimum number of characters for the text field.
- */
- MinLength: Integer;
- /**
- * The maximum number of characters for the text field.
- */
- MaxLength: Integer;
- /**
- * The regular expression used to validate the text field.
- */
- Pattern: String;
- }
- export type TextValue = string;
- export type TimeToLive = number;
- export type Timestamp = Date;
- export type TwoWayChannelArn = string;
- export interface UntagResourceRequest {
- /**
- * The Amazon Resource Name (ARN) of the resource.
- */
- ResourceArn: AmazonResourceName;
- /**
- * An array of tag key values to unassociate with the resource.
- */
- TagKeys: TagKeyList;
- }
- export interface UntagResourceResult {
- }
- export interface UpdateEventDestinationRequest {
- /**
- * The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.
- */
- ConfigurationSetName: ConfigurationSetNameOrArn;
- /**
- * The name to use for the event destination.
- */
- EventDestinationName: EventDestinationName;
- /**
- * When set to true logging is enabled.
- */
- Enabled?: Boolean;
- /**
- * An array of event types that determine which events to log. The TEXT_SENT event type is not supported.
- */
- MatchingEventTypes?: EventTypeList;
- /**
- * An object that contains information about an event destination that sends data to CloudWatch Logs.
- */
- CloudWatchLogsDestination?: CloudWatchLogsDestination;
- /**
- * An object that contains information about an event destination for logging to Kinesis Data Firehose.
- */
- KinesisFirehoseDestination?: KinesisFirehoseDestination;
- /**
- * An object that contains information about an event destination that sends data to Amazon SNS.
- */
- SnsDestination?: SnsDestination;
- }
- export interface UpdateEventDestinationResult {
- /**
- * The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
- */
- ConfigurationSetArn?: String;
- /**
- * The name of the configuration set.
- */
- ConfigurationSetName?: ConfigurationSetName;
- /**
- * An EventDestination object containing the details of where events will be logged.
- */
- EventDestination?: EventDestination;
- }
- export interface UpdatePhoneNumberRequest {
- /**
- * The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
- */
- PhoneNumberId: PhoneNumberIdOrArn;
- /**
- * By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- */
- TwoWayEnabled?: Boolean;
- /**
- * The Amazon Resource Name (ARN) of the two way channel.
- */
- TwoWayChannelArn?: TwoWayChannelArn;
- /**
- * An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- */
- TwoWayChannelRole?: IamRoleArn;
- /**
- * By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- */
- SelfManagedOptOutsEnabled?: Boolean;
- /**
- * The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
- */
- OptOutListName?: OptOutListNameOrArn;
- /**
- * By default this is set to false. When set to true the phone number can't be deleted.
- */
- DeletionProtectionEnabled?: Boolean;
- }
- export interface UpdatePhoneNumberResult {
- /**
- * The Amazon Resource Name (ARN) of the updated phone number.
- */
- PhoneNumberArn?: String;
- /**
- * The unique identifier of the phone number.
- */
- PhoneNumberId?: String;
- /**
- * The phone number that was updated.
- */
- PhoneNumber?: PhoneNumber;
- /**
- * The current status of the request.
- */
- Status?: NumberStatus;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode?: IsoCountryCode;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageType?: MessageType;
- /**
- * Specifies if the number could be used for text messages, voice or both.
- */
- NumberCapabilities?: NumberCapabilityList;
- /**
- * The type of number that was requested.
- */
- NumberType?: NumberType;
- /**
- * The monthly leasing price of the phone number, in US dollars.
- */
- MonthlyLeasingPrice?: String;
- /**
- * By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- */
- TwoWayEnabled?: PrimitiveBoolean;
- /**
- * The Amazon Resource Name (ARN) of the two way channel.
- */
- TwoWayChannelArn?: TwoWayChannelArn;
- /**
- * An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- */
- TwoWayChannelRole?: IamRoleArn;
- /**
- * This is true if self managed opt-out are enabled.
- */
- SelfManagedOptOutsEnabled?: PrimitiveBoolean;
- /**
- * The name of the OptOutList associated with the phone number.
- */
- OptOutListName?: OptOutListName;
- /**
- * When set to true the phone number can't be deleted.
- */
- DeletionProtectionEnabled?: PrimitiveBoolean;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId?: String;
- /**
- * The time when the phone number was created, in UNIX epoch time format.
- */
- CreatedTimestamp?: Timestamp;
- }
- export interface UpdatePoolRequest {
- /**
- * The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
- */
- PoolId: PoolIdOrArn;
- /**
- * By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- */
- TwoWayEnabled?: Boolean;
- /**
- * The Amazon Resource Name (ARN) of the two way channel.
- */
- TwoWayChannelArn?: TwoWayChannelArn;
- /**
- * An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- */
- TwoWayChannelRole?: IamRoleArn;
- /**
- * By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- */
- SelfManagedOptOutsEnabled?: Boolean;
- /**
- * The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
- */
- OptOutListName?: OptOutListNameOrArn;
- /**
- * Indicates whether shared routes are enabled for the pool.
- */
- SharedRoutesEnabled?: Boolean;
- /**
- * When set to true the pool can't be deleted.
- */
- DeletionProtectionEnabled?: Boolean;
- }
- export interface UpdatePoolResult {
- /**
- * The ARN of the pool.
- */
- PoolArn?: String;
- /**
- * The unique identifier of the pool.
- */
- PoolId?: String;
- /**
- * The current status of the pool update request.
- */
- Status?: PoolStatus;
- /**
- * The type of message for the pool to use.
- */
- MessageType?: MessageType;
- /**
- * By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- */
- TwoWayEnabled?: PrimitiveBoolean;
- /**
- * The Amazon Resource Name (ARN) of the two way channel.
- */
- TwoWayChannelArn?: TwoWayChannelArn;
- /**
- * An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- */
- TwoWayChannelRole?: IamRoleArn;
- /**
- * When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- */
- SelfManagedOptOutsEnabled?: PrimitiveBoolean;
- /**
- * The name of the OptOutList associated with the pool.
- */
- OptOutListName?: OptOutListName;
- /**
- * Indicates whether shared routes are enabled for the pool.
- */
- SharedRoutesEnabled?: PrimitiveBoolean;
- /**
- * When set to true the pool can't be deleted.
- */
- DeletionProtectionEnabled?: PrimitiveBoolean;
- /**
- * The time when the pool was created, in UNIX epoch time format.
- */
- CreatedTimestamp?: Timestamp;
- }
- export interface UpdateProtectConfigurationCountryRuleSetRequest {
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationIdOrArn;
- /**
- * The number capability to apply the CountryRuleSetUpdates updates to.
- */
- NumberCapability: NumberCapability;
- /**
- * A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.
- */
- CountryRuleSetUpdates: ProtectConfigurationCountryRuleSet;
- }
- export interface UpdateProtectConfigurationCountryRuleSetResult {
- /**
- * The Amazon Resource Name (ARN) of the protect configuration.
- */
- ProtectConfigurationArn: ProtectConfigurationArn;
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationId;
- /**
- * The number capability that was updated
- */
- NumberCapability: NumberCapability;
- /**
- * An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.
- */
- CountryRuleSet: ProtectConfigurationCountryRuleSet;
- }
- export interface UpdateProtectConfigurationRequest {
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationIdOrArn;
- /**
- * When set to true deletion protection is enabled. By default this is set to false.
- */
- DeletionProtectionEnabled?: Boolean;
- }
- export interface UpdateProtectConfigurationResult {
- /**
- * The Amazon Resource Name (ARN) of the protect configuration.
- */
- ProtectConfigurationArn: ProtectConfigurationArn;
- /**
- * The unique identifier for the protect configuration.
- */
- ProtectConfigurationId: ProtectConfigurationId;
- /**
- * The time when the protect configuration was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- /**
- * This is true if the protect configuration is set as your account default protect configuration.
- */
- AccountDefault: PrimitiveBoolean;
- /**
- * The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
- */
- DeletionProtectionEnabled: PrimitiveBoolean;
- }
- export interface UpdateSenderIdRequest {
- /**
- * The sender ID to update.
- */
- SenderId: SenderIdOrArn;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * By default this is set to false. When set to true the sender ID can't be deleted.
- */
- DeletionProtectionEnabled?: Boolean;
- }
- export interface UpdateSenderIdResult {
- /**
- * The Amazon Resource Name (ARN) associated with the SenderId.
- */
- SenderIdArn: String;
- /**
- * The sender ID that was updated.
- */
- SenderId: SenderId;
- /**
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- */
- IsoCountryCode: IsoCountryCode;
- /**
- * The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- */
- MessageTypes: MessageTypeList;
- /**
- * The monthly price, in US dollars, to lease the sender ID.
- */
- MonthlyLeasingPrice: String;
- /**
- * By default this is set to false. When set to true the sender ID can't be deleted.
- */
- DeletionProtectionEnabled: PrimitiveBoolean;
- /**
- * True if the sender ID is registered..
- */
- Registered: PrimitiveBoolean;
- /**
- * The unique identifier for the registration.
- */
- RegistrationId?: String;
- }
- export type VerificationChannel = "TEXT"|"VOICE"|string;
- export type VerificationCode = string;
- export type VerificationMessageOriginationIdentity = string;
- export type VerificationStatus = "PENDING"|"VERIFIED"|string;
- export interface VerifiedDestinationNumberFilter {
- /**
- * The name of the attribute to filter on.
- */
- Name: VerifiedDestinationNumberFilterName;
- /**
- * An array of values to filter on.
- */
- Values: FilterValueList;
- }
- export type VerifiedDestinationNumberFilterList = VerifiedDestinationNumberFilter[];
- export type VerifiedDestinationNumberFilterName = "status"|string;
- export type VerifiedDestinationNumberIdList = VerifiedDestinationNumberIdOrArn[];
- export type VerifiedDestinationNumberIdOrArn = string;
- export interface VerifiedDestinationNumberInformation {
- /**
- * The Amazon Resource Name (ARN) for the verified destination phone number.
- */
- VerifiedDestinationNumberArn: String;
- /**
- * The unique identifier for the verified destination phone number.
- */
- VerifiedDestinationNumberId: String;
- /**
- * The verified destination phone number, in E.164 format.
- */
- DestinationPhoneNumber: PhoneNumber;
- /**
- * The status of the verified destination phone number. PENDING: The phone number hasn't been verified yet. VERIFIED: The phone number is verified and can receive messages.
- */
- Status: VerificationStatus;
- /**
- * The time when the destination phone number was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export type VerifiedDestinationNumberInformationList = VerifiedDestinationNumberInformation[];
- export interface VerifyDestinationNumberRequest {
- /**
- * The unique identifier for the verififed destination phone number.
- */
- VerifiedDestinationNumberId: VerifiedDestinationNumberIdOrArn;
- /**
- * The verification code that was received by the verified destination phone number.
- */
- VerificationCode: VerificationCode;
- }
- export interface VerifyDestinationNumberResult {
- /**
- * The Amazon Resource Name (ARN) for the verified destination phone number.
- */
- VerifiedDestinationNumberArn: String;
- /**
- * The unique identifier for the verified destination phone number.
- */
- VerifiedDestinationNumberId: String;
- /**
- * The phone number in E.164 format.
- */
- DestinationPhoneNumber: PhoneNumber;
- /**
- * The status for being able to send messages to the phone number.
- */
- Status: VerificationStatus;
- /**
- * The time when the destination phone number was created, in UNIX epoch time format.
- */
- CreatedTimestamp: Timestamp;
- }
- export type VoiceId = "AMY"|"ASTRID"|"BIANCA"|"BRIAN"|"CAMILA"|"CARLA"|"CARMEN"|"CELINE"|"CHANTAL"|"CONCHITA"|"CRISTIANO"|"DORA"|"EMMA"|"ENRIQUE"|"EWA"|"FILIZ"|"GERAINT"|"GIORGIO"|"GWYNETH"|"HANS"|"INES"|"IVY"|"JACEK"|"JAN"|"JOANNA"|"JOEY"|"JUSTIN"|"KARL"|"KENDRA"|"KIMBERLY"|"LEA"|"LIV"|"LOTTE"|"LUCIA"|"LUPE"|"MADS"|"MAJA"|"MARLENE"|"MATHIEU"|"MATTHEW"|"MAXIM"|"MIA"|"MIGUEL"|"MIZUKI"|"NAJA"|"NICOLE"|"PENELOPE"|"RAVEENA"|"RICARDO"|"RUBEN"|"RUSSELL"|"SALLI"|"SEOYEON"|"TAKUMI"|"TATYANA"|"VICKI"|"VITORIA"|"ZEINA"|"ZHIYU"|string;
- export type VoiceMessageBody = string;
- export type VoiceMessageBodyTextType = "TEXT"|"SSML"|string;
- export type VoiceMessageOriginationIdentity = string;
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- export type apiVersion = "2022-03-31"|"latest"|string;
- export interface ClientApiVersions {
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- apiVersion?: apiVersion;
- }
- export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
- /**
- * Contains interfaces for use with the PinpointSMSVoiceV2 client.
- */
- export import Types = PinpointSMSVoiceV2;
- }
- export = PinpointSMSVoiceV2;
|