personalize.d.ts 187 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class Personalize extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: Personalize.Types.ClientConfiguration)
  13. config: Config & Personalize.Types.ClientConfiguration;
  14. /**
  15. * Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket. To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file. For more information, see Creating a batch inference job . If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the name of the field that contains item names in the input data. For more information about generating themes, see Batch recommendations with themes from Content Generator . You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.
  16. */
  17. createBatchInferenceJob(params: Personalize.Types.CreateBatchInferenceJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateBatchInferenceJobResponse) => void): Request<Personalize.Types.CreateBatchInferenceJobResponse, AWSError>;
  18. /**
  19. * Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket. To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file. For more information, see Creating a batch inference job . If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the name of the field that contains item names in the input data. For more information about generating themes, see Batch recommendations with themes from Content Generator . You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.
  20. */
  21. createBatchInferenceJob(callback?: (err: AWSError, data: Personalize.Types.CreateBatchInferenceJobResponse) => void): Request<Personalize.Types.CreateBatchInferenceJobResponse, AWSError>;
  22. /**
  23. * Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.
  24. */
  25. createBatchSegmentJob(params: Personalize.Types.CreateBatchSegmentJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateBatchSegmentJobResponse) => void): Request<Personalize.Types.CreateBatchSegmentJobResponse, AWSError>;
  26. /**
  27. * Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.
  28. */
  29. createBatchSegmentJob(callback?: (err: AWSError, data: Personalize.Types.CreateBatchSegmentJobResponse) => void): Request<Personalize.Types.CreateBatchSegmentJobResponse, AWSError>;
  30. /**
  31. * You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing. Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request. Minimum Provisioned TPS and Auto-Scaling A high minProvisionedTPS will increase your cost. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary. When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1. If your TPS increases beyond the minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions. When your traffic reduces, capacity returns to the minProvisionedTPS. You are charged for the the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary. For more information about campaign costs, see Amazon Personalize pricing. Status A campaign can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the campaign status, call DescribeCampaign. Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations. Related APIs ListCampaigns DescribeCampaign UpdateCampaign DeleteCampaign
  32. */
  33. createCampaign(params: Personalize.Types.CreateCampaignRequest, callback?: (err: AWSError, data: Personalize.Types.CreateCampaignResponse) => void): Request<Personalize.Types.CreateCampaignResponse, AWSError>;
  34. /**
  35. * You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing. Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request. Minimum Provisioned TPS and Auto-Scaling A high minProvisionedTPS will increase your cost. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary. When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1. If your TPS increases beyond the minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions. When your traffic reduces, capacity returns to the minProvisionedTPS. You are charged for the the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary. For more information about campaign costs, see Amazon Personalize pricing. Status A campaign can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the campaign status, call DescribeCampaign. Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations. Related APIs ListCampaigns DescribeCampaign UpdateCampaign DeleteCampaign
  36. */
  37. createCampaign(callback?: (err: AWSError, data: Personalize.Types.CreateCampaignResponse) => void): Request<Personalize.Types.CreateCampaignResponse, AWSError>;
  38. /**
  39. * Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see Deleting users. Your input file must be a CSV file with a single USER_ID column that lists the users IDs. For more information about preparing the CSV file, see Preparing your data deletion file and uploading it to Amazon S3. To give Amazon Personalize permission to access your input CSV file of userIds, you must specify an IAM service role that has permission to read from the data source. This role needs GetObject and ListBucket permissions for the bucket and its content. These permissions are the same as importing data. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments. Status A data deletion job can have one of the following statuses: PENDING &gt; IN_PROGRESS &gt; COMPLETED -or- FAILED To get the status of the data deletion job, call DescribeDataDeletionJob API operation and specify the Amazon Resource Name (ARN) of the job. If the status is FAILED, the response includes a failureReason key, which describes why the job failed. Related APIs ListDataDeletionJobs DescribeDataDeletionJob
  40. */
  41. createDataDeletionJob(params: Personalize.Types.CreateDataDeletionJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDataDeletionJobResponse) => void): Request<Personalize.Types.CreateDataDeletionJobResponse, AWSError>;
  42. /**
  43. * Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see Deleting users. Your input file must be a CSV file with a single USER_ID column that lists the users IDs. For more information about preparing the CSV file, see Preparing your data deletion file and uploading it to Amazon S3. To give Amazon Personalize permission to access your input CSV file of userIds, you must specify an IAM service role that has permission to read from the data source. This role needs GetObject and ListBucket permissions for the bucket and its content. These permissions are the same as importing data. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments. Status A data deletion job can have one of the following statuses: PENDING &gt; IN_PROGRESS &gt; COMPLETED -or- FAILED To get the status of the data deletion job, call DescribeDataDeletionJob API operation and specify the Amazon Resource Name (ARN) of the job. If the status is FAILED, the response includes a failureReason key, which describes why the job failed. Related APIs ListDataDeletionJobs DescribeDataDeletionJob
  44. */
  45. createDataDeletionJob(callback?: (err: AWSError, data: Personalize.Types.CreateDataDeletionJobResponse) => void): Request<Personalize.Types.CreateDataDeletionJobResponse, AWSError>;
  46. /**
  47. * Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are 5 types of datasets: Item interactions Items Users Action interactions Actions Each dataset type has an associated schema with required field types. Only the Item interactions dataset is required in order to train a model (also referred to as creating a solution). A dataset can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the status of the dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets DescribeDataset DeleteDataset
  48. */
  49. createDataset(params: Personalize.Types.CreateDatasetRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetResponse) => void): Request<Personalize.Types.CreateDatasetResponse, AWSError>;
  50. /**
  51. * Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are 5 types of datasets: Item interactions Items Users Action interactions Actions Each dataset type has an associated schema with required field types. Only the Item interactions dataset is required in order to train a model (also referred to as creating a solution). A dataset can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the status of the dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets DescribeDataset DeleteDataset
  52. */
  53. createDataset(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetResponse) => void): Request<Personalize.Types.CreateDatasetResponse, AWSError>;
  54. /**
  55. * Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide. Status A dataset export job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
  56. */
  57. createDatasetExportJob(params: Personalize.Types.CreateDatasetExportJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetExportJobResponse) => void): Request<Personalize.Types.CreateDatasetExportJobResponse, AWSError>;
  58. /**
  59. * Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide. Status A dataset export job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
  60. */
  61. createDatasetExportJob(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetExportJobResponse) => void): Request<Personalize.Types.CreateDatasetExportJobResponse, AWSError>;
  62. /**
  63. * Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset: Item interactions Items Users Actions Action interactions A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
  64. */
  65. createDatasetGroup(params: Personalize.Types.CreateDatasetGroupRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetGroupResponse) => void): Request<Personalize.Types.CreateDatasetGroupResponse, AWSError>;
  66. /**
  67. * Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset: Item interactions Items Users Actions Action interactions A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
  68. */
  69. createDatasetGroup(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetGroupResponse) => void): Request<Personalize.Types.CreateDatasetGroupResponse, AWSError>;
  70. /**
  71. * Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations. By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation. Status A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob
  72. */
  73. createDatasetImportJob(params: Personalize.Types.CreateDatasetImportJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetImportJobResponse) => void): Request<Personalize.Types.CreateDatasetImportJobResponse, AWSError>;
  74. /**
  75. * Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations. By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation. Status A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob
  76. */
  77. createDatasetImportJob(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetImportJobResponse) => void): Request<Personalize.Types.CreateDatasetImportJobResponse, AWSError>;
  78. /**
  79. * Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker. The event tracker can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the status of the event tracker, call DescribeEventTracker. The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs ListEventTrackers DescribeEventTracker DeleteEventTracker
  80. */
  81. createEventTracker(params: Personalize.Types.CreateEventTrackerRequest, callback?: (err: AWSError, data: Personalize.Types.CreateEventTrackerResponse) => void): Request<Personalize.Types.CreateEventTrackerResponse, AWSError>;
  82. /**
  83. * Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker. The event tracker can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the status of the event tracker, call DescribeEventTracker. The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs ListEventTrackers DescribeEventTracker DeleteEventTracker
  84. */
  85. createEventTracker(callback?: (err: AWSError, data: Personalize.Types.CreateEventTrackerResponse) => void): Request<Personalize.Types.CreateEventTrackerResponse, AWSError>;
  86. /**
  87. * Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
  88. */
  89. createFilter(params: Personalize.Types.CreateFilterRequest, callback?: (err: AWSError, data: Personalize.Types.CreateFilterResponse) => void): Request<Personalize.Types.CreateFilterResponse, AWSError>;
  90. /**
  91. * Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
  92. */
  93. createFilter(callback?: (err: AWSError, data: Personalize.Types.CreateFilterResponse) => void): Request<Personalize.Types.CreateFilterResponse, AWSError>;
  94. /**
  95. * Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.
  96. */
  97. createMetricAttribution(params: Personalize.Types.CreateMetricAttributionRequest, callback?: (err: AWSError, data: Personalize.Types.CreateMetricAttributionResponse) => void): Request<Personalize.Types.CreateMetricAttributionResponse, AWSError>;
  98. /**
  99. * Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.
  100. */
  101. createMetricAttribution(callback?: (err: AWSError, data: Personalize.Types.CreateMetricAttributionResponse) => void): Request<Personalize.Types.CreateMetricAttributionResponse, AWSError>;
  102. /**
  103. * Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request. Minimum recommendation requests per second A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary. When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage. If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond. There's a short time delay while the capacity is increased that might cause loss of requests. Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond as necessary. Status A recommender can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED STOP PENDING &gt; STOP IN_PROGRESS &gt; INACTIVE &gt; START PENDING &gt; START IN_PROGRESS &gt; ACTIVE DELETE PENDING &gt; DELETE IN_PROGRESS To get the recommender status, call DescribeRecommender. Wait until the status of the recommender is ACTIVE before asking the recommender for recommendations. Related APIs ListRecommenders DescribeRecommender UpdateRecommender DeleteRecommender
  104. */
  105. createRecommender(params: Personalize.Types.CreateRecommenderRequest, callback?: (err: AWSError, data: Personalize.Types.CreateRecommenderResponse) => void): Request<Personalize.Types.CreateRecommenderResponse, AWSError>;
  106. /**
  107. * Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request. Minimum recommendation requests per second A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary. When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage. If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond. There's a short time delay while the capacity is increased that might cause loss of requests. Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond as necessary. Status A recommender can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED STOP PENDING &gt; STOP IN_PROGRESS &gt; INACTIVE &gt; START PENDING &gt; START IN_PROGRESS &gt; ACTIVE DELETE PENDING &gt; DELETE IN_PROGRESS To get the recommender status, call DescribeRecommender. Wait until the status of the recommender is ACTIVE before asking the recommender for recommendations. Related APIs ListRecommenders DescribeRecommender UpdateRecommender DeleteRecommender
  108. */
  109. createRecommender(callback?: (err: AWSError, data: Personalize.Types.CreateRecommenderResponse) => void): Request<Personalize.Types.CreateRecommenderResponse, AWSError>;
  110. /**
  111. * Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format. Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset. Related APIs ListSchemas DescribeSchema DeleteSchema
  112. */
  113. createSchema(params: Personalize.Types.CreateSchemaRequest, callback?: (err: AWSError, data: Personalize.Types.CreateSchemaResponse) => void): Request<Personalize.Types.CreateSchemaResponse, AWSError>;
  114. /**
  115. * Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format. Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset. Related APIs ListSchemas DescribeSchema DeleteSchema
  116. */
  117. createSchema(callback?: (err: AWSError, data: Personalize.Types.CreateSchemaResponse) => void): Request<Personalize.Types.CreateSchemaResponse, AWSError>;
  118. /**
  119. * After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. You can't stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training costs, see Amazon Personalize pricing. Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution. By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training. To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation. After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion. After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API. Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time. Status A solution can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the status of the solution, call DescribeSolution. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion. Related APIs ListSolutions CreateSolutionVersion DescribeSolution DeleteSolution ListSolutionVersions DescribeSolutionVersion
  120. */
  121. createSolution(params: Personalize.Types.CreateSolutionRequest, callback?: (err: AWSError, data: Personalize.Types.CreateSolutionResponse) => void): Request<Personalize.Types.CreateSolutionResponse, AWSError>;
  122. /**
  123. * After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. You can't stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training costs, see Amazon Personalize pricing. Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution. By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training. To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation. After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion. After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API. Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time. Status A solution can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the status of the solution, call DescribeSolution. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion. Related APIs ListSolutions CreateSolutionVersion DescribeSolution DeleteSolution ListSolutionVersions DescribeSolutionVersion
  124. */
  125. createSolution(callback?: (err: AWSError, data: Personalize.Types.CreateSolutionResponse) => void): Request<Personalize.Types.CreateSolutionResponse, AWSError>;
  126. /**
  127. * Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation. Status A solution version can be in one of the following states: CREATE PENDING CREATE IN_PROGRESS ACTIVE CREATE FAILED CREATE STOPPING CREATE STOPPED To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Related APIs ListSolutionVersions DescribeSolutionVersion ListSolutions CreateSolution DescribeSolution DeleteSolution
  128. */
  129. createSolutionVersion(params: Personalize.Types.CreateSolutionVersionRequest, callback?: (err: AWSError, data: Personalize.Types.CreateSolutionVersionResponse) => void): Request<Personalize.Types.CreateSolutionVersionResponse, AWSError>;
  130. /**
  131. * Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation. Status A solution version can be in one of the following states: CREATE PENDING CREATE IN_PROGRESS ACTIVE CREATE FAILED CREATE STOPPING CREATE STOPPED To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Related APIs ListSolutionVersions DescribeSolutionVersion ListSolutions CreateSolution DescribeSolution DeleteSolution
  132. */
  133. createSolutionVersion(callback?: (err: AWSError, data: Personalize.Types.CreateSolutionVersionResponse) => void): Request<Personalize.Types.CreateSolutionVersionResponse, AWSError>;
  134. /**
  135. * Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.
  136. */
  137. deleteCampaign(params: Personalize.Types.DeleteCampaignRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  138. /**
  139. * Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.
  140. */
  141. deleteCampaign(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  142. /**
  143. * Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.
  144. */
  145. deleteDataset(params: Personalize.Types.DeleteDatasetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  146. /**
  147. * Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.
  148. */
  149. deleteDataset(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  150. /**
  151. * Deletes a dataset group. Before you delete a dataset group, you must delete the following: All associated event trackers. All associated solutions. All datasets in the dataset group.
  152. */
  153. deleteDatasetGroup(params: Personalize.Types.DeleteDatasetGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  154. /**
  155. * Deletes a dataset group. Before you delete a dataset group, you must delete the following: All associated event trackers. All associated solutions. All datasets in the dataset group.
  156. */
  157. deleteDatasetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  158. /**
  159. * Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.
  160. */
  161. deleteEventTracker(params: Personalize.Types.DeleteEventTrackerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  162. /**
  163. * Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.
  164. */
  165. deleteEventTracker(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  166. /**
  167. * Deletes a filter.
  168. */
  169. deleteFilter(params: Personalize.Types.DeleteFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  170. /**
  171. * Deletes a filter.
  172. */
  173. deleteFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  174. /**
  175. * Deletes a metric attribution.
  176. */
  177. deleteMetricAttribution(params: Personalize.Types.DeleteMetricAttributionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  178. /**
  179. * Deletes a metric attribution.
  180. */
  181. deleteMetricAttribution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  182. /**
  183. * Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
  184. */
  185. deleteRecommender(params: Personalize.Types.DeleteRecommenderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  186. /**
  187. * Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
  188. */
  189. deleteRecommender(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  190. /**
  191. * Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
  192. */
  193. deleteSchema(params: Personalize.Types.DeleteSchemaRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  194. /**
  195. * Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
  196. */
  197. deleteSchema(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  198. /**
  199. * Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.
  200. */
  201. deleteSolution(params: Personalize.Types.DeleteSolutionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  202. /**
  203. * Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.
  204. */
  205. deleteSolution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  206. /**
  207. * Describes the given algorithm.
  208. */
  209. describeAlgorithm(params: Personalize.Types.DescribeAlgorithmRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeAlgorithmResponse) => void): Request<Personalize.Types.DescribeAlgorithmResponse, AWSError>;
  210. /**
  211. * Describes the given algorithm.
  212. */
  213. describeAlgorithm(callback?: (err: AWSError, data: Personalize.Types.DescribeAlgorithmResponse) => void): Request<Personalize.Types.DescribeAlgorithmResponse, AWSError>;
  214. /**
  215. * Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
  216. */
  217. describeBatchInferenceJob(params: Personalize.Types.DescribeBatchInferenceJobRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeBatchInferenceJobResponse) => void): Request<Personalize.Types.DescribeBatchInferenceJobResponse, AWSError>;
  218. /**
  219. * Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
  220. */
  221. describeBatchInferenceJob(callback?: (err: AWSError, data: Personalize.Types.DescribeBatchInferenceJobResponse) => void): Request<Personalize.Types.DescribeBatchInferenceJobResponse, AWSError>;
  222. /**
  223. * Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.
  224. */
  225. describeBatchSegmentJob(params: Personalize.Types.DescribeBatchSegmentJobRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeBatchSegmentJobResponse) => void): Request<Personalize.Types.DescribeBatchSegmentJobResponse, AWSError>;
  226. /**
  227. * Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.
  228. */
  229. describeBatchSegmentJob(callback?: (err: AWSError, data: Personalize.Types.DescribeBatchSegmentJobResponse) => void): Request<Personalize.Types.DescribeBatchSegmentJobResponse, AWSError>;
  230. /**
  231. * Describes the given campaign, including its status. A campaign can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. For more information on campaigns, see CreateCampaign.
  232. */
  233. describeCampaign(params: Personalize.Types.DescribeCampaignRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeCampaignResponse) => void): Request<Personalize.Types.DescribeCampaignResponse, AWSError>;
  234. /**
  235. * Describes the given campaign, including its status. A campaign can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. For more information on campaigns, see CreateCampaign.
  236. */
  237. describeCampaign(callback?: (err: AWSError, data: Personalize.Types.DescribeCampaignResponse) => void): Request<Personalize.Types.DescribeCampaignResponse, AWSError>;
  238. /**
  239. * Describes the data deletion job created by CreateDataDeletionJob, including the job status.
  240. */
  241. describeDataDeletionJob(params: Personalize.Types.DescribeDataDeletionJobRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeDataDeletionJobResponse) => void): Request<Personalize.Types.DescribeDataDeletionJobResponse, AWSError>;
  242. /**
  243. * Describes the data deletion job created by CreateDataDeletionJob, including the job status.
  244. */
  245. describeDataDeletionJob(callback?: (err: AWSError, data: Personalize.Types.DescribeDataDeletionJobResponse) => void): Request<Personalize.Types.DescribeDataDeletionJobResponse, AWSError>;
  246. /**
  247. * Describes the given dataset. For more information on datasets, see CreateDataset.
  248. */
  249. describeDataset(params: Personalize.Types.DescribeDatasetRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetResponse) => void): Request<Personalize.Types.DescribeDatasetResponse, AWSError>;
  250. /**
  251. * Describes the given dataset. For more information on datasets, see CreateDataset.
  252. */
  253. describeDataset(callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetResponse) => void): Request<Personalize.Types.DescribeDatasetResponse, AWSError>;
  254. /**
  255. * Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
  256. */
  257. describeDatasetExportJob(params: Personalize.Types.DescribeDatasetExportJobRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetExportJobResponse) => void): Request<Personalize.Types.DescribeDatasetExportJobResponse, AWSError>;
  258. /**
  259. * Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
  260. */
  261. describeDatasetExportJob(callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetExportJobResponse) => void): Request<Personalize.Types.DescribeDatasetExportJobResponse, AWSError>;
  262. /**
  263. * Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
  264. */
  265. describeDatasetGroup(params: Personalize.Types.DescribeDatasetGroupRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetGroupResponse) => void): Request<Personalize.Types.DescribeDatasetGroupResponse, AWSError>;
  266. /**
  267. * Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
  268. */
  269. describeDatasetGroup(callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetGroupResponse) => void): Request<Personalize.Types.DescribeDatasetGroupResponse, AWSError>;
  270. /**
  271. * Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
  272. */
  273. describeDatasetImportJob(params: Personalize.Types.DescribeDatasetImportJobRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetImportJobResponse) => void): Request<Personalize.Types.DescribeDatasetImportJobResponse, AWSError>;
  274. /**
  275. * Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
  276. */
  277. describeDatasetImportJob(callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetImportJobResponse) => void): Request<Personalize.Types.DescribeDatasetImportJobResponse, AWSError>;
  278. /**
  279. * Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
  280. */
  281. describeEventTracker(params: Personalize.Types.DescribeEventTrackerRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeEventTrackerResponse) => void): Request<Personalize.Types.DescribeEventTrackerResponse, AWSError>;
  282. /**
  283. * Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
  284. */
  285. describeEventTracker(callback?: (err: AWSError, data: Personalize.Types.DescribeEventTrackerResponse) => void): Request<Personalize.Types.DescribeEventTrackerResponse, AWSError>;
  286. /**
  287. * Describes the given feature transformation.
  288. */
  289. describeFeatureTransformation(params: Personalize.Types.DescribeFeatureTransformationRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeFeatureTransformationResponse) => void): Request<Personalize.Types.DescribeFeatureTransformationResponse, AWSError>;
  290. /**
  291. * Describes the given feature transformation.
  292. */
  293. describeFeatureTransformation(callback?: (err: AWSError, data: Personalize.Types.DescribeFeatureTransformationResponse) => void): Request<Personalize.Types.DescribeFeatureTransformationResponse, AWSError>;
  294. /**
  295. * Describes a filter's properties.
  296. */
  297. describeFilter(params: Personalize.Types.DescribeFilterRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeFilterResponse) => void): Request<Personalize.Types.DescribeFilterResponse, AWSError>;
  298. /**
  299. * Describes a filter's properties.
  300. */
  301. describeFilter(callback?: (err: AWSError, data: Personalize.Types.DescribeFilterResponse) => void): Request<Personalize.Types.DescribeFilterResponse, AWSError>;
  302. /**
  303. * Describes a metric attribution.
  304. */
  305. describeMetricAttribution(params: Personalize.Types.DescribeMetricAttributionRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeMetricAttributionResponse) => void): Request<Personalize.Types.DescribeMetricAttributionResponse, AWSError>;
  306. /**
  307. * Describes a metric attribution.
  308. */
  309. describeMetricAttribution(callback?: (err: AWSError, data: Personalize.Types.DescribeMetricAttributionResponse) => void): Request<Personalize.Types.DescribeMetricAttributionResponse, AWSError>;
  310. /**
  311. * Describes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that govern the training. Feature transformation information for modifying the input data before training. Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
  312. */
  313. describeRecipe(params: Personalize.Types.DescribeRecipeRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeRecipeResponse) => void): Request<Personalize.Types.DescribeRecipeResponse, AWSError>;
  314. /**
  315. * Describes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that govern the training. Feature transformation information for modifying the input data before training. Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
  316. */
  317. describeRecipe(callback?: (err: AWSError, data: Personalize.Types.DescribeRecipeResponse) => void): Request<Personalize.Types.DescribeRecipeResponse, AWSError>;
  318. /**
  319. * Describes the given recommender, including its status. A recommender can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED STOP PENDING &gt; STOP IN_PROGRESS &gt; INACTIVE &gt; START PENDING &gt; START IN_PROGRESS &gt; ACTIVE DELETE PENDING &gt; DELETE IN_PROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. The modelMetrics key is null when the recommender is being created or deleted. For more information on recommenders, see CreateRecommender.
  320. */
  321. describeRecommender(params: Personalize.Types.DescribeRecommenderRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeRecommenderResponse) => void): Request<Personalize.Types.DescribeRecommenderResponse, AWSError>;
  322. /**
  323. * Describes the given recommender, including its status. A recommender can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED STOP PENDING &gt; STOP IN_PROGRESS &gt; INACTIVE &gt; START PENDING &gt; START IN_PROGRESS &gt; ACTIVE DELETE PENDING &gt; DELETE IN_PROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. The modelMetrics key is null when the recommender is being created or deleted. For more information on recommenders, see CreateRecommender.
  324. */
  325. describeRecommender(callback?: (err: AWSError, data: Personalize.Types.DescribeRecommenderResponse) => void): Request<Personalize.Types.DescribeRecommenderResponse, AWSError>;
  326. /**
  327. * Describes a schema. For more information on schemas, see CreateSchema.
  328. */
  329. describeSchema(params: Personalize.Types.DescribeSchemaRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeSchemaResponse) => void): Request<Personalize.Types.DescribeSchemaResponse, AWSError>;
  330. /**
  331. * Describes a schema. For more information on schemas, see CreateSchema.
  332. */
  333. describeSchema(callback?: (err: AWSError, data: Personalize.Types.DescribeSchemaResponse) => void): Request<Personalize.Types.DescribeSchemaResponse, AWSError>;
  334. /**
  335. * Describes a solution. For more information on solutions, see CreateSolution.
  336. */
  337. describeSolution(params: Personalize.Types.DescribeSolutionRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionResponse) => void): Request<Personalize.Types.DescribeSolutionResponse, AWSError>;
  338. /**
  339. * Describes a solution. For more information on solutions, see CreateSolution.
  340. */
  341. describeSolution(callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionResponse) => void): Request<Personalize.Types.DescribeSolutionResponse, AWSError>;
  342. /**
  343. * Describes a specific version of a solution. For more information on solutions, see CreateSolution
  344. */
  345. describeSolutionVersion(params: Personalize.Types.DescribeSolutionVersionRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionVersionResponse) => void): Request<Personalize.Types.DescribeSolutionVersionResponse, AWSError>;
  346. /**
  347. * Describes a specific version of a solution. For more information on solutions, see CreateSolution
  348. */
  349. describeSolutionVersion(callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionVersionResponse) => void): Request<Personalize.Types.DescribeSolutionVersionResponse, AWSError>;
  350. /**
  351. * Gets the metrics for the specified solution version.
  352. */
  353. getSolutionMetrics(params: Personalize.Types.GetSolutionMetricsRequest, callback?: (err: AWSError, data: Personalize.Types.GetSolutionMetricsResponse) => void): Request<Personalize.Types.GetSolutionMetricsResponse, AWSError>;
  354. /**
  355. * Gets the metrics for the specified solution version.
  356. */
  357. getSolutionMetrics(callback?: (err: AWSError, data: Personalize.Types.GetSolutionMetricsResponse) => void): Request<Personalize.Types.GetSolutionMetricsResponse, AWSError>;
  358. /**
  359. * Gets a list of the batch inference jobs that have been performed off of a solution version.
  360. */
  361. listBatchInferenceJobs(params: Personalize.Types.ListBatchInferenceJobsRequest, callback?: (err: AWSError, data: Personalize.Types.ListBatchInferenceJobsResponse) => void): Request<Personalize.Types.ListBatchInferenceJobsResponse, AWSError>;
  362. /**
  363. * Gets a list of the batch inference jobs that have been performed off of a solution version.
  364. */
  365. listBatchInferenceJobs(callback?: (err: AWSError, data: Personalize.Types.ListBatchInferenceJobsResponse) => void): Request<Personalize.Types.ListBatchInferenceJobsResponse, AWSError>;
  366. /**
  367. * Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
  368. */
  369. listBatchSegmentJobs(params: Personalize.Types.ListBatchSegmentJobsRequest, callback?: (err: AWSError, data: Personalize.Types.ListBatchSegmentJobsResponse) => void): Request<Personalize.Types.ListBatchSegmentJobsResponse, AWSError>;
  370. /**
  371. * Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
  372. */
  373. listBatchSegmentJobs(callback?: (err: AWSError, data: Personalize.Types.ListBatchSegmentJobsResponse) => void): Request<Personalize.Types.ListBatchSegmentJobsResponse, AWSError>;
  374. /**
  375. * Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
  376. */
  377. listCampaigns(params: Personalize.Types.ListCampaignsRequest, callback?: (err: AWSError, data: Personalize.Types.ListCampaignsResponse) => void): Request<Personalize.Types.ListCampaignsResponse, AWSError>;
  378. /**
  379. * Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
  380. */
  381. listCampaigns(callback?: (err: AWSError, data: Personalize.Types.ListCampaignsResponse) => void): Request<Personalize.Types.ListCampaignsResponse, AWSError>;
  382. /**
  383. * Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see Deleting users.
  384. */
  385. listDataDeletionJobs(params: Personalize.Types.ListDataDeletionJobsRequest, callback?: (err: AWSError, data: Personalize.Types.ListDataDeletionJobsResponse) => void): Request<Personalize.Types.ListDataDeletionJobsResponse, AWSError>;
  386. /**
  387. * Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see Deleting users.
  388. */
  389. listDataDeletionJobs(callback?: (err: AWSError, data: Personalize.Types.ListDataDeletionJobsResponse) => void): Request<Personalize.Types.ListDataDeletionJobsResponse, AWSError>;
  390. /**
  391. * Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
  392. */
  393. listDatasetExportJobs(params: Personalize.Types.ListDatasetExportJobsRequest, callback?: (err: AWSError, data: Personalize.Types.ListDatasetExportJobsResponse) => void): Request<Personalize.Types.ListDatasetExportJobsResponse, AWSError>;
  394. /**
  395. * Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
  396. */
  397. listDatasetExportJobs(callback?: (err: AWSError, data: Personalize.Types.ListDatasetExportJobsResponse) => void): Request<Personalize.Types.ListDatasetExportJobsResponse, AWSError>;
  398. /**
  399. * Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
  400. */
  401. listDatasetGroups(params: Personalize.Types.ListDatasetGroupsRequest, callback?: (err: AWSError, data: Personalize.Types.ListDatasetGroupsResponse) => void): Request<Personalize.Types.ListDatasetGroupsResponse, AWSError>;
  402. /**
  403. * Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
  404. */
  405. listDatasetGroups(callback?: (err: AWSError, data: Personalize.Types.ListDatasetGroupsResponse) => void): Request<Personalize.Types.ListDatasetGroupsResponse, AWSError>;
  406. /**
  407. * Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.
  408. */
  409. listDatasetImportJobs(params: Personalize.Types.ListDatasetImportJobsRequest, callback?: (err: AWSError, data: Personalize.Types.ListDatasetImportJobsResponse) => void): Request<Personalize.Types.ListDatasetImportJobsResponse, AWSError>;
  410. /**
  411. * Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.
  412. */
  413. listDatasetImportJobs(callback?: (err: AWSError, data: Personalize.Types.ListDatasetImportJobsResponse) => void): Request<Personalize.Types.ListDatasetImportJobsResponse, AWSError>;
  414. /**
  415. * Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
  416. */
  417. listDatasets(params: Personalize.Types.ListDatasetsRequest, callback?: (err: AWSError, data: Personalize.Types.ListDatasetsResponse) => void): Request<Personalize.Types.ListDatasetsResponse, AWSError>;
  418. /**
  419. * Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
  420. */
  421. listDatasets(callback?: (err: AWSError, data: Personalize.Types.ListDatasetsResponse) => void): Request<Personalize.Types.ListDatasetsResponse, AWSError>;
  422. /**
  423. * Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
  424. */
  425. listEventTrackers(params: Personalize.Types.ListEventTrackersRequest, callback?: (err: AWSError, data: Personalize.Types.ListEventTrackersResponse) => void): Request<Personalize.Types.ListEventTrackersResponse, AWSError>;
  426. /**
  427. * Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
  428. */
  429. listEventTrackers(callback?: (err: AWSError, data: Personalize.Types.ListEventTrackersResponse) => void): Request<Personalize.Types.ListEventTrackersResponse, AWSError>;
  430. /**
  431. * Lists all filters that belong to a given dataset group.
  432. */
  433. listFilters(params: Personalize.Types.ListFiltersRequest, callback?: (err: AWSError, data: Personalize.Types.ListFiltersResponse) => void): Request<Personalize.Types.ListFiltersResponse, AWSError>;
  434. /**
  435. * Lists all filters that belong to a given dataset group.
  436. */
  437. listFilters(callback?: (err: AWSError, data: Personalize.Types.ListFiltersResponse) => void): Request<Personalize.Types.ListFiltersResponse, AWSError>;
  438. /**
  439. * Lists the metrics for the metric attribution.
  440. */
  441. listMetricAttributionMetrics(params: Personalize.Types.ListMetricAttributionMetricsRequest, callback?: (err: AWSError, data: Personalize.Types.ListMetricAttributionMetricsResponse) => void): Request<Personalize.Types.ListMetricAttributionMetricsResponse, AWSError>;
  442. /**
  443. * Lists the metrics for the metric attribution.
  444. */
  445. listMetricAttributionMetrics(callback?: (err: AWSError, data: Personalize.Types.ListMetricAttributionMetricsResponse) => void): Request<Personalize.Types.ListMetricAttributionMetricsResponse, AWSError>;
  446. /**
  447. * Lists metric attributions.
  448. */
  449. listMetricAttributions(params: Personalize.Types.ListMetricAttributionsRequest, callback?: (err: AWSError, data: Personalize.Types.ListMetricAttributionsResponse) => void): Request<Personalize.Types.ListMetricAttributionsResponse, AWSError>;
  450. /**
  451. * Lists metric attributions.
  452. */
  453. listMetricAttributions(callback?: (err: AWSError, data: Personalize.Types.ListMetricAttributionsResponse) => void): Request<Personalize.Types.ListMetricAttributionsResponse, AWSError>;
  454. /**
  455. * Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
  456. */
  457. listRecipes(params: Personalize.Types.ListRecipesRequest, callback?: (err: AWSError, data: Personalize.Types.ListRecipesResponse) => void): Request<Personalize.Types.ListRecipesResponse, AWSError>;
  458. /**
  459. * Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
  460. */
  461. listRecipes(callback?: (err: AWSError, data: Personalize.Types.ListRecipesResponse) => void): Request<Personalize.Types.ListRecipesResponse, AWSError>;
  462. /**
  463. * Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
  464. */
  465. listRecommenders(params: Personalize.Types.ListRecommendersRequest, callback?: (err: AWSError, data: Personalize.Types.ListRecommendersResponse) => void): Request<Personalize.Types.ListRecommendersResponse, AWSError>;
  466. /**
  467. * Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
  468. */
  469. listRecommenders(callback?: (err: AWSError, data: Personalize.Types.ListRecommendersResponse) => void): Request<Personalize.Types.ListRecommendersResponse, AWSError>;
  470. /**
  471. * Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
  472. */
  473. listSchemas(params: Personalize.Types.ListSchemasRequest, callback?: (err: AWSError, data: Personalize.Types.ListSchemasResponse) => void): Request<Personalize.Types.ListSchemasResponse, AWSError>;
  474. /**
  475. * Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
  476. */
  477. listSchemas(callback?: (err: AWSError, data: Personalize.Types.ListSchemasResponse) => void): Request<Personalize.Types.ListSchemasResponse, AWSError>;
  478. /**
  479. * Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN).
  480. */
  481. listSolutionVersions(params: Personalize.Types.ListSolutionVersionsRequest, callback?: (err: AWSError, data: Personalize.Types.ListSolutionVersionsResponse) => void): Request<Personalize.Types.ListSolutionVersionsResponse, AWSError>;
  482. /**
  483. * Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN).
  484. */
  485. listSolutionVersions(callback?: (err: AWSError, data: Personalize.Types.ListSolutionVersionsResponse) => void): Request<Personalize.Types.ListSolutionVersionsResponse, AWSError>;
  486. /**
  487. * Returns a list of solutions in a given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
  488. */
  489. listSolutions(params: Personalize.Types.ListSolutionsRequest, callback?: (err: AWSError, data: Personalize.Types.ListSolutionsResponse) => void): Request<Personalize.Types.ListSolutionsResponse, AWSError>;
  490. /**
  491. * Returns a list of solutions in a given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
  492. */
  493. listSolutions(callback?: (err: AWSError, data: Personalize.Types.ListSolutionsResponse) => void): Request<Personalize.Types.ListSolutionsResponse, AWSError>;
  494. /**
  495. * Get a list of tags attached to a resource.
  496. */
  497. listTagsForResource(params: Personalize.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Personalize.Types.ListTagsForResourceResponse) => void): Request<Personalize.Types.ListTagsForResourceResponse, AWSError>;
  498. /**
  499. * Get a list of tags attached to a resource.
  500. */
  501. listTagsForResource(callback?: (err: AWSError, data: Personalize.Types.ListTagsForResourceResponse) => void): Request<Personalize.Types.ListTagsForResourceResponse, AWSError>;
  502. /**
  503. * Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
  504. */
  505. startRecommender(params: Personalize.Types.StartRecommenderRequest, callback?: (err: AWSError, data: Personalize.Types.StartRecommenderResponse) => void): Request<Personalize.Types.StartRecommenderResponse, AWSError>;
  506. /**
  507. * Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
  508. */
  509. startRecommender(callback?: (err: AWSError, data: Personalize.Types.StartRecommenderResponse) => void): Request<Personalize.Types.StartRecommenderResponse, AWSError>;
  510. /**
  511. * Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
  512. */
  513. stopRecommender(params: Personalize.Types.StopRecommenderRequest, callback?: (err: AWSError, data: Personalize.Types.StopRecommenderResponse) => void): Request<Personalize.Types.StopRecommenderResponse, AWSError>;
  514. /**
  515. * Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
  516. */
  517. stopRecommender(callback?: (err: AWSError, data: Personalize.Types.StopRecommenderResponse) => void): Request<Personalize.Types.StopRecommenderResponse, AWSError>;
  518. /**
  519. * Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS. Depending on the current state of the solution version, the solution version state changes as follows: CREATE_PENDING &gt; CREATE_STOPPED or CREATE_IN_PROGRESS &gt; CREATE_STOPPING &gt; CREATE_STOPPED You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.
  520. */
  521. stopSolutionVersionCreation(params: Personalize.Types.StopSolutionVersionCreationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  522. /**
  523. * Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS. Depending on the current state of the solution version, the solution version state changes as follows: CREATE_PENDING &gt; CREATE_STOPPED or CREATE_IN_PROGRESS &gt; CREATE_STOPPING &gt; CREATE_STOPPED You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.
  524. */
  525. stopSolutionVersionCreation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  526. /**
  527. * Add a list of tags to a resource.
  528. */
  529. tagResource(params: Personalize.Types.TagResourceRequest, callback?: (err: AWSError, data: Personalize.Types.TagResourceResponse) => void): Request<Personalize.Types.TagResourceResponse, AWSError>;
  530. /**
  531. * Add a list of tags to a resource.
  532. */
  533. tagResource(callback?: (err: AWSError, data: Personalize.Types.TagResourceResponse) => void): Request<Personalize.Types.TagResourceResponse, AWSError>;
  534. /**
  535. * Removes the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.
  536. */
  537. untagResource(params: Personalize.Types.UntagResourceRequest, callback?: (err: AWSError, data: Personalize.Types.UntagResourceResponse) => void): Request<Personalize.Types.UntagResourceResponse, AWSError>;
  538. /**
  539. * Removes the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.
  540. */
  541. untagResource(callback?: (err: AWSError, data: Personalize.Types.UntagResourceResponse) => void): Request<Personalize.Types.UntagResourceResponse, AWSError>;
  542. /**
  543. * Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign. To update a campaign to start automatically using the latest solution version, specify the following: For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN) of your solution in SolutionArn/$LATEST format. In the campaignConfig, set syncWithLatestSolutionVersion to true. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation. You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active. For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.
  544. */
  545. updateCampaign(params: Personalize.Types.UpdateCampaignRequest, callback?: (err: AWSError, data: Personalize.Types.UpdateCampaignResponse) => void): Request<Personalize.Types.UpdateCampaignResponse, AWSError>;
  546. /**
  547. * Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign. To update a campaign to start automatically using the latest solution version, specify the following: For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN) of your solution in SolutionArn/$LATEST format. In the campaignConfig, set syncWithLatestSolutionVersion to true. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation. You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active. For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.
  548. */
  549. updateCampaign(callback?: (err: AWSError, data: Personalize.Types.UpdateCampaignResponse) => void): Request<Personalize.Types.UpdateCampaignResponse, AWSError>;
  550. /**
  551. * Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.
  552. */
  553. updateDataset(params: Personalize.Types.UpdateDatasetRequest, callback?: (err: AWSError, data: Personalize.Types.UpdateDatasetResponse) => void): Request<Personalize.Types.UpdateDatasetResponse, AWSError>;
  554. /**
  555. * Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.
  556. */
  557. updateDataset(callback?: (err: AWSError, data: Personalize.Types.UpdateDatasetResponse) => void): Request<Personalize.Types.UpdateDatasetResponse, AWSError>;
  558. /**
  559. * Updates a metric attribution.
  560. */
  561. updateMetricAttribution(params: Personalize.Types.UpdateMetricAttributionRequest, callback?: (err: AWSError, data: Personalize.Types.UpdateMetricAttributionResponse) => void): Request<Personalize.Types.UpdateMetricAttributionResponse, AWSError>;
  562. /**
  563. * Updates a metric attribution.
  564. */
  565. updateMetricAttribution(callback?: (err: AWSError, data: Personalize.Types.UpdateMetricAttributionResponse) => void): Request<Personalize.Types.UpdateMetricAttributionResponse, AWSError>;
  566. /**
  567. * Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate returned in the DescribeRecommender operation.
  568. */
  569. updateRecommender(params: Personalize.Types.UpdateRecommenderRequest, callback?: (err: AWSError, data: Personalize.Types.UpdateRecommenderResponse) => void): Request<Personalize.Types.UpdateRecommenderResponse, AWSError>;
  570. /**
  571. * Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate returned in the DescribeRecommender operation.
  572. */
  573. updateRecommender(callback?: (err: AWSError, data: Personalize.Types.UpdateRecommenderResponse) => void): Request<Personalize.Types.UpdateRecommenderResponse, AWSError>;
  574. }
  575. declare namespace Personalize {
  576. export type AccountId = string;
  577. export interface Algorithm {
  578. /**
  579. * The name of the algorithm.
  580. */
  581. name?: Name;
  582. /**
  583. * The Amazon Resource Name (ARN) of the algorithm.
  584. */
  585. algorithmArn?: Arn;
  586. /**
  587. * The URI of the Docker container for the algorithm image.
  588. */
  589. algorithmImage?: AlgorithmImage;
  590. /**
  591. * Specifies the default hyperparameters.
  592. */
  593. defaultHyperParameters?: HyperParameters;
  594. /**
  595. * Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
  596. */
  597. defaultHyperParameterRanges?: DefaultHyperParameterRanges;
  598. /**
  599. * Specifies the default maximum number of training jobs and parallel training jobs.
  600. */
  601. defaultResourceConfig?: ResourceConfig;
  602. /**
  603. * The training input mode.
  604. */
  605. trainingInputMode?: TrainingInputMode;
  606. /**
  607. * The Amazon Resource Name (ARN) of the role.
  608. */
  609. roleArn?: Arn;
  610. /**
  611. * The date and time (in Unix time) that the algorithm was created.
  612. */
  613. creationDateTime?: _Date;
  614. /**
  615. * The date and time (in Unix time) that the algorithm was last updated.
  616. */
  617. lastUpdatedDateTime?: _Date;
  618. }
  619. export interface AlgorithmImage {
  620. /**
  621. * The name of the algorithm image.
  622. */
  623. name?: Name;
  624. /**
  625. * The URI of the Docker container for the algorithm image.
  626. */
  627. dockerURI: DockerURI;
  628. }
  629. export type Arn = string;
  630. export type ArnList = Arn[];
  631. export interface AutoMLConfig {
  632. /**
  633. * The metric to optimize.
  634. */
  635. metricName?: MetricName;
  636. /**
  637. * The list of candidate recipes.
  638. */
  639. recipeList?: ArnList;
  640. }
  641. export interface AutoMLResult {
  642. /**
  643. * The Amazon Resource Name (ARN) of the best recipe.
  644. */
  645. bestRecipeArn?: Arn;
  646. }
  647. export interface AutoTrainingConfig {
  648. /**
  649. * Specifies how often to automatically train new solution versions. Specify a rate expression in rate(value unit) format. For value, specify a number between 1 and 30. For unit, specify day or days. For example, to automatically create a new solution version every 5 days, specify rate(5 days). The default is every 7 days. For more information about auto training, see Creating and configuring a solution.
  650. */
  651. schedulingExpression?: SchedulingExpression;
  652. }
  653. export type AvroSchema = string;
  654. export interface BatchInferenceJob {
  655. /**
  656. * The name of the batch inference job.
  657. */
  658. jobName?: Name;
  659. /**
  660. * The Amazon Resource Name (ARN) of the batch inference job.
  661. */
  662. batchInferenceJobArn?: Arn;
  663. /**
  664. * The ARN of the filter used on the batch inference job.
  665. */
  666. filterArn?: Arn;
  667. /**
  668. * If the batch inference job failed, the reason for the failure.
  669. */
  670. failureReason?: FailureReason;
  671. /**
  672. * The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
  673. */
  674. solutionVersionArn?: Arn;
  675. /**
  676. * The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
  677. */
  678. numResults?: NumBatchResults;
  679. /**
  680. * The Amazon S3 path that leads to the input data used to generate the batch inference job.
  681. */
  682. jobInput?: BatchInferenceJobInput;
  683. /**
  684. * The Amazon S3 bucket that contains the output data generated by the batch inference job.
  685. */
  686. jobOutput?: BatchInferenceJobOutput;
  687. /**
  688. * A string to string map of the configuration details of a batch inference job.
  689. */
  690. batchInferenceJobConfig?: BatchInferenceJobConfig;
  691. /**
  692. * The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
  693. */
  694. roleArn?: RoleArn;
  695. /**
  696. * The job's mode.
  697. */
  698. batchInferenceJobMode?: BatchInferenceJobMode;
  699. /**
  700. * The job's theme generation settings.
  701. */
  702. themeGenerationConfig?: ThemeGenerationConfig;
  703. /**
  704. * The status of the batch inference job. The status is one of the following values: PENDING IN PROGRESS ACTIVE CREATE FAILED
  705. */
  706. status?: Status;
  707. /**
  708. * The time at which the batch inference job was created.
  709. */
  710. creationDateTime?: _Date;
  711. /**
  712. * The time at which the batch inference job was last updated.
  713. */
  714. lastUpdatedDateTime?: _Date;
  715. }
  716. export interface BatchInferenceJobConfig {
  717. /**
  718. * A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization.
  719. */
  720. itemExplorationConfig?: HyperParameters;
  721. }
  722. export interface BatchInferenceJobInput {
  723. /**
  724. * The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.
  725. */
  726. s3DataSource: S3DataConfig;
  727. }
  728. export type BatchInferenceJobMode = "BATCH_INFERENCE"|"THEME_GENERATION"|string;
  729. export interface BatchInferenceJobOutput {
  730. /**
  731. * Information on the Amazon S3 bucket in which the batch inference job's output is stored.
  732. */
  733. s3DataDestination: S3DataConfig;
  734. }
  735. export interface BatchInferenceJobSummary {
  736. /**
  737. * The Amazon Resource Name (ARN) of the batch inference job.
  738. */
  739. batchInferenceJobArn?: Arn;
  740. /**
  741. * The name of the batch inference job.
  742. */
  743. jobName?: Name;
  744. /**
  745. * The status of the batch inference job. The status is one of the following values: PENDING IN PROGRESS ACTIVE CREATE FAILED
  746. */
  747. status?: Status;
  748. /**
  749. * The time at which the batch inference job was created.
  750. */
  751. creationDateTime?: _Date;
  752. /**
  753. * The time at which the batch inference job was last updated.
  754. */
  755. lastUpdatedDateTime?: _Date;
  756. /**
  757. * If the batch inference job failed, the reason for the failure.
  758. */
  759. failureReason?: FailureReason;
  760. /**
  761. * The ARN of the solution version used by the batch inference job.
  762. */
  763. solutionVersionArn?: Arn;
  764. /**
  765. * The job's mode.
  766. */
  767. batchInferenceJobMode?: BatchInferenceJobMode;
  768. }
  769. export type BatchInferenceJobs = BatchInferenceJobSummary[];
  770. export interface BatchSegmentJob {
  771. /**
  772. * The name of the batch segment job.
  773. */
  774. jobName?: Name;
  775. /**
  776. * The Amazon Resource Name (ARN) of the batch segment job.
  777. */
  778. batchSegmentJobArn?: Arn;
  779. /**
  780. * The ARN of the filter used on the batch segment job.
  781. */
  782. filterArn?: Arn;
  783. /**
  784. * If the batch segment job failed, the reason for the failure.
  785. */
  786. failureReason?: FailureReason;
  787. /**
  788. * The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
  789. */
  790. solutionVersionArn?: Arn;
  791. /**
  792. * The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
  793. */
  794. numResults?: NumBatchResults;
  795. /**
  796. * The Amazon S3 path that leads to the input data used to generate the batch segment job.
  797. */
  798. jobInput?: BatchSegmentJobInput;
  799. /**
  800. * The Amazon S3 bucket that contains the output data generated by the batch segment job.
  801. */
  802. jobOutput?: BatchSegmentJobOutput;
  803. /**
  804. * The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
  805. */
  806. roleArn?: RoleArn;
  807. /**
  808. * The status of the batch segment job. The status is one of the following values: PENDING IN PROGRESS ACTIVE CREATE FAILED
  809. */
  810. status?: Status;
  811. /**
  812. * The time at which the batch segment job was created.
  813. */
  814. creationDateTime?: _Date;
  815. /**
  816. * The time at which the batch segment job last updated.
  817. */
  818. lastUpdatedDateTime?: _Date;
  819. }
  820. export interface BatchSegmentJobInput {
  821. s3DataSource: S3DataConfig;
  822. }
  823. export interface BatchSegmentJobOutput {
  824. s3DataDestination: S3DataConfig;
  825. }
  826. export interface BatchSegmentJobSummary {
  827. /**
  828. * The Amazon Resource Name (ARN) of the batch segment job.
  829. */
  830. batchSegmentJobArn?: Arn;
  831. /**
  832. * The name of the batch segment job.
  833. */
  834. jobName?: Name;
  835. /**
  836. * The status of the batch segment job. The status is one of the following values: PENDING IN PROGRESS ACTIVE CREATE FAILED
  837. */
  838. status?: Status;
  839. /**
  840. * The time at which the batch segment job was created.
  841. */
  842. creationDateTime?: _Date;
  843. /**
  844. * The time at which the batch segment job was last updated.
  845. */
  846. lastUpdatedDateTime?: _Date;
  847. /**
  848. * If the batch segment job failed, the reason for the failure.
  849. */
  850. failureReason?: FailureReason;
  851. /**
  852. * The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
  853. */
  854. solutionVersionArn?: Arn;
  855. }
  856. export type BatchSegmentJobs = BatchSegmentJobSummary[];
  857. export type Boolean = boolean;
  858. export interface Campaign {
  859. /**
  860. * The name of the campaign.
  861. */
  862. name?: Name;
  863. /**
  864. * The Amazon Resource Name (ARN) of the campaign.
  865. */
  866. campaignArn?: Arn;
  867. /**
  868. * The Amazon Resource Name (ARN) of the solution version the campaign uses.
  869. */
  870. solutionVersionArn?: Arn;
  871. /**
  872. * Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.
  873. */
  874. minProvisionedTPS?: TransactionsPerSecond;
  875. /**
  876. * The configuration details of a campaign.
  877. */
  878. campaignConfig?: CampaignConfig;
  879. /**
  880. * The status of the campaign. A campaign can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
  881. */
  882. status?: Status;
  883. /**
  884. * If a campaign fails, the reason behind the failure.
  885. */
  886. failureReason?: FailureReason;
  887. /**
  888. * The date and time (in Unix format) that the campaign was created.
  889. */
  890. creationDateTime?: _Date;
  891. /**
  892. * The date and time (in Unix format) that the campaign was last updated.
  893. */
  894. lastUpdatedDateTime?: _Date;
  895. latestCampaignUpdate?: CampaignUpdateSummary;
  896. }
  897. export interface CampaignConfig {
  898. /**
  899. * Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.
  900. */
  901. itemExplorationConfig?: HyperParameters;
  902. /**
  903. * Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.
  904. */
  905. enableMetadataWithRecommendations?: Boolean;
  906. /**
  907. * Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version. For more information about automatic campaign updates, see Enabling automatic campaign updates.
  908. */
  909. syncWithLatestSolutionVersion?: Boolean;
  910. }
  911. export interface CampaignSummary {
  912. /**
  913. * The name of the campaign.
  914. */
  915. name?: Name;
  916. /**
  917. * The Amazon Resource Name (ARN) of the campaign.
  918. */
  919. campaignArn?: Arn;
  920. /**
  921. * The status of the campaign. A campaign can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
  922. */
  923. status?: Status;
  924. /**
  925. * The date and time (in Unix time) that the campaign was created.
  926. */
  927. creationDateTime?: _Date;
  928. /**
  929. * The date and time (in Unix time) that the campaign was last updated.
  930. */
  931. lastUpdatedDateTime?: _Date;
  932. /**
  933. * If a campaign fails, the reason behind the failure.
  934. */
  935. failureReason?: FailureReason;
  936. }
  937. export interface CampaignUpdateSummary {
  938. /**
  939. * The Amazon Resource Name (ARN) of the deployed solution version.
  940. */
  941. solutionVersionArn?: Arn;
  942. /**
  943. * Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
  944. */
  945. minProvisionedTPS?: TransactionsPerSecond;
  946. campaignConfig?: CampaignConfig;
  947. /**
  948. * The status of the campaign update. A campaign update can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
  949. */
  950. status?: Status;
  951. /**
  952. * If a campaign update fails, the reason behind the failure.
  953. */
  954. failureReason?: FailureReason;
  955. /**
  956. * The date and time (in Unix time) that the campaign update was created.
  957. */
  958. creationDateTime?: _Date;
  959. /**
  960. * The date and time (in Unix time) that the campaign update was last updated.
  961. */
  962. lastUpdatedDateTime?: _Date;
  963. }
  964. export type Campaigns = CampaignSummary[];
  965. export interface CategoricalHyperParameterRange {
  966. /**
  967. * The name of the hyperparameter.
  968. */
  969. name?: ParameterName;
  970. /**
  971. * A list of the categories for the hyperparameter.
  972. */
  973. values?: CategoricalValues;
  974. }
  975. export type CategoricalHyperParameterRanges = CategoricalHyperParameterRange[];
  976. export type CategoricalValue = string;
  977. export type CategoricalValues = CategoricalValue[];
  978. export type ColumnName = string;
  979. export type ColumnNamesList = ColumnName[];
  980. export interface ContinuousHyperParameterRange {
  981. /**
  982. * The name of the hyperparameter.
  983. */
  984. name?: ParameterName;
  985. /**
  986. * The minimum allowable value for the hyperparameter.
  987. */
  988. minValue?: ContinuousMinValue;
  989. /**
  990. * The maximum allowable value for the hyperparameter.
  991. */
  992. maxValue?: ContinuousMaxValue;
  993. }
  994. export type ContinuousHyperParameterRanges = ContinuousHyperParameterRange[];
  995. export type ContinuousMaxValue = number;
  996. export type ContinuousMinValue = number;
  997. export interface CreateBatchInferenceJobRequest {
  998. /**
  999. * The name of the batch inference job to create.
  1000. */
  1001. jobName: Name;
  1002. /**
  1003. * The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
  1004. */
  1005. solutionVersionArn: Arn;
  1006. /**
  1007. * The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
  1008. */
  1009. filterArn?: Arn;
  1010. /**
  1011. * The number of recommendations to retrieve.
  1012. */
  1013. numResults?: NumBatchResults;
  1014. /**
  1015. * The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.
  1016. */
  1017. jobInput: BatchInferenceJobInput;
  1018. /**
  1019. * The path to the Amazon S3 bucket where the job's output will be stored.
  1020. */
  1021. jobOutput: BatchInferenceJobOutput;
  1022. /**
  1023. * The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
  1024. */
  1025. roleArn: RoleArn;
  1026. /**
  1027. * The configuration details of a batch inference job.
  1028. */
  1029. batchInferenceJobConfig?: BatchInferenceJobConfig;
  1030. /**
  1031. * A list of tags to apply to the batch inference job.
  1032. */
  1033. tags?: Tags;
  1034. /**
  1035. * The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE. When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.
  1036. */
  1037. batchInferenceJobMode?: BatchInferenceJobMode;
  1038. /**
  1039. * For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
  1040. */
  1041. themeGenerationConfig?: ThemeGenerationConfig;
  1042. }
  1043. export interface CreateBatchInferenceJobResponse {
  1044. /**
  1045. * The ARN of the batch inference job.
  1046. */
  1047. batchInferenceJobArn?: Arn;
  1048. }
  1049. export interface CreateBatchSegmentJobRequest {
  1050. /**
  1051. * The name of the batch segment job to create.
  1052. */
  1053. jobName: Name;
  1054. /**
  1055. * The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
  1056. */
  1057. solutionVersionArn: Arn;
  1058. /**
  1059. * The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.
  1060. */
  1061. filterArn?: Arn;
  1062. /**
  1063. * The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
  1064. */
  1065. numResults?: NumBatchResults;
  1066. /**
  1067. * The Amazon S3 path for the input data used to generate the batch segment job.
  1068. */
  1069. jobInput: BatchSegmentJobInput;
  1070. /**
  1071. * The Amazon S3 path for the bucket where the job's output will be stored.
  1072. */
  1073. jobOutput: BatchSegmentJobOutput;
  1074. /**
  1075. * The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
  1076. */
  1077. roleArn: RoleArn;
  1078. /**
  1079. * A list of tags to apply to the batch segment job.
  1080. */
  1081. tags?: Tags;
  1082. }
  1083. export interface CreateBatchSegmentJobResponse {
  1084. /**
  1085. * The ARN of the batch segment job.
  1086. */
  1087. batchSegmentJobArn?: Arn;
  1088. }
  1089. export interface CreateCampaignRequest {
  1090. /**
  1091. * A name for the new campaign. The campaign name must be unique within your account.
  1092. */
  1093. name: Name;
  1094. /**
  1095. * The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig. To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version. For more information about automatic campaign updates, see Enabling automatic campaign updates.
  1096. */
  1097. solutionVersionArn: Arn;
  1098. /**
  1099. * Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.
  1100. */
  1101. minProvisionedTPS?: TransactionsPerSecond;
  1102. /**
  1103. * The configuration details of a campaign.
  1104. */
  1105. campaignConfig?: CampaignConfig;
  1106. /**
  1107. * A list of tags to apply to the campaign.
  1108. */
  1109. tags?: Tags;
  1110. }
  1111. export interface CreateCampaignResponse {
  1112. /**
  1113. * The Amazon Resource Name (ARN) of the campaign.
  1114. */
  1115. campaignArn?: Arn;
  1116. }
  1117. export interface CreateDataDeletionJobRequest {
  1118. /**
  1119. * The name for the data deletion job.
  1120. */
  1121. jobName: Name;
  1122. /**
  1123. * The Amazon Resource Name (ARN) of the dataset group that has the datasets you want to delete records from.
  1124. */
  1125. datasetGroupArn: Arn;
  1126. /**
  1127. * The Amazon S3 bucket that contains the list of userIds of the users to delete.
  1128. */
  1129. dataSource: DataSource;
  1130. /**
  1131. * The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.
  1132. */
  1133. roleArn: RoleArn;
  1134. /**
  1135. * A list of tags to apply to the data deletion job.
  1136. */
  1137. tags?: Tags;
  1138. }
  1139. export interface CreateDataDeletionJobResponse {
  1140. /**
  1141. * The Amazon Resource Name (ARN) of the data deletion job.
  1142. */
  1143. dataDeletionJobArn?: Arn;
  1144. }
  1145. export interface CreateDatasetExportJobRequest {
  1146. /**
  1147. * The name for the dataset export job.
  1148. */
  1149. jobName: Name;
  1150. /**
  1151. * The Amazon Resource Name (ARN) of the dataset that contains the data to export.
  1152. */
  1153. datasetArn: Arn;
  1154. /**
  1155. * The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.
  1156. */
  1157. ingestionMode?: IngestionMode;
  1158. /**
  1159. * The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
  1160. */
  1161. roleArn: RoleArn;
  1162. /**
  1163. * The path to the Amazon S3 bucket where the job's output is stored.
  1164. */
  1165. jobOutput: DatasetExportJobOutput;
  1166. /**
  1167. * A list of tags to apply to the dataset export job.
  1168. */
  1169. tags?: Tags;
  1170. }
  1171. export interface CreateDatasetExportJobResponse {
  1172. /**
  1173. * The Amazon Resource Name (ARN) of the dataset export job.
  1174. */
  1175. datasetExportJobArn?: Arn;
  1176. }
  1177. export interface CreateDatasetGroupRequest {
  1178. /**
  1179. * The name for the new dataset group.
  1180. */
  1181. name: Name;
  1182. /**
  1183. * The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
  1184. */
  1185. roleArn?: RoleArn;
  1186. /**
  1187. * The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.
  1188. */
  1189. kmsKeyArn?: KmsKeyArn;
  1190. /**
  1191. * The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.
  1192. */
  1193. domain?: Domain;
  1194. /**
  1195. * A list of tags to apply to the dataset group.
  1196. */
  1197. tags?: Tags;
  1198. }
  1199. export interface CreateDatasetGroupResponse {
  1200. /**
  1201. * The Amazon Resource Name (ARN) of the new dataset group.
  1202. */
  1203. datasetGroupArn?: Arn;
  1204. /**
  1205. * The domain for the new Domain dataset group.
  1206. */
  1207. domain?: Domain;
  1208. }
  1209. export interface CreateDatasetImportJobRequest {
  1210. /**
  1211. * The name for the dataset import job.
  1212. */
  1213. jobName: Name;
  1214. /**
  1215. * The ARN of the dataset that receives the imported data.
  1216. */
  1217. datasetArn: Arn;
  1218. /**
  1219. * The Amazon S3 bucket that contains the training data to import.
  1220. */
  1221. dataSource: DataSource;
  1222. /**
  1223. * The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
  1224. */
  1225. roleArn: RoleArn;
  1226. /**
  1227. * A list of tags to apply to the dataset import job.
  1228. */
  1229. tags?: Tags;
  1230. /**
  1231. * Specify how to add the new records to an existing dataset. The default import mode is FULL. If you haven't imported bulk records into the dataset previously, you can only specify FULL. Specify FULL to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. Specify INCREMENTAL to append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.
  1232. */
  1233. importMode?: ImportMode;
  1234. /**
  1235. * If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3
  1236. */
  1237. publishAttributionMetricsToS3?: Boolean;
  1238. }
  1239. export interface CreateDatasetImportJobResponse {
  1240. /**
  1241. * The ARN of the dataset import job.
  1242. */
  1243. datasetImportJobArn?: Arn;
  1244. }
  1245. export interface CreateDatasetRequest {
  1246. /**
  1247. * The name for the dataset.
  1248. */
  1249. name: Name;
  1250. /**
  1251. * The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
  1252. */
  1253. schemaArn: Arn;
  1254. /**
  1255. * The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
  1256. */
  1257. datasetGroupArn: Arn;
  1258. /**
  1259. * The type of dataset. One of the following (case insensitive) values: Interactions Items Users Actions Action_Interactions
  1260. */
  1261. datasetType: DatasetType;
  1262. /**
  1263. * A list of tags to apply to the dataset.
  1264. */
  1265. tags?: Tags;
  1266. }
  1267. export interface CreateDatasetResponse {
  1268. /**
  1269. * The ARN of the dataset.
  1270. */
  1271. datasetArn?: Arn;
  1272. }
  1273. export interface CreateEventTrackerRequest {
  1274. /**
  1275. * The name for the event tracker.
  1276. */
  1277. name: Name;
  1278. /**
  1279. * The Amazon Resource Name (ARN) of the dataset group that receives the event data.
  1280. */
  1281. datasetGroupArn: Arn;
  1282. /**
  1283. * A list of tags to apply to the event tracker.
  1284. */
  1285. tags?: Tags;
  1286. }
  1287. export interface CreateEventTrackerResponse {
  1288. /**
  1289. * The ARN of the event tracker.
  1290. */
  1291. eventTrackerArn?: Arn;
  1292. /**
  1293. * The ID of the event tracker. Include this ID in requests to the PutEvents API.
  1294. */
  1295. trackingId?: TrackingId;
  1296. }
  1297. export interface CreateFilterRequest {
  1298. /**
  1299. * The name of the filter to create.
  1300. */
  1301. name: Name;
  1302. /**
  1303. * The ARN of the dataset group that the filter will belong to.
  1304. */
  1305. datasetGroupArn: Arn;
  1306. /**
  1307. * The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.
  1308. */
  1309. filterExpression: FilterExpression;
  1310. /**
  1311. * A list of tags to apply to the filter.
  1312. */
  1313. tags?: Tags;
  1314. }
  1315. export interface CreateFilterResponse {
  1316. /**
  1317. * The ARN of the new filter.
  1318. */
  1319. filterArn?: Arn;
  1320. }
  1321. export interface CreateMetricAttributionRequest {
  1322. /**
  1323. * A name for the metric attribution.
  1324. */
  1325. name: Name;
  1326. /**
  1327. * The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.
  1328. */
  1329. datasetGroupArn: Arn;
  1330. /**
  1331. * A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
  1332. */
  1333. metrics: MetricAttributes;
  1334. /**
  1335. * The output configuration details for the metric attribution.
  1336. */
  1337. metricsOutputConfig: MetricAttributionOutput;
  1338. }
  1339. export interface CreateMetricAttributionResponse {
  1340. /**
  1341. * The Amazon Resource Name (ARN) for the new metric attribution.
  1342. */
  1343. metricAttributionArn?: Arn;
  1344. }
  1345. export interface CreateRecommenderRequest {
  1346. /**
  1347. * The name of the recommender.
  1348. */
  1349. name: Name;
  1350. /**
  1351. * The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.
  1352. */
  1353. datasetGroupArn: Arn;
  1354. /**
  1355. * The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.
  1356. */
  1357. recipeArn: Arn;
  1358. /**
  1359. * The configuration details of the recommender.
  1360. */
  1361. recommenderConfig?: RecommenderConfig;
  1362. /**
  1363. * A list of tags to apply to the recommender.
  1364. */
  1365. tags?: Tags;
  1366. }
  1367. export interface CreateRecommenderResponse {
  1368. /**
  1369. * The Amazon Resource Name (ARN) of the recommender.
  1370. */
  1371. recommenderArn?: Arn;
  1372. }
  1373. export interface CreateSchemaRequest {
  1374. /**
  1375. * The name for the schema.
  1376. */
  1377. name: Name;
  1378. /**
  1379. * A schema in Avro JSON format.
  1380. */
  1381. schema: AvroSchema;
  1382. /**
  1383. * The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.
  1384. */
  1385. domain?: Domain;
  1386. }
  1387. export interface CreateSchemaResponse {
  1388. /**
  1389. * The Amazon Resource Name (ARN) of the created schema.
  1390. */
  1391. schemaArn?: Arn;
  1392. }
  1393. export interface CreateSolutionRequest {
  1394. /**
  1395. * The name for the solution.
  1396. */
  1397. name: Name;
  1398. /**
  1399. * Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false. When performing AutoML, this parameter is always true and you should not set it to false.
  1400. */
  1401. performHPO?: Boolean;
  1402. /**
  1403. * We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Choosing a recipe. Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn. When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
  1404. */
  1405. performAutoML?: PerformAutoML;
  1406. /**
  1407. * Whether the solution uses automatic training to create new solution versions (trained models). The default is True and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration. For more information about automatic training, see Configuring automatic training. Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.
  1408. */
  1409. performAutoTraining?: PerformAutoTraining;
  1410. /**
  1411. * The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when performAutoML is false. For information about different Amazon Personalize recipes and their ARNs, see Choosing a recipe.
  1412. */
  1413. recipeArn?: Arn;
  1414. /**
  1415. * The Amazon Resource Name (ARN) of the dataset group that provides the training data.
  1416. */
  1417. datasetGroupArn: Arn;
  1418. /**
  1419. * When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model. If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.
  1420. */
  1421. eventType?: EventType;
  1422. /**
  1423. * The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration. Amazon Personalize doesn't support configuring the hpoObjective at this time.
  1424. */
  1425. solutionConfig?: SolutionConfig;
  1426. /**
  1427. * A list of tags to apply to the solution.
  1428. */
  1429. tags?: Tags;
  1430. }
  1431. export interface CreateSolutionResponse {
  1432. /**
  1433. * The ARN of the solution.
  1434. */
  1435. solutionArn?: Arn;
  1436. }
  1437. export interface CreateSolutionVersionRequest {
  1438. /**
  1439. * The name of the solution version.
  1440. */
  1441. name?: Name;
  1442. /**
  1443. * The Amazon Resource Name (ARN) of the solution containing the training configuration information.
  1444. */
  1445. solutionArn: Arn;
  1446. /**
  1447. * The scope of training to be performed when creating the solution version. The default is FULL. This creates a completely new model based on the entirety of the training data from the datasets in your dataset group. If you use User-Personalization, you can specify a training mode of UPDATE. This updates the model to consider new items for recommendations. It is not a full retraining. You should still complete a full retraining weekly. If you specify UPDATE, Amazon Personalize will stop automatic updates for the solution version. To resume updates, create a new solution with training mode set to FULL and deploy it in a campaign. For more information about automatic updates, see Automatic updates. The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the legacy HRNN-Coldstart recipe.
  1448. */
  1449. trainingMode?: TrainingMode;
  1450. /**
  1451. * A list of tags to apply to the solution version.
  1452. */
  1453. tags?: Tags;
  1454. }
  1455. export interface CreateSolutionVersionResponse {
  1456. /**
  1457. * The ARN of the new solution version.
  1458. */
  1459. solutionVersionArn?: Arn;
  1460. }
  1461. export interface DataDeletionJob {
  1462. /**
  1463. * The name of the data deletion job.
  1464. */
  1465. jobName?: Name;
  1466. /**
  1467. * The Amazon Resource Name (ARN) of the data deletion job.
  1468. */
  1469. dataDeletionJobArn?: Arn;
  1470. /**
  1471. * The Amazon Resource Name (ARN) of the dataset group the job deletes records from.
  1472. */
  1473. datasetGroupArn?: Arn;
  1474. dataSource?: DataSource;
  1475. /**
  1476. * The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.
  1477. */
  1478. roleArn?: RoleArn;
  1479. /**
  1480. * The status of the data deletion job. A data deletion job can have one of the following statuses: PENDING &gt; IN_PROGRESS &gt; COMPLETED -or- FAILED
  1481. */
  1482. status?: Status;
  1483. /**
  1484. * The number of records deleted by a COMPLETED job.
  1485. */
  1486. numDeleted?: Integer;
  1487. /**
  1488. * The creation date and time (in Unix time) of the data deletion job.
  1489. */
  1490. creationDateTime?: _Date;
  1491. /**
  1492. * The date and time (in Unix time) the data deletion job was last updated.
  1493. */
  1494. lastUpdatedDateTime?: _Date;
  1495. /**
  1496. * If a data deletion job fails, provides the reason why.
  1497. */
  1498. failureReason?: FailureReason;
  1499. }
  1500. export interface DataDeletionJobSummary {
  1501. /**
  1502. * The Amazon Resource Name (ARN) of the data deletion job.
  1503. */
  1504. dataDeletionJobArn?: Arn;
  1505. /**
  1506. * The Amazon Resource Name (ARN) of the dataset group the job deleted records from.
  1507. */
  1508. datasetGroupArn?: Arn;
  1509. /**
  1510. * The name of the data deletion job.
  1511. */
  1512. jobName?: Name;
  1513. /**
  1514. * The status of the data deletion job. A data deletion job can have one of the following statuses: PENDING &gt; IN_PROGRESS &gt; COMPLETED -or- FAILED
  1515. */
  1516. status?: Status;
  1517. /**
  1518. * The creation date and time (in Unix time) of the data deletion job.
  1519. */
  1520. creationDateTime?: _Date;
  1521. /**
  1522. * The date and time (in Unix time) the data deletion job was last updated.
  1523. */
  1524. lastUpdatedDateTime?: _Date;
  1525. /**
  1526. * If a data deletion job fails, provides the reason why.
  1527. */
  1528. failureReason?: FailureReason;
  1529. }
  1530. export type DataDeletionJobs = DataDeletionJobSummary[];
  1531. export interface DataSource {
  1532. /**
  1533. * For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete. For example: s3://bucket-name/folder-name/fileName.csv If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a / after the folder name: s3://bucket-name/folder-name/
  1534. */
  1535. dataLocation?: S3Location;
  1536. }
  1537. export interface Dataset {
  1538. /**
  1539. * The name of the dataset.
  1540. */
  1541. name?: Name;
  1542. /**
  1543. * The Amazon Resource Name (ARN) of the dataset that you want metadata for.
  1544. */
  1545. datasetArn?: Arn;
  1546. /**
  1547. * The Amazon Resource Name (ARN) of the dataset group.
  1548. */
  1549. datasetGroupArn?: Arn;
  1550. /**
  1551. * One of the following values: Interactions Items Users Actions Action_Interactions
  1552. */
  1553. datasetType?: DatasetType;
  1554. /**
  1555. * The ARN of the associated schema.
  1556. */
  1557. schemaArn?: Arn;
  1558. /**
  1559. * The status of the dataset. A dataset can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
  1560. */
  1561. status?: Status;
  1562. /**
  1563. * The creation date and time (in Unix time) of the dataset.
  1564. */
  1565. creationDateTime?: _Date;
  1566. /**
  1567. * A time stamp that shows when the dataset was updated.
  1568. */
  1569. lastUpdatedDateTime?: _Date;
  1570. /**
  1571. * Describes the latest update to the dataset.
  1572. */
  1573. latestDatasetUpdate?: DatasetUpdateSummary;
  1574. /**
  1575. * The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.
  1576. */
  1577. trackingId?: TrackingId;
  1578. }
  1579. export interface DatasetExportJob {
  1580. /**
  1581. * The name of the export job.
  1582. */
  1583. jobName?: Name;
  1584. /**
  1585. * The Amazon Resource Name (ARN) of the dataset export job.
  1586. */
  1587. datasetExportJobArn?: Arn;
  1588. /**
  1589. * The Amazon Resource Name (ARN) of the dataset to export.
  1590. */
  1591. datasetArn?: Arn;
  1592. /**
  1593. * The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.
  1594. */
  1595. ingestionMode?: IngestionMode;
  1596. /**
  1597. * The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
  1598. */
  1599. roleArn?: Arn;
  1600. /**
  1601. * The status of the dataset export job. A dataset export job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED
  1602. */
  1603. status?: Status;
  1604. /**
  1605. * The path to the Amazon S3 bucket where the job's output is stored. For example: s3://bucket-name/folder-name/
  1606. */
  1607. jobOutput?: DatasetExportJobOutput;
  1608. /**
  1609. * The creation date and time (in Unix time) of the dataset export job.
  1610. */
  1611. creationDateTime?: _Date;
  1612. /**
  1613. * The date and time (in Unix time) the status of the dataset export job was last updated.
  1614. */
  1615. lastUpdatedDateTime?: _Date;
  1616. /**
  1617. * If a dataset export job fails, provides the reason why.
  1618. */
  1619. failureReason?: FailureReason;
  1620. }
  1621. export interface DatasetExportJobOutput {
  1622. s3DataDestination: S3DataConfig;
  1623. }
  1624. export interface DatasetExportJobSummary {
  1625. /**
  1626. * The Amazon Resource Name (ARN) of the dataset export job.
  1627. */
  1628. datasetExportJobArn?: Arn;
  1629. /**
  1630. * The name of the dataset export job.
  1631. */
  1632. jobName?: Name;
  1633. /**
  1634. * The status of the dataset export job. A dataset export job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED
  1635. */
  1636. status?: Status;
  1637. /**
  1638. * The date and time (in Unix time) that the dataset export job was created.
  1639. */
  1640. creationDateTime?: _Date;
  1641. /**
  1642. * The date and time (in Unix time) that the dataset export job status was last updated.
  1643. */
  1644. lastUpdatedDateTime?: _Date;
  1645. /**
  1646. * If a dataset export job fails, the reason behind the failure.
  1647. */
  1648. failureReason?: FailureReason;
  1649. }
  1650. export type DatasetExportJobs = DatasetExportJobSummary[];
  1651. export interface DatasetGroup {
  1652. /**
  1653. * The name of the dataset group.
  1654. */
  1655. name?: Name;
  1656. /**
  1657. * The Amazon Resource Name (ARN) of the dataset group.
  1658. */
  1659. datasetGroupArn?: Arn;
  1660. /**
  1661. * The current status of the dataset group. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING
  1662. */
  1663. status?: Status;
  1664. /**
  1665. * The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
  1666. */
  1667. roleArn?: RoleArn;
  1668. /**
  1669. * The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.
  1670. */
  1671. kmsKeyArn?: KmsKeyArn;
  1672. /**
  1673. * The creation date and time (in Unix time) of the dataset group.
  1674. */
  1675. creationDateTime?: _Date;
  1676. /**
  1677. * The last update date and time (in Unix time) of the dataset group.
  1678. */
  1679. lastUpdatedDateTime?: _Date;
  1680. /**
  1681. * If creating a dataset group fails, provides the reason why.
  1682. */
  1683. failureReason?: FailureReason;
  1684. /**
  1685. * The domain of a Domain dataset group.
  1686. */
  1687. domain?: Domain;
  1688. }
  1689. export interface DatasetGroupSummary {
  1690. /**
  1691. * The name of the dataset group.
  1692. */
  1693. name?: Name;
  1694. /**
  1695. * The Amazon Resource Name (ARN) of the dataset group.
  1696. */
  1697. datasetGroupArn?: Arn;
  1698. /**
  1699. * The status of the dataset group. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING
  1700. */
  1701. status?: Status;
  1702. /**
  1703. * The date and time (in Unix time) that the dataset group was created.
  1704. */
  1705. creationDateTime?: _Date;
  1706. /**
  1707. * The date and time (in Unix time) that the dataset group was last updated.
  1708. */
  1709. lastUpdatedDateTime?: _Date;
  1710. /**
  1711. * If creating a dataset group fails, the reason behind the failure.
  1712. */
  1713. failureReason?: FailureReason;
  1714. /**
  1715. * The domain of a Domain dataset group.
  1716. */
  1717. domain?: Domain;
  1718. }
  1719. export type DatasetGroups = DatasetGroupSummary[];
  1720. export interface DatasetImportJob {
  1721. /**
  1722. * The name of the import job.
  1723. */
  1724. jobName?: Name;
  1725. /**
  1726. * The ARN of the dataset import job.
  1727. */
  1728. datasetImportJobArn?: Arn;
  1729. /**
  1730. * The Amazon Resource Name (ARN) of the dataset that receives the imported data.
  1731. */
  1732. datasetArn?: Arn;
  1733. /**
  1734. * The Amazon S3 bucket that contains the training data to import.
  1735. */
  1736. dataSource?: DataSource;
  1737. /**
  1738. * The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
  1739. */
  1740. roleArn?: Arn;
  1741. /**
  1742. * The status of the dataset import job. A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED
  1743. */
  1744. status?: Status;
  1745. /**
  1746. * The creation date and time (in Unix time) of the dataset import job.
  1747. */
  1748. creationDateTime?: _Date;
  1749. /**
  1750. * The date and time (in Unix time) the dataset was last updated.
  1751. */
  1752. lastUpdatedDateTime?: _Date;
  1753. /**
  1754. * If a dataset import job fails, provides the reason why.
  1755. */
  1756. failureReason?: FailureReason;
  1757. /**
  1758. * The import mode used by the dataset import job to import new records.
  1759. */
  1760. importMode?: ImportMode;
  1761. /**
  1762. * Whether the job publishes metrics to Amazon S3 for a metric attribution.
  1763. */
  1764. publishAttributionMetricsToS3?: Boolean;
  1765. }
  1766. export interface DatasetImportJobSummary {
  1767. /**
  1768. * The Amazon Resource Name (ARN) of the dataset import job.
  1769. */
  1770. datasetImportJobArn?: Arn;
  1771. /**
  1772. * The name of the dataset import job.
  1773. */
  1774. jobName?: Name;
  1775. /**
  1776. * The status of the dataset import job. A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED
  1777. */
  1778. status?: Status;
  1779. /**
  1780. * The date and time (in Unix time) that the dataset import job was created.
  1781. */
  1782. creationDateTime?: _Date;
  1783. /**
  1784. * The date and time (in Unix time) that the dataset import job status was last updated.
  1785. */
  1786. lastUpdatedDateTime?: _Date;
  1787. /**
  1788. * If a dataset import job fails, the reason behind the failure.
  1789. */
  1790. failureReason?: FailureReason;
  1791. /**
  1792. * The import mode the dataset import job used to update the data in the dataset. For more information see Updating existing bulk data.
  1793. */
  1794. importMode?: ImportMode;
  1795. }
  1796. export type DatasetImportJobs = DatasetImportJobSummary[];
  1797. export interface DatasetSchema {
  1798. /**
  1799. * The name of the schema.
  1800. */
  1801. name?: Name;
  1802. /**
  1803. * The Amazon Resource Name (ARN) of the schema.
  1804. */
  1805. schemaArn?: Arn;
  1806. /**
  1807. * The schema.
  1808. */
  1809. schema?: AvroSchema;
  1810. /**
  1811. * The date and time (in Unix time) that the schema was created.
  1812. */
  1813. creationDateTime?: _Date;
  1814. /**
  1815. * The date and time (in Unix time) that the schema was last updated.
  1816. */
  1817. lastUpdatedDateTime?: _Date;
  1818. /**
  1819. * The domain of a schema that you created for a dataset in a Domain dataset group.
  1820. */
  1821. domain?: Domain;
  1822. }
  1823. export interface DatasetSchemaSummary {
  1824. /**
  1825. * The name of the schema.
  1826. */
  1827. name?: Name;
  1828. /**
  1829. * The Amazon Resource Name (ARN) of the schema.
  1830. */
  1831. schemaArn?: Arn;
  1832. /**
  1833. * The date and time (in Unix time) that the schema was created.
  1834. */
  1835. creationDateTime?: _Date;
  1836. /**
  1837. * The date and time (in Unix time) that the schema was last updated.
  1838. */
  1839. lastUpdatedDateTime?: _Date;
  1840. /**
  1841. * The domain of a schema that you created for a dataset in a Domain dataset group.
  1842. */
  1843. domain?: Domain;
  1844. }
  1845. export interface DatasetSummary {
  1846. /**
  1847. * The name of the dataset.
  1848. */
  1849. name?: Name;
  1850. /**
  1851. * The Amazon Resource Name (ARN) of the dataset.
  1852. */
  1853. datasetArn?: Arn;
  1854. /**
  1855. * The dataset type. One of the following values: Interactions Items Users Event-Interactions
  1856. */
  1857. datasetType?: DatasetType;
  1858. /**
  1859. * The status of the dataset. A dataset can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
  1860. */
  1861. status?: Status;
  1862. /**
  1863. * The date and time (in Unix time) that the dataset was created.
  1864. */
  1865. creationDateTime?: _Date;
  1866. /**
  1867. * The date and time (in Unix time) that the dataset was last updated.
  1868. */
  1869. lastUpdatedDateTime?: _Date;
  1870. }
  1871. export type DatasetType = string;
  1872. export interface DatasetUpdateSummary {
  1873. /**
  1874. * The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.
  1875. */
  1876. schemaArn?: Arn;
  1877. /**
  1878. * The status of the dataset update.
  1879. */
  1880. status?: Status;
  1881. /**
  1882. * If updating a dataset fails, provides the reason why.
  1883. */
  1884. failureReason?: FailureReason;
  1885. /**
  1886. * The creation date and time (in Unix time) of the dataset update.
  1887. */
  1888. creationDateTime?: _Date;
  1889. /**
  1890. * The last update date and time (in Unix time) of the dataset.
  1891. */
  1892. lastUpdatedDateTime?: _Date;
  1893. }
  1894. export type Datasets = DatasetSummary[];
  1895. export type _Date = Date;
  1896. export interface DefaultCategoricalHyperParameterRange {
  1897. /**
  1898. * The name of the hyperparameter.
  1899. */
  1900. name?: ParameterName;
  1901. /**
  1902. * A list of the categories for the hyperparameter.
  1903. */
  1904. values?: CategoricalValues;
  1905. /**
  1906. * Whether the hyperparameter is tunable.
  1907. */
  1908. isTunable?: Tunable;
  1909. }
  1910. export type DefaultCategoricalHyperParameterRanges = DefaultCategoricalHyperParameterRange[];
  1911. export interface DefaultContinuousHyperParameterRange {
  1912. /**
  1913. * The name of the hyperparameter.
  1914. */
  1915. name?: ParameterName;
  1916. /**
  1917. * The minimum allowable value for the hyperparameter.
  1918. */
  1919. minValue?: ContinuousMinValue;
  1920. /**
  1921. * The maximum allowable value for the hyperparameter.
  1922. */
  1923. maxValue?: ContinuousMaxValue;
  1924. /**
  1925. * Whether the hyperparameter is tunable.
  1926. */
  1927. isTunable?: Tunable;
  1928. }
  1929. export type DefaultContinuousHyperParameterRanges = DefaultContinuousHyperParameterRange[];
  1930. export interface DefaultHyperParameterRanges {
  1931. /**
  1932. * The integer-valued hyperparameters and their default ranges.
  1933. */
  1934. integerHyperParameterRanges?: DefaultIntegerHyperParameterRanges;
  1935. /**
  1936. * The continuous hyperparameters and their default ranges.
  1937. */
  1938. continuousHyperParameterRanges?: DefaultContinuousHyperParameterRanges;
  1939. /**
  1940. * The categorical hyperparameters and their default ranges.
  1941. */
  1942. categoricalHyperParameterRanges?: DefaultCategoricalHyperParameterRanges;
  1943. }
  1944. export interface DefaultIntegerHyperParameterRange {
  1945. /**
  1946. * The name of the hyperparameter.
  1947. */
  1948. name?: ParameterName;
  1949. /**
  1950. * The minimum allowable value for the hyperparameter.
  1951. */
  1952. minValue?: IntegerMinValue;
  1953. /**
  1954. * The maximum allowable value for the hyperparameter.
  1955. */
  1956. maxValue?: IntegerMaxValue;
  1957. /**
  1958. * Indicates whether the hyperparameter is tunable.
  1959. */
  1960. isTunable?: Tunable;
  1961. }
  1962. export type DefaultIntegerHyperParameterRanges = DefaultIntegerHyperParameterRange[];
  1963. export interface DeleteCampaignRequest {
  1964. /**
  1965. * The Amazon Resource Name (ARN) of the campaign to delete.
  1966. */
  1967. campaignArn: Arn;
  1968. }
  1969. export interface DeleteDatasetGroupRequest {
  1970. /**
  1971. * The ARN of the dataset group to delete.
  1972. */
  1973. datasetGroupArn: Arn;
  1974. }
  1975. export interface DeleteDatasetRequest {
  1976. /**
  1977. * The Amazon Resource Name (ARN) of the dataset to delete.
  1978. */
  1979. datasetArn: Arn;
  1980. }
  1981. export interface DeleteEventTrackerRequest {
  1982. /**
  1983. * The Amazon Resource Name (ARN) of the event tracker to delete.
  1984. */
  1985. eventTrackerArn: Arn;
  1986. }
  1987. export interface DeleteFilterRequest {
  1988. /**
  1989. * The ARN of the filter to delete.
  1990. */
  1991. filterArn: Arn;
  1992. }
  1993. export interface DeleteMetricAttributionRequest {
  1994. /**
  1995. * The metric attribution's Amazon Resource Name (ARN).
  1996. */
  1997. metricAttributionArn: Arn;
  1998. }
  1999. export interface DeleteRecommenderRequest {
  2000. /**
  2001. * The Amazon Resource Name (ARN) of the recommender to delete.
  2002. */
  2003. recommenderArn: Arn;
  2004. }
  2005. export interface DeleteSchemaRequest {
  2006. /**
  2007. * The Amazon Resource Name (ARN) of the schema to delete.
  2008. */
  2009. schemaArn: Arn;
  2010. }
  2011. export interface DeleteSolutionRequest {
  2012. /**
  2013. * The ARN of the solution to delete.
  2014. */
  2015. solutionArn: Arn;
  2016. }
  2017. export interface DescribeAlgorithmRequest {
  2018. /**
  2019. * The Amazon Resource Name (ARN) of the algorithm to describe.
  2020. */
  2021. algorithmArn: Arn;
  2022. }
  2023. export interface DescribeAlgorithmResponse {
  2024. /**
  2025. * A listing of the properties of the algorithm.
  2026. */
  2027. algorithm?: Algorithm;
  2028. }
  2029. export interface DescribeBatchInferenceJobRequest {
  2030. /**
  2031. * The ARN of the batch inference job to describe.
  2032. */
  2033. batchInferenceJobArn: Arn;
  2034. }
  2035. export interface DescribeBatchInferenceJobResponse {
  2036. /**
  2037. * Information on the specified batch inference job.
  2038. */
  2039. batchInferenceJob?: BatchInferenceJob;
  2040. }
  2041. export interface DescribeBatchSegmentJobRequest {
  2042. /**
  2043. * The ARN of the batch segment job to describe.
  2044. */
  2045. batchSegmentJobArn: Arn;
  2046. }
  2047. export interface DescribeBatchSegmentJobResponse {
  2048. /**
  2049. * Information on the specified batch segment job.
  2050. */
  2051. batchSegmentJob?: BatchSegmentJob;
  2052. }
  2053. export interface DescribeCampaignRequest {
  2054. /**
  2055. * The Amazon Resource Name (ARN) of the campaign.
  2056. */
  2057. campaignArn: Arn;
  2058. }
  2059. export interface DescribeCampaignResponse {
  2060. /**
  2061. * The properties of the campaign.
  2062. */
  2063. campaign?: Campaign;
  2064. }
  2065. export interface DescribeDataDeletionJobRequest {
  2066. /**
  2067. * The Amazon Resource Name (ARN) of the data deletion job.
  2068. */
  2069. dataDeletionJobArn: Arn;
  2070. }
  2071. export interface DescribeDataDeletionJobResponse {
  2072. /**
  2073. * Information about the data deletion job, including the status. The status is one of the following values: PENDING IN_PROGRESS COMPLETED FAILED
  2074. */
  2075. dataDeletionJob?: DataDeletionJob;
  2076. }
  2077. export interface DescribeDatasetExportJobRequest {
  2078. /**
  2079. * The Amazon Resource Name (ARN) of the dataset export job to describe.
  2080. */
  2081. datasetExportJobArn: Arn;
  2082. }
  2083. export interface DescribeDatasetExportJobResponse {
  2084. /**
  2085. * Information about the dataset export job, including the status. The status is one of the following values: CREATE PENDING CREATE IN_PROGRESS ACTIVE CREATE FAILED
  2086. */
  2087. datasetExportJob?: DatasetExportJob;
  2088. }
  2089. export interface DescribeDatasetGroupRequest {
  2090. /**
  2091. * The Amazon Resource Name (ARN) of the dataset group to describe.
  2092. */
  2093. datasetGroupArn: Arn;
  2094. }
  2095. export interface DescribeDatasetGroupResponse {
  2096. /**
  2097. * A listing of the dataset group's properties.
  2098. */
  2099. datasetGroup?: DatasetGroup;
  2100. }
  2101. export interface DescribeDatasetImportJobRequest {
  2102. /**
  2103. * The Amazon Resource Name (ARN) of the dataset import job to describe.
  2104. */
  2105. datasetImportJobArn: Arn;
  2106. }
  2107. export interface DescribeDatasetImportJobResponse {
  2108. /**
  2109. * Information about the dataset import job, including the status. The status is one of the following values: CREATE PENDING CREATE IN_PROGRESS ACTIVE CREATE FAILED
  2110. */
  2111. datasetImportJob?: DatasetImportJob;
  2112. }
  2113. export interface DescribeDatasetRequest {
  2114. /**
  2115. * The Amazon Resource Name (ARN) of the dataset to describe.
  2116. */
  2117. datasetArn: Arn;
  2118. }
  2119. export interface DescribeDatasetResponse {
  2120. /**
  2121. * A listing of the dataset's properties.
  2122. */
  2123. dataset?: Dataset;
  2124. }
  2125. export interface DescribeEventTrackerRequest {
  2126. /**
  2127. * The Amazon Resource Name (ARN) of the event tracker to describe.
  2128. */
  2129. eventTrackerArn: Arn;
  2130. }
  2131. export interface DescribeEventTrackerResponse {
  2132. /**
  2133. * An object that describes the event tracker.
  2134. */
  2135. eventTracker?: EventTracker;
  2136. }
  2137. export interface DescribeFeatureTransformationRequest {
  2138. /**
  2139. * The Amazon Resource Name (ARN) of the feature transformation to describe.
  2140. */
  2141. featureTransformationArn: Arn;
  2142. }
  2143. export interface DescribeFeatureTransformationResponse {
  2144. /**
  2145. * A listing of the FeatureTransformation properties.
  2146. */
  2147. featureTransformation?: FeatureTransformation;
  2148. }
  2149. export interface DescribeFilterRequest {
  2150. /**
  2151. * The ARN of the filter to describe.
  2152. */
  2153. filterArn: Arn;
  2154. }
  2155. export interface DescribeFilterResponse {
  2156. /**
  2157. * The filter's details.
  2158. */
  2159. filter?: Filter;
  2160. }
  2161. export interface DescribeMetricAttributionRequest {
  2162. /**
  2163. * The metric attribution's Amazon Resource Name (ARN).
  2164. */
  2165. metricAttributionArn: Arn;
  2166. }
  2167. export interface DescribeMetricAttributionResponse {
  2168. /**
  2169. * The details of the metric attribution.
  2170. */
  2171. metricAttribution?: MetricAttribution;
  2172. }
  2173. export interface DescribeRecipeRequest {
  2174. /**
  2175. * The Amazon Resource Name (ARN) of the recipe to describe.
  2176. */
  2177. recipeArn: Arn;
  2178. }
  2179. export interface DescribeRecipeResponse {
  2180. /**
  2181. * An object that describes the recipe.
  2182. */
  2183. recipe?: Recipe;
  2184. }
  2185. export interface DescribeRecommenderRequest {
  2186. /**
  2187. * The Amazon Resource Name (ARN) of the recommender to describe.
  2188. */
  2189. recommenderArn: Arn;
  2190. }
  2191. export interface DescribeRecommenderResponse {
  2192. /**
  2193. * The properties of the recommender.
  2194. */
  2195. recommender?: Recommender;
  2196. }
  2197. export interface DescribeSchemaRequest {
  2198. /**
  2199. * The Amazon Resource Name (ARN) of the schema to retrieve.
  2200. */
  2201. schemaArn: Arn;
  2202. }
  2203. export interface DescribeSchemaResponse {
  2204. /**
  2205. * The requested schema.
  2206. */
  2207. schema?: DatasetSchema;
  2208. }
  2209. export interface DescribeSolutionRequest {
  2210. /**
  2211. * The Amazon Resource Name (ARN) of the solution to describe.
  2212. */
  2213. solutionArn: Arn;
  2214. }
  2215. export interface DescribeSolutionResponse {
  2216. /**
  2217. * An object that describes the solution.
  2218. */
  2219. solution?: Solution;
  2220. }
  2221. export interface DescribeSolutionVersionRequest {
  2222. /**
  2223. * The Amazon Resource Name (ARN) of the solution version.
  2224. */
  2225. solutionVersionArn: Arn;
  2226. }
  2227. export interface DescribeSolutionVersionResponse {
  2228. /**
  2229. * The solution version.
  2230. */
  2231. solutionVersion?: SolutionVersion;
  2232. }
  2233. export type Description = string;
  2234. export type DockerURI = string;
  2235. export type Domain = "ECOMMERCE"|"VIDEO_ON_DEMAND"|string;
  2236. export interface EventTracker {
  2237. /**
  2238. * The name of the event tracker.
  2239. */
  2240. name?: Name;
  2241. /**
  2242. * The ARN of the event tracker.
  2243. */
  2244. eventTrackerArn?: Arn;
  2245. /**
  2246. * The Amazon Web Services account that owns the event tracker.
  2247. */
  2248. accountId?: AccountId;
  2249. /**
  2250. * The ID of the event tracker. Include this ID in requests to the PutEvents API.
  2251. */
  2252. trackingId?: TrackingId;
  2253. /**
  2254. * The Amazon Resource Name (ARN) of the dataset group that receives the event data.
  2255. */
  2256. datasetGroupArn?: Arn;
  2257. /**
  2258. * The status of the event tracker. An event tracker can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
  2259. */
  2260. status?: Status;
  2261. /**
  2262. * The date and time (in Unix format) that the event tracker was created.
  2263. */
  2264. creationDateTime?: _Date;
  2265. /**
  2266. * The date and time (in Unix time) that the event tracker was last updated.
  2267. */
  2268. lastUpdatedDateTime?: _Date;
  2269. }
  2270. export interface EventTrackerSummary {
  2271. /**
  2272. * The name of the event tracker.
  2273. */
  2274. name?: Name;
  2275. /**
  2276. * The Amazon Resource Name (ARN) of the event tracker.
  2277. */
  2278. eventTrackerArn?: Arn;
  2279. /**
  2280. * The status of the event tracker. An event tracker can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
  2281. */
  2282. status?: Status;
  2283. /**
  2284. * The date and time (in Unix time) that the event tracker was created.
  2285. */
  2286. creationDateTime?: _Date;
  2287. /**
  2288. * The date and time (in Unix time) that the event tracker was last updated.
  2289. */
  2290. lastUpdatedDateTime?: _Date;
  2291. }
  2292. export type EventTrackers = EventTrackerSummary[];
  2293. export type EventType = string;
  2294. export type EventValueThreshold = string;
  2295. export type ExcludedDatasetColumns = {[key: string]: ColumnNamesList};
  2296. export type FailureReason = string;
  2297. export interface FeatureTransformation {
  2298. /**
  2299. * The name of the feature transformation.
  2300. */
  2301. name?: Name;
  2302. /**
  2303. * The Amazon Resource Name (ARN) of the FeatureTransformation object.
  2304. */
  2305. featureTransformationArn?: Arn;
  2306. /**
  2307. * Provides the default parameters for feature transformation.
  2308. */
  2309. defaultParameters?: FeaturizationParameters;
  2310. /**
  2311. * The creation date and time (in Unix time) of the feature transformation.
  2312. */
  2313. creationDateTime?: _Date;
  2314. /**
  2315. * The last update date and time (in Unix time) of the feature transformation.
  2316. */
  2317. lastUpdatedDateTime?: _Date;
  2318. /**
  2319. * The status of the feature transformation. A feature transformation can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED
  2320. */
  2321. status?: Status;
  2322. }
  2323. export type FeatureTransformationParameters = {[key: string]: ParameterValue};
  2324. export type FeaturizationParameters = {[key: string]: ParameterValue};
  2325. export interface FieldsForThemeGeneration {
  2326. /**
  2327. * The name of the Items dataset column that stores the name of each item in the dataset.
  2328. */
  2329. itemName: ColumnName;
  2330. }
  2331. export interface Filter {
  2332. /**
  2333. * The name of the filter.
  2334. */
  2335. name?: Name;
  2336. /**
  2337. * The ARN of the filter.
  2338. */
  2339. filterArn?: Arn;
  2340. /**
  2341. * The time at which the filter was created.
  2342. */
  2343. creationDateTime?: _Date;
  2344. /**
  2345. * The time at which the filter was last updated.
  2346. */
  2347. lastUpdatedDateTime?: _Date;
  2348. /**
  2349. * The ARN of the dataset group to which the filter belongs.
  2350. */
  2351. datasetGroupArn?: Arn;
  2352. /**
  2353. * If the filter failed, the reason for its failure.
  2354. */
  2355. failureReason?: FailureReason;
  2356. /**
  2357. * Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.
  2358. */
  2359. filterExpression?: FilterExpression;
  2360. /**
  2361. * The status of the filter.
  2362. */
  2363. status?: Status;
  2364. }
  2365. export type FilterExpression = string;
  2366. export interface FilterSummary {
  2367. /**
  2368. * The name of the filter.
  2369. */
  2370. name?: Name;
  2371. /**
  2372. * The ARN of the filter.
  2373. */
  2374. filterArn?: Arn;
  2375. /**
  2376. * The time at which the filter was created.
  2377. */
  2378. creationDateTime?: _Date;
  2379. /**
  2380. * The time at which the filter was last updated.
  2381. */
  2382. lastUpdatedDateTime?: _Date;
  2383. /**
  2384. * The ARN of the dataset group to which the filter belongs.
  2385. */
  2386. datasetGroupArn?: Arn;
  2387. /**
  2388. * If the filter failed, the reason for the failure.
  2389. */
  2390. failureReason?: FailureReason;
  2391. /**
  2392. * The status of the filter.
  2393. */
  2394. status?: Status;
  2395. }
  2396. export type Filters = FilterSummary[];
  2397. export interface GetSolutionMetricsRequest {
  2398. /**
  2399. * The Amazon Resource Name (ARN) of the solution version for which to get metrics.
  2400. */
  2401. solutionVersionArn: Arn;
  2402. }
  2403. export interface GetSolutionMetricsResponse {
  2404. /**
  2405. * The same solution version ARN as specified in the request.
  2406. */
  2407. solutionVersionArn?: Arn;
  2408. /**
  2409. * The metrics for the solution version. For more information, see Evaluating a solution version with metrics .
  2410. */
  2411. metrics?: Metrics;
  2412. }
  2413. export interface HPOConfig {
  2414. /**
  2415. * The metric to optimize during HPO. Amazon Personalize doesn't support configuring the hpoObjective at this time.
  2416. */
  2417. hpoObjective?: HPOObjective;
  2418. /**
  2419. * Describes the resource configuration for HPO.
  2420. */
  2421. hpoResourceConfig?: HPOResourceConfig;
  2422. /**
  2423. * The hyperparameters and their allowable ranges.
  2424. */
  2425. algorithmHyperParameterRanges?: HyperParameterRanges;
  2426. }
  2427. export interface HPOObjective {
  2428. /**
  2429. * The type of the metric. Valid values are Maximize and Minimize.
  2430. */
  2431. type?: HPOObjectiveType;
  2432. /**
  2433. * The name of the metric.
  2434. */
  2435. metricName?: MetricName;
  2436. /**
  2437. * A regular expression for finding the metric in the training job logs.
  2438. */
  2439. metricRegex?: MetricRegex;
  2440. }
  2441. export type HPOObjectiveType = string;
  2442. export type HPOResource = string;
  2443. export interface HPOResourceConfig {
  2444. /**
  2445. * The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.
  2446. */
  2447. maxNumberOfTrainingJobs?: HPOResource;
  2448. /**
  2449. * The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.
  2450. */
  2451. maxParallelTrainingJobs?: HPOResource;
  2452. }
  2453. export interface HyperParameterRanges {
  2454. /**
  2455. * The integer-valued hyperparameters and their ranges.
  2456. */
  2457. integerHyperParameterRanges?: IntegerHyperParameterRanges;
  2458. /**
  2459. * The continuous hyperparameters and their ranges.
  2460. */
  2461. continuousHyperParameterRanges?: ContinuousHyperParameterRanges;
  2462. /**
  2463. * The categorical hyperparameters and their ranges.
  2464. */
  2465. categoricalHyperParameterRanges?: CategoricalHyperParameterRanges;
  2466. }
  2467. export type HyperParameters = {[key: string]: ParameterValue};
  2468. export type ImportMode = "FULL"|"INCREMENTAL"|string;
  2469. export type IngestionMode = "BULK"|"PUT"|"ALL"|string;
  2470. export type Integer = number;
  2471. export interface IntegerHyperParameterRange {
  2472. /**
  2473. * The name of the hyperparameter.
  2474. */
  2475. name?: ParameterName;
  2476. /**
  2477. * The minimum allowable value for the hyperparameter.
  2478. */
  2479. minValue?: IntegerMinValue;
  2480. /**
  2481. * The maximum allowable value for the hyperparameter.
  2482. */
  2483. maxValue?: IntegerMaxValue;
  2484. }
  2485. export type IntegerHyperParameterRanges = IntegerHyperParameterRange[];
  2486. export type IntegerMaxValue = number;
  2487. export type IntegerMinValue = number;
  2488. export type ItemAttribute = string;
  2489. export type KmsKeyArn = string;
  2490. export interface ListBatchInferenceJobsRequest {
  2491. /**
  2492. * The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.
  2493. */
  2494. solutionVersionArn?: Arn;
  2495. /**
  2496. * The token to request the next page of results.
  2497. */
  2498. nextToken?: NextToken;
  2499. /**
  2500. * The maximum number of batch inference job results to return in each page. The default value is 100.
  2501. */
  2502. maxResults?: MaxResults;
  2503. }
  2504. export interface ListBatchInferenceJobsResponse {
  2505. /**
  2506. * A list containing information on each job that is returned.
  2507. */
  2508. batchInferenceJobs?: BatchInferenceJobs;
  2509. /**
  2510. * The token to use to retrieve the next page of results. The value is null when there are no more results to return.
  2511. */
  2512. nextToken?: NextToken;
  2513. }
  2514. export interface ListBatchSegmentJobsRequest {
  2515. /**
  2516. * The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.
  2517. */
  2518. solutionVersionArn?: Arn;
  2519. /**
  2520. * The token to request the next page of results.
  2521. */
  2522. nextToken?: NextToken;
  2523. /**
  2524. * The maximum number of batch segment job results to return in each page. The default value is 100.
  2525. */
  2526. maxResults?: MaxResults;
  2527. }
  2528. export interface ListBatchSegmentJobsResponse {
  2529. /**
  2530. * A list containing information on each job that is returned.
  2531. */
  2532. batchSegmentJobs?: BatchSegmentJobs;
  2533. /**
  2534. * The token to use to retrieve the next page of results. The value is null when there are no more results to return.
  2535. */
  2536. nextToken?: NextToken;
  2537. }
  2538. export interface ListCampaignsRequest {
  2539. /**
  2540. * The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.
  2541. */
  2542. solutionArn?: Arn;
  2543. /**
  2544. * A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).
  2545. */
  2546. nextToken?: NextToken;
  2547. /**
  2548. * The maximum number of campaigns to return.
  2549. */
  2550. maxResults?: MaxResults;
  2551. }
  2552. export interface ListCampaignsResponse {
  2553. /**
  2554. * A list of the campaigns.
  2555. */
  2556. campaigns?: Campaigns;
  2557. /**
  2558. * A token for getting the next set of campaigns (if they exist).
  2559. */
  2560. nextToken?: NextToken;
  2561. }
  2562. export interface ListDataDeletionJobsRequest {
  2563. /**
  2564. * The Amazon Resource Name (ARN) of the dataset group to list data deletion jobs for.
  2565. */
  2566. datasetGroupArn?: Arn;
  2567. /**
  2568. * A token returned from the previous call to ListDataDeletionJobs for getting the next set of jobs (if they exist).
  2569. */
  2570. nextToken?: NextToken;
  2571. /**
  2572. * The maximum number of data deletion jobs to return.
  2573. */
  2574. maxResults?: MaxResults;
  2575. }
  2576. export interface ListDataDeletionJobsResponse {
  2577. /**
  2578. * The list of data deletion jobs.
  2579. */
  2580. dataDeletionJobs?: DataDeletionJobs;
  2581. /**
  2582. * A token for getting the next set of data deletion jobs (if they exist).
  2583. */
  2584. nextToken?: NextToken;
  2585. }
  2586. export interface ListDatasetExportJobsRequest {
  2587. /**
  2588. * The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.
  2589. */
  2590. datasetArn?: Arn;
  2591. /**
  2592. * A token returned from the previous call to ListDatasetExportJobs for getting the next set of dataset export jobs (if they exist).
  2593. */
  2594. nextToken?: NextToken;
  2595. /**
  2596. * The maximum number of dataset export jobs to return.
  2597. */
  2598. maxResults?: MaxResults;
  2599. }
  2600. export interface ListDatasetExportJobsResponse {
  2601. /**
  2602. * The list of dataset export jobs.
  2603. */
  2604. datasetExportJobs?: DatasetExportJobs;
  2605. /**
  2606. * A token for getting the next set of dataset export jobs (if they exist).
  2607. */
  2608. nextToken?: NextToken;
  2609. }
  2610. export interface ListDatasetGroupsRequest {
  2611. /**
  2612. * A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).
  2613. */
  2614. nextToken?: NextToken;
  2615. /**
  2616. * The maximum number of dataset groups to return.
  2617. */
  2618. maxResults?: MaxResults;
  2619. }
  2620. export interface ListDatasetGroupsResponse {
  2621. /**
  2622. * The list of your dataset groups.
  2623. */
  2624. datasetGroups?: DatasetGroups;
  2625. /**
  2626. * A token for getting the next set of dataset groups (if they exist).
  2627. */
  2628. nextToken?: NextToken;
  2629. }
  2630. export interface ListDatasetImportJobsRequest {
  2631. /**
  2632. * The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.
  2633. */
  2634. datasetArn?: Arn;
  2635. /**
  2636. * A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).
  2637. */
  2638. nextToken?: NextToken;
  2639. /**
  2640. * The maximum number of dataset import jobs to return.
  2641. */
  2642. maxResults?: MaxResults;
  2643. }
  2644. export interface ListDatasetImportJobsResponse {
  2645. /**
  2646. * The list of dataset import jobs.
  2647. */
  2648. datasetImportJobs?: DatasetImportJobs;
  2649. /**
  2650. * A token for getting the next set of dataset import jobs (if they exist).
  2651. */
  2652. nextToken?: NextToken;
  2653. }
  2654. export interface ListDatasetsRequest {
  2655. /**
  2656. * The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.
  2657. */
  2658. datasetGroupArn?: Arn;
  2659. /**
  2660. * A token returned from the previous call to ListDatasets for getting the next set of dataset import jobs (if they exist).
  2661. */
  2662. nextToken?: NextToken;
  2663. /**
  2664. * The maximum number of datasets to return.
  2665. */
  2666. maxResults?: MaxResults;
  2667. }
  2668. export interface ListDatasetsResponse {
  2669. /**
  2670. * An array of Dataset objects. Each object provides metadata information.
  2671. */
  2672. datasets?: Datasets;
  2673. /**
  2674. * A token for getting the next set of datasets (if they exist).
  2675. */
  2676. nextToken?: NextToken;
  2677. }
  2678. export interface ListEventTrackersRequest {
  2679. /**
  2680. * The ARN of a dataset group used to filter the response.
  2681. */
  2682. datasetGroupArn?: Arn;
  2683. /**
  2684. * A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).
  2685. */
  2686. nextToken?: NextToken;
  2687. /**
  2688. * The maximum number of event trackers to return.
  2689. */
  2690. maxResults?: MaxResults;
  2691. }
  2692. export interface ListEventTrackersResponse {
  2693. /**
  2694. * A list of event trackers.
  2695. */
  2696. eventTrackers?: EventTrackers;
  2697. /**
  2698. * A token for getting the next set of event trackers (if they exist).
  2699. */
  2700. nextToken?: NextToken;
  2701. }
  2702. export interface ListFiltersRequest {
  2703. /**
  2704. * The ARN of the dataset group that contains the filters.
  2705. */
  2706. datasetGroupArn?: Arn;
  2707. /**
  2708. * A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).
  2709. */
  2710. nextToken?: NextToken;
  2711. /**
  2712. * The maximum number of filters to return.
  2713. */
  2714. maxResults?: MaxResults;
  2715. }
  2716. export interface ListFiltersResponse {
  2717. /**
  2718. * A list of returned filters.
  2719. */
  2720. Filters?: Filters;
  2721. /**
  2722. * A token for getting the next set of filters (if they exist).
  2723. */
  2724. nextToken?: NextToken;
  2725. }
  2726. export interface ListMetricAttributionMetricsRequest {
  2727. /**
  2728. * The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.
  2729. */
  2730. metricAttributionArn?: Arn;
  2731. /**
  2732. * Specify the pagination token from a previous request to retrieve the next page of results.
  2733. */
  2734. nextToken?: NextToken;
  2735. /**
  2736. * The maximum number of metrics to return in one page of results.
  2737. */
  2738. maxResults?: MaxResults;
  2739. }
  2740. export interface ListMetricAttributionMetricsResponse {
  2741. /**
  2742. * The metrics for the specified metric attribution.
  2743. */
  2744. metrics?: MetricAttributes;
  2745. /**
  2746. * Specify the pagination token from a previous ListMetricAttributionMetricsResponse request to retrieve the next page of results.
  2747. */
  2748. nextToken?: NextToken;
  2749. }
  2750. export interface ListMetricAttributionsRequest {
  2751. /**
  2752. * The metric attributions' dataset group Amazon Resource Name (ARN).
  2753. */
  2754. datasetGroupArn?: Arn;
  2755. /**
  2756. * Specify the pagination token from a previous request to retrieve the next page of results.
  2757. */
  2758. nextToken?: NextToken;
  2759. /**
  2760. * The maximum number of metric attributions to return in one page of results.
  2761. */
  2762. maxResults?: MaxResults;
  2763. }
  2764. export interface ListMetricAttributionsResponse {
  2765. /**
  2766. * The list of metric attributions.
  2767. */
  2768. metricAttributions?: MetricAttributions;
  2769. /**
  2770. * Specify the pagination token from a previous request to retrieve the next page of results.
  2771. */
  2772. nextToken?: NextToken;
  2773. }
  2774. export interface ListRecipesRequest {
  2775. /**
  2776. * The default is SERVICE.
  2777. */
  2778. recipeProvider?: RecipeProvider;
  2779. /**
  2780. * A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).
  2781. */
  2782. nextToken?: NextToken;
  2783. /**
  2784. * The maximum number of recipes to return.
  2785. */
  2786. maxResults?: MaxResults;
  2787. /**
  2788. * Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.
  2789. */
  2790. domain?: Domain;
  2791. }
  2792. export interface ListRecipesResponse {
  2793. /**
  2794. * The list of available recipes.
  2795. */
  2796. recipes?: Recipes;
  2797. /**
  2798. * A token for getting the next set of recipes.
  2799. */
  2800. nextToken?: NextToken;
  2801. }
  2802. export interface ListRecommendersRequest {
  2803. /**
  2804. * The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
  2805. */
  2806. datasetGroupArn?: Arn;
  2807. /**
  2808. * A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).
  2809. */
  2810. nextToken?: NextToken;
  2811. /**
  2812. * The maximum number of recommenders to return.
  2813. */
  2814. maxResults?: MaxResults;
  2815. }
  2816. export interface ListRecommendersResponse {
  2817. /**
  2818. * A list of the recommenders.
  2819. */
  2820. recommenders?: Recommenders;
  2821. /**
  2822. * A token for getting the next set of recommenders (if they exist).
  2823. */
  2824. nextToken?: NextToken;
  2825. }
  2826. export interface ListSchemasRequest {
  2827. /**
  2828. * A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).
  2829. */
  2830. nextToken?: NextToken;
  2831. /**
  2832. * The maximum number of schemas to return.
  2833. */
  2834. maxResults?: MaxResults;
  2835. }
  2836. export interface ListSchemasResponse {
  2837. /**
  2838. * A list of schemas.
  2839. */
  2840. schemas?: Schemas;
  2841. /**
  2842. * A token used to get the next set of schemas (if they exist).
  2843. */
  2844. nextToken?: NextToken;
  2845. }
  2846. export interface ListSolutionVersionsRequest {
  2847. /**
  2848. * The Amazon Resource Name (ARN) of the solution.
  2849. */
  2850. solutionArn?: Arn;
  2851. /**
  2852. * A token returned from the previous call to ListSolutionVersions for getting the next set of solution versions (if they exist).
  2853. */
  2854. nextToken?: NextToken;
  2855. /**
  2856. * The maximum number of solution versions to return.
  2857. */
  2858. maxResults?: MaxResults;
  2859. }
  2860. export interface ListSolutionVersionsResponse {
  2861. /**
  2862. * A list of solution versions describing the version properties.
  2863. */
  2864. solutionVersions?: SolutionVersions;
  2865. /**
  2866. * A token for getting the next set of solution versions (if they exist).
  2867. */
  2868. nextToken?: NextToken;
  2869. }
  2870. export interface ListSolutionsRequest {
  2871. /**
  2872. * The Amazon Resource Name (ARN) of the dataset group.
  2873. */
  2874. datasetGroupArn?: Arn;
  2875. /**
  2876. * A token returned from the previous call to ListSolutions for getting the next set of solutions (if they exist).
  2877. */
  2878. nextToken?: NextToken;
  2879. /**
  2880. * The maximum number of solutions to return.
  2881. */
  2882. maxResults?: MaxResults;
  2883. }
  2884. export interface ListSolutionsResponse {
  2885. /**
  2886. * A list of the current solutions.
  2887. */
  2888. solutions?: Solutions;
  2889. /**
  2890. * A token for getting the next set of solutions (if they exist).
  2891. */
  2892. nextToken?: NextToken;
  2893. }
  2894. export interface ListTagsForResourceRequest {
  2895. /**
  2896. * The resource's Amazon Resource Name (ARN).
  2897. */
  2898. resourceArn: Arn;
  2899. }
  2900. export interface ListTagsForResourceResponse {
  2901. /**
  2902. * The resource's tags.
  2903. */
  2904. tags?: Tags;
  2905. }
  2906. export type MaxResults = number;
  2907. export interface MetricAttribute {
  2908. /**
  2909. * The metric's event type.
  2910. */
  2911. eventType: EventType;
  2912. /**
  2913. * The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
  2914. */
  2915. metricName: MetricName;
  2916. /**
  2917. * The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
  2918. */
  2919. expression: MetricExpression;
  2920. }
  2921. export type MetricAttributes = MetricAttribute[];
  2922. export type MetricAttributesNamesList = MetricName[];
  2923. export interface MetricAttribution {
  2924. /**
  2925. * The metric attribution's name.
  2926. */
  2927. name?: Name;
  2928. /**
  2929. * The metric attribution's Amazon Resource Name (ARN).
  2930. */
  2931. metricAttributionArn?: Arn;
  2932. /**
  2933. * The metric attribution's dataset group Amazon Resource Name (ARN).
  2934. */
  2935. datasetGroupArn?: Arn;
  2936. /**
  2937. * The metric attribution's output configuration.
  2938. */
  2939. metricsOutputConfig?: MetricAttributionOutput;
  2940. /**
  2941. * The metric attribution's status.
  2942. */
  2943. status?: Status;
  2944. /**
  2945. * The metric attribution's creation date time.
  2946. */
  2947. creationDateTime?: _Date;
  2948. /**
  2949. * The metric attribution's last updated date time.
  2950. */
  2951. lastUpdatedDateTime?: _Date;
  2952. /**
  2953. * The metric attribution's failure reason.
  2954. */
  2955. failureReason?: FailureReason;
  2956. }
  2957. export interface MetricAttributionOutput {
  2958. s3DataDestination?: S3DataConfig;
  2959. /**
  2960. * The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.
  2961. */
  2962. roleArn: RoleArn;
  2963. }
  2964. export interface MetricAttributionSummary {
  2965. /**
  2966. * The name of the metric attribution.
  2967. */
  2968. name?: Name;
  2969. /**
  2970. * The metric attribution's Amazon Resource Name (ARN).
  2971. */
  2972. metricAttributionArn?: Arn;
  2973. /**
  2974. * The metric attribution's status.
  2975. */
  2976. status?: Status;
  2977. /**
  2978. * The metric attribution's creation date time.
  2979. */
  2980. creationDateTime?: _Date;
  2981. /**
  2982. * The metric attribution's last updated date time.
  2983. */
  2984. lastUpdatedDateTime?: _Date;
  2985. /**
  2986. * The metric attribution's failure reason.
  2987. */
  2988. failureReason?: FailureReason;
  2989. }
  2990. export type MetricAttributions = MetricAttributionSummary[];
  2991. export type MetricExpression = string;
  2992. export type MetricName = string;
  2993. export type MetricRegex = string;
  2994. export type MetricValue = number;
  2995. export type Metrics = {[key: string]: MetricValue};
  2996. export type Name = string;
  2997. export type NextToken = string;
  2998. export type NumBatchResults = number;
  2999. export type ObjectiveSensitivity = "LOW"|"MEDIUM"|"HIGH"|"OFF"|string;
  3000. export interface OptimizationObjective {
  3001. /**
  3002. * The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).
  3003. */
  3004. itemAttribute?: ItemAttribute;
  3005. /**
  3006. * Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.
  3007. */
  3008. objectiveSensitivity?: ObjectiveSensitivity;
  3009. }
  3010. export type ParameterName = string;
  3011. export type ParameterValue = string;
  3012. export type PerformAutoML = boolean;
  3013. export type PerformAutoTraining = boolean;
  3014. export type PerformHPO = boolean;
  3015. export interface Recipe {
  3016. /**
  3017. * The name of the recipe.
  3018. */
  3019. name?: Name;
  3020. /**
  3021. * The Amazon Resource Name (ARN) of the recipe.
  3022. */
  3023. recipeArn?: Arn;
  3024. /**
  3025. * The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.
  3026. */
  3027. algorithmArn?: Arn;
  3028. /**
  3029. * The ARN of the FeatureTransformation object.
  3030. */
  3031. featureTransformationArn?: Arn;
  3032. /**
  3033. * The status of the recipe.
  3034. */
  3035. status?: Status;
  3036. /**
  3037. * The description of the recipe.
  3038. */
  3039. description?: Description;
  3040. /**
  3041. * The date and time (in Unix format) that the recipe was created.
  3042. */
  3043. creationDateTime?: _Date;
  3044. /**
  3045. * One of the following values: PERSONALIZED_RANKING RELATED_ITEMS USER_PERSONALIZATION
  3046. */
  3047. recipeType?: RecipeType;
  3048. /**
  3049. * The date and time (in Unix format) that the recipe was last updated.
  3050. */
  3051. lastUpdatedDateTime?: _Date;
  3052. }
  3053. export type RecipeProvider = "SERVICE"|string;
  3054. export interface RecipeSummary {
  3055. /**
  3056. * The name of the recipe.
  3057. */
  3058. name?: Name;
  3059. /**
  3060. * The Amazon Resource Name (ARN) of the recipe.
  3061. */
  3062. recipeArn?: Arn;
  3063. /**
  3064. * The status of the recipe.
  3065. */
  3066. status?: Status;
  3067. /**
  3068. * The date and time (in Unix time) that the recipe was created.
  3069. */
  3070. creationDateTime?: _Date;
  3071. /**
  3072. * The date and time (in Unix time) that the recipe was last updated.
  3073. */
  3074. lastUpdatedDateTime?: _Date;
  3075. /**
  3076. * The domain of the recipe (if the recipe is a Domain dataset group use case).
  3077. */
  3078. domain?: Domain;
  3079. }
  3080. export type RecipeType = string;
  3081. export type Recipes = RecipeSummary[];
  3082. export interface Recommender {
  3083. /**
  3084. * The Amazon Resource Name (ARN) of the recommender.
  3085. */
  3086. recommenderArn?: Arn;
  3087. /**
  3088. * The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
  3089. */
  3090. datasetGroupArn?: Arn;
  3091. /**
  3092. * The name of the recommender.
  3093. */
  3094. name?: Name;
  3095. /**
  3096. * The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
  3097. */
  3098. recipeArn?: Arn;
  3099. /**
  3100. * The configuration details of the recommender.
  3101. */
  3102. recommenderConfig?: RecommenderConfig;
  3103. /**
  3104. * The date and time (in Unix format) that the recommender was created.
  3105. */
  3106. creationDateTime?: _Date;
  3107. /**
  3108. * The date and time (in Unix format) that the recommender was last updated.
  3109. */
  3110. lastUpdatedDateTime?: _Date;
  3111. /**
  3112. * The status of the recommender. A recommender can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED STOP PENDING &gt; STOP IN_PROGRESS &gt; INACTIVE &gt; START PENDING &gt; START IN_PROGRESS &gt; ACTIVE DELETE PENDING &gt; DELETE IN_PROGRESS
  3113. */
  3114. status?: Status;
  3115. /**
  3116. * If a recommender fails, the reason behind the failure.
  3117. */
  3118. failureReason?: FailureReason;
  3119. /**
  3120. * Provides a summary of the latest updates to the recommender.
  3121. */
  3122. latestRecommenderUpdate?: RecommenderUpdateSummary;
  3123. /**
  3124. * Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.
  3125. */
  3126. modelMetrics?: Metrics;
  3127. }
  3128. export interface RecommenderConfig {
  3129. /**
  3130. * Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
  3131. */
  3132. itemExplorationConfig?: HyperParameters;
  3133. /**
  3134. * Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.
  3135. */
  3136. minRecommendationRequestsPerSecond?: TransactionsPerSecond;
  3137. /**
  3138. * Specifies the training data configuration to use when creating a domain recommender.
  3139. */
  3140. trainingDataConfig?: TrainingDataConfig;
  3141. /**
  3142. * Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender. If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.
  3143. */
  3144. enableMetadataWithRecommendations?: Boolean;
  3145. }
  3146. export interface RecommenderSummary {
  3147. /**
  3148. * The name of the recommender.
  3149. */
  3150. name?: Name;
  3151. /**
  3152. * The Amazon Resource Name (ARN) of the recommender.
  3153. */
  3154. recommenderArn?: Arn;
  3155. /**
  3156. * The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
  3157. */
  3158. datasetGroupArn?: Arn;
  3159. /**
  3160. * The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
  3161. */
  3162. recipeArn?: Arn;
  3163. /**
  3164. * The configuration details of the recommender.
  3165. */
  3166. recommenderConfig?: RecommenderConfig;
  3167. /**
  3168. * The status of the recommender. A recommender can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED STOP PENDING &gt; STOP IN_PROGRESS &gt; INACTIVE &gt; START PENDING &gt; START IN_PROGRESS &gt; ACTIVE DELETE PENDING &gt; DELETE IN_PROGRESS
  3169. */
  3170. status?: Status;
  3171. /**
  3172. * The date and time (in Unix format) that the recommender was created.
  3173. */
  3174. creationDateTime?: _Date;
  3175. /**
  3176. * The date and time (in Unix format) that the recommender was last updated.
  3177. */
  3178. lastUpdatedDateTime?: _Date;
  3179. }
  3180. export interface RecommenderUpdateSummary {
  3181. /**
  3182. * The configuration details of the recommender update.
  3183. */
  3184. recommenderConfig?: RecommenderConfig;
  3185. /**
  3186. * The date and time (in Unix format) that the recommender update was created.
  3187. */
  3188. creationDateTime?: _Date;
  3189. /**
  3190. * The date and time (in Unix time) that the recommender update was last updated.
  3191. */
  3192. lastUpdatedDateTime?: _Date;
  3193. /**
  3194. * The status of the recommender update. A recommender can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED STOP PENDING &gt; STOP IN_PROGRESS &gt; INACTIVE &gt; START PENDING &gt; START IN_PROGRESS &gt; ACTIVE DELETE PENDING &gt; DELETE IN_PROGRESS
  3195. */
  3196. status?: Status;
  3197. /**
  3198. * If a recommender update fails, the reason behind the failure.
  3199. */
  3200. failureReason?: FailureReason;
  3201. }
  3202. export type Recommenders = RecommenderSummary[];
  3203. export type ResourceConfig = {[key: string]: ParameterValue};
  3204. export type RoleArn = string;
  3205. export interface S3DataConfig {
  3206. /**
  3207. * The file path of the Amazon S3 bucket.
  3208. */
  3209. path: S3Location;
  3210. /**
  3211. * The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
  3212. */
  3213. kmsKeyArn?: KmsKeyArn;
  3214. }
  3215. export type S3Location = string;
  3216. export type SchedulingExpression = string;
  3217. export type Schemas = DatasetSchemaSummary[];
  3218. export interface Solution {
  3219. /**
  3220. * The name of the solution.
  3221. */
  3222. name?: Name;
  3223. /**
  3224. * The ARN of the solution.
  3225. */
  3226. solutionArn?: Arn;
  3227. /**
  3228. * Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
  3229. */
  3230. performHPO?: PerformHPO;
  3231. /**
  3232. * We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case. When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.
  3233. */
  3234. performAutoML?: PerformAutoML;
  3235. /**
  3236. * Specifies whether the solution automatically creates solution versions. The default is True and the solution automatically creates new solution versions every 7 days. For more information about auto training, see Creating and configuring a solution.
  3237. */
  3238. performAutoTraining?: PerformAutoTraining;
  3239. /**
  3240. * The ARN of the recipe used to create the solution. This is required when performAutoML is false.
  3241. */
  3242. recipeArn?: Arn;
  3243. /**
  3244. * The Amazon Resource Name (ARN) of the dataset group that provides the training data.
  3245. */
  3246. datasetGroupArn?: Arn;
  3247. /**
  3248. * The event type (for example, 'click' or 'like') that is used for training the model. If no eventType is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.
  3249. */
  3250. eventType?: EventType;
  3251. /**
  3252. * Describes the configuration properties for the solution.
  3253. */
  3254. solutionConfig?: SolutionConfig;
  3255. /**
  3256. * When performAutoML is true, specifies the best recipe found.
  3257. */
  3258. autoMLResult?: AutoMLResult;
  3259. /**
  3260. * The status of the solution. A solution can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
  3261. */
  3262. status?: Status;
  3263. /**
  3264. * The creation date and time (in Unix time) of the solution.
  3265. */
  3266. creationDateTime?: _Date;
  3267. /**
  3268. * The date and time (in Unix time) that the solution was last updated.
  3269. */
  3270. lastUpdatedDateTime?: _Date;
  3271. /**
  3272. * Describes the latest version of the solution, including the status and the ARN.
  3273. */
  3274. latestSolutionVersion?: SolutionVersionSummary;
  3275. }
  3276. export interface SolutionConfig {
  3277. /**
  3278. * Only events with a value greater than or equal to this threshold are used for training a model.
  3279. */
  3280. eventValueThreshold?: EventValueThreshold;
  3281. /**
  3282. * Describes the properties for hyperparameter optimization (HPO).
  3283. */
  3284. hpoConfig?: HPOConfig;
  3285. /**
  3286. * Lists the algorithm hyperparameters and their values.
  3287. */
  3288. algorithmHyperParameters?: HyperParameters;
  3289. /**
  3290. * Lists the feature transformation parameters.
  3291. */
  3292. featureTransformationParameters?: FeatureTransformationParameters;
  3293. /**
  3294. * The AutoMLConfig object containing a list of recipes to search when AutoML is performed.
  3295. */
  3296. autoMLConfig?: AutoMLConfig;
  3297. /**
  3298. * Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.
  3299. */
  3300. optimizationObjective?: OptimizationObjective;
  3301. /**
  3302. * Specifies the training data configuration to use when creating a custom solution version (trained model).
  3303. */
  3304. trainingDataConfig?: TrainingDataConfig;
  3305. /**
  3306. * Specifies the automatic training configuration to use.
  3307. */
  3308. autoTrainingConfig?: AutoTrainingConfig;
  3309. }
  3310. export interface SolutionSummary {
  3311. /**
  3312. * The name of the solution.
  3313. */
  3314. name?: Name;
  3315. /**
  3316. * The Amazon Resource Name (ARN) of the solution.
  3317. */
  3318. solutionArn?: Arn;
  3319. /**
  3320. * The status of the solution. A solution can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
  3321. */
  3322. status?: Status;
  3323. /**
  3324. * The date and time (in Unix time) that the solution was created.
  3325. */
  3326. creationDateTime?: _Date;
  3327. /**
  3328. * The date and time (in Unix time) that the solution was last updated.
  3329. */
  3330. lastUpdatedDateTime?: _Date;
  3331. /**
  3332. * The Amazon Resource Name (ARN) of the recipe used by the solution.
  3333. */
  3334. recipeArn?: Arn;
  3335. }
  3336. export interface SolutionVersion {
  3337. /**
  3338. * The name of the solution version.
  3339. */
  3340. name?: Name;
  3341. /**
  3342. * The ARN of the solution version.
  3343. */
  3344. solutionVersionArn?: Arn;
  3345. /**
  3346. * The ARN of the solution.
  3347. */
  3348. solutionArn?: Arn;
  3349. /**
  3350. * Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
  3351. */
  3352. performHPO?: PerformHPO;
  3353. /**
  3354. * When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.
  3355. */
  3356. performAutoML?: PerformAutoML;
  3357. /**
  3358. * The ARN of the recipe used in the solution.
  3359. */
  3360. recipeArn?: Arn;
  3361. /**
  3362. * The event type (for example, 'click' or 'like') that is used for training the model.
  3363. */
  3364. eventType?: EventType;
  3365. /**
  3366. * The Amazon Resource Name (ARN) of the dataset group providing the training data.
  3367. */
  3368. datasetGroupArn?: Arn;
  3369. /**
  3370. * Describes the configuration properties for the solution.
  3371. */
  3372. solutionConfig?: SolutionConfig;
  3373. /**
  3374. * The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.
  3375. */
  3376. trainingHours?: TrainingHours;
  3377. /**
  3378. * The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.
  3379. */
  3380. trainingMode?: TrainingMode;
  3381. /**
  3382. * If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
  3383. */
  3384. tunedHPOParams?: TunedHPOParams;
  3385. /**
  3386. * The status of the solution version. A solution version can be in one of the following states: CREATE PENDING CREATE IN_PROGRESS ACTIVE CREATE FAILED CREATE STOPPING CREATE STOPPED
  3387. */
  3388. status?: Status;
  3389. /**
  3390. * If training a solution version fails, the reason for the failure.
  3391. */
  3392. failureReason?: FailureReason;
  3393. /**
  3394. * The date and time (in Unix time) that this version of the solution was created.
  3395. */
  3396. creationDateTime?: _Date;
  3397. /**
  3398. * The date and time (in Unix time) that the solution was last updated.
  3399. */
  3400. lastUpdatedDateTime?: _Date;
  3401. /**
  3402. * Whether the solution version was created automatically or manually.
  3403. */
  3404. trainingType?: TrainingType;
  3405. }
  3406. export interface SolutionVersionSummary {
  3407. /**
  3408. * The Amazon Resource Name (ARN) of the solution version.
  3409. */
  3410. solutionVersionArn?: Arn;
  3411. /**
  3412. * The status of the solution version. A solution version can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED
  3413. */
  3414. status?: Status;
  3415. /**
  3416. * The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.
  3417. */
  3418. trainingMode?: TrainingMode;
  3419. /**
  3420. * Whether the solution version was created automatically or manually.
  3421. */
  3422. trainingType?: TrainingType;
  3423. /**
  3424. * The date and time (in Unix time) that this version of a solution was created.
  3425. */
  3426. creationDateTime?: _Date;
  3427. /**
  3428. * The date and time (in Unix time) that the solution version was last updated.
  3429. */
  3430. lastUpdatedDateTime?: _Date;
  3431. /**
  3432. * If a solution version fails, the reason behind the failure.
  3433. */
  3434. failureReason?: FailureReason;
  3435. }
  3436. export type SolutionVersions = SolutionVersionSummary[];
  3437. export type Solutions = SolutionSummary[];
  3438. export interface StartRecommenderRequest {
  3439. /**
  3440. * The Amazon Resource Name (ARN) of the recommender to start.
  3441. */
  3442. recommenderArn: Arn;
  3443. }
  3444. export interface StartRecommenderResponse {
  3445. /**
  3446. * The Amazon Resource Name (ARN) of the recommender you started.
  3447. */
  3448. recommenderArn?: Arn;
  3449. }
  3450. export type Status = string;
  3451. export interface StopRecommenderRequest {
  3452. /**
  3453. * The Amazon Resource Name (ARN) of the recommender to stop.
  3454. */
  3455. recommenderArn: Arn;
  3456. }
  3457. export interface StopRecommenderResponse {
  3458. /**
  3459. * The Amazon Resource Name (ARN) of the recommender you stopped.
  3460. */
  3461. recommenderArn?: Arn;
  3462. }
  3463. export interface StopSolutionVersionCreationRequest {
  3464. /**
  3465. * The Amazon Resource Name (ARN) of the solution version you want to stop creating.
  3466. */
  3467. solutionVersionArn: Arn;
  3468. }
  3469. export interface Tag {
  3470. /**
  3471. * One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
  3472. */
  3473. tagKey: TagKey;
  3474. /**
  3475. * The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
  3476. */
  3477. tagValue: TagValue;
  3478. }
  3479. export type TagKey = string;
  3480. export type TagKeys = TagKey[];
  3481. export interface TagResourceRequest {
  3482. /**
  3483. * The resource's Amazon Resource Name (ARN).
  3484. */
  3485. resourceArn: Arn;
  3486. /**
  3487. * Tags to apply to the resource. For more information see Tagging Amazon Personalize resources.
  3488. */
  3489. tags: Tags;
  3490. }
  3491. export interface TagResourceResponse {
  3492. }
  3493. export type TagValue = string;
  3494. export type Tags = Tag[];
  3495. export interface ThemeGenerationConfig {
  3496. /**
  3497. * Fields used to generate descriptive themes for a batch inference job.
  3498. */
  3499. fieldsForThemeGeneration: FieldsForThemeGeneration;
  3500. }
  3501. export type TrackingId = string;
  3502. export interface TrainingDataConfig {
  3503. /**
  3504. * Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations. For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.
  3505. */
  3506. excludedDatasetColumns?: ExcludedDatasetColumns;
  3507. }
  3508. export type TrainingHours = number;
  3509. export type TrainingInputMode = string;
  3510. export type TrainingMode = "FULL"|"UPDATE"|"AUTOTRAIN"|string;
  3511. export type TrainingType = "AUTOMATIC"|"MANUAL"|string;
  3512. export type TransactionsPerSecond = number;
  3513. export type Tunable = boolean;
  3514. export interface TunedHPOParams {
  3515. /**
  3516. * A list of the hyperparameter values of the best performing model.
  3517. */
  3518. algorithmHyperParameters?: HyperParameters;
  3519. }
  3520. export interface UntagResourceRequest {
  3521. /**
  3522. * The resource's Amazon Resource Name (ARN).
  3523. */
  3524. resourceArn: Arn;
  3525. /**
  3526. * The keys of the tags to be removed.
  3527. */
  3528. tagKeys: TagKeys;
  3529. }
  3530. export interface UntagResourceResponse {
  3531. }
  3532. export interface UpdateCampaignRequest {
  3533. /**
  3534. * The Amazon Resource Name (ARN) of the campaign.
  3535. */
  3536. campaignArn: Arn;
  3537. /**
  3538. * The Amazon Resource Name (ARN) of a new model to deploy. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig. To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version. For more information about automatic campaign updates, see Enabling automatic campaign updates.
  3539. */
  3540. solutionVersionArn?: Arn;
  3541. /**
  3542. * Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.
  3543. */
  3544. minProvisionedTPS?: TransactionsPerSecond;
  3545. /**
  3546. * The configuration details of a campaign.
  3547. */
  3548. campaignConfig?: CampaignConfig;
  3549. }
  3550. export interface UpdateCampaignResponse {
  3551. /**
  3552. * The same campaign ARN as given in the request.
  3553. */
  3554. campaignArn?: Arn;
  3555. }
  3556. export interface UpdateDatasetRequest {
  3557. /**
  3558. * The Amazon Resource Name (ARN) of the dataset that you want to update.
  3559. */
  3560. datasetArn: Arn;
  3561. /**
  3562. * The Amazon Resource Name (ARN) of the new schema you want use.
  3563. */
  3564. schemaArn: Arn;
  3565. }
  3566. export interface UpdateDatasetResponse {
  3567. /**
  3568. * The Amazon Resource Name (ARN) of the dataset you updated.
  3569. */
  3570. datasetArn?: Arn;
  3571. }
  3572. export interface UpdateMetricAttributionRequest {
  3573. /**
  3574. * Add new metric attributes to the metric attribution.
  3575. */
  3576. addMetrics?: MetricAttributes;
  3577. /**
  3578. * Remove metric attributes from the metric attribution.
  3579. */
  3580. removeMetrics?: MetricAttributesNamesList;
  3581. /**
  3582. * An output config for the metric attribution.
  3583. */
  3584. metricsOutputConfig?: MetricAttributionOutput;
  3585. /**
  3586. * The Amazon Resource Name (ARN) for the metric attribution to update.
  3587. */
  3588. metricAttributionArn?: Arn;
  3589. }
  3590. export interface UpdateMetricAttributionResponse {
  3591. /**
  3592. * The Amazon Resource Name (ARN) for the metric attribution that you updated.
  3593. */
  3594. metricAttributionArn?: Arn;
  3595. }
  3596. export interface UpdateRecommenderRequest {
  3597. /**
  3598. * The Amazon Resource Name (ARN) of the recommender to modify.
  3599. */
  3600. recommenderArn: Arn;
  3601. /**
  3602. * The configuration details of the recommender.
  3603. */
  3604. recommenderConfig: RecommenderConfig;
  3605. }
  3606. export interface UpdateRecommenderResponse {
  3607. /**
  3608. * The same recommender Amazon Resource Name (ARN) as given in the request.
  3609. */
  3610. recommenderArn?: Arn;
  3611. }
  3612. /**
  3613. * 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.
  3614. */
  3615. export type apiVersion = "2018-05-22"|"latest"|string;
  3616. export interface ClientApiVersions {
  3617. /**
  3618. * 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.
  3619. */
  3620. apiVersion?: apiVersion;
  3621. }
  3622. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  3623. /**
  3624. * Contains interfaces for use with the Personalize client.
  3625. */
  3626. export import Types = Personalize;
  3627. }
  3628. export = Personalize;