codeartifact.d.ts 136 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595
  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. import {Readable} from 'stream';
  8. interface Blob {}
  9. declare class CodeArtifact extends Service {
  10. /**
  11. * Constructs a service object. This object has one method for each API operation.
  12. */
  13. constructor(options?: CodeArtifact.Types.ClientConfiguration)
  14. config: Config & CodeArtifact.Types.ClientConfiguration;
  15. /**
  16. * Adds an existing external connection to a repository. One external connection is allowed per repository. A repository can have one or more upstream repositories, or an external connection.
  17. */
  18. associateExternalConnection(params: CodeArtifact.Types.AssociateExternalConnectionRequest, callback?: (err: AWSError, data: CodeArtifact.Types.AssociateExternalConnectionResult) => void): Request<CodeArtifact.Types.AssociateExternalConnectionResult, AWSError>;
  19. /**
  20. * Adds an existing external connection to a repository. One external connection is allowed per repository. A repository can have one or more upstream repositories, or an external connection.
  21. */
  22. associateExternalConnection(callback?: (err: AWSError, data: CodeArtifact.Types.AssociateExternalConnectionResult) => void): Request<CodeArtifact.Types.AssociateExternalConnectionResult, AWSError>;
  23. /**
  24. * Copies package versions from one repository to another repository in the same domain. You must specify versions or versionRevisions. You cannot specify both.
  25. */
  26. copyPackageVersions(params: CodeArtifact.Types.CopyPackageVersionsRequest, callback?: (err: AWSError, data: CodeArtifact.Types.CopyPackageVersionsResult) => void): Request<CodeArtifact.Types.CopyPackageVersionsResult, AWSError>;
  27. /**
  28. * Copies package versions from one repository to another repository in the same domain. You must specify versions or versionRevisions. You cannot specify both.
  29. */
  30. copyPackageVersions(callback?: (err: AWSError, data: CodeArtifact.Types.CopyPackageVersionsResult) => void): Request<CodeArtifact.Types.CopyPackageVersionsResult, AWSError>;
  31. /**
  32. * Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it's in multiple repositories. Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.
  33. */
  34. createDomain(params: CodeArtifact.Types.CreateDomainRequest, callback?: (err: AWSError, data: CodeArtifact.Types.CreateDomainResult) => void): Request<CodeArtifact.Types.CreateDomainResult, AWSError>;
  35. /**
  36. * Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it's in multiple repositories. Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.
  37. */
  38. createDomain(callback?: (err: AWSError, data: CodeArtifact.Types.CreateDomainResult) => void): Request<CodeArtifact.Types.CreateDomainResult, AWSError>;
  39. /**
  40. * Creates a package group. For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide.
  41. */
  42. createPackageGroup(params: CodeArtifact.Types.CreatePackageGroupRequest, callback?: (err: AWSError, data: CodeArtifact.Types.CreatePackageGroupResult) => void): Request<CodeArtifact.Types.CreatePackageGroupResult, AWSError>;
  43. /**
  44. * Creates a package group. For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide.
  45. */
  46. createPackageGroup(callback?: (err: AWSError, data: CodeArtifact.Types.CreatePackageGroupResult) => void): Request<CodeArtifact.Types.CreatePackageGroupResult, AWSError>;
  47. /**
  48. * Creates a repository.
  49. */
  50. createRepository(params: CodeArtifact.Types.CreateRepositoryRequest, callback?: (err: AWSError, data: CodeArtifact.Types.CreateRepositoryResult) => void): Request<CodeArtifact.Types.CreateRepositoryResult, AWSError>;
  51. /**
  52. * Creates a repository.
  53. */
  54. createRepository(callback?: (err: AWSError, data: CodeArtifact.Types.CreateRepositoryResult) => void): Request<CodeArtifact.Types.CreateRepositoryResult, AWSError>;
  55. /**
  56. * Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
  57. */
  58. deleteDomain(params: CodeArtifact.Types.DeleteDomainRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DeleteDomainResult) => void): Request<CodeArtifact.Types.DeleteDomainResult, AWSError>;
  59. /**
  60. * Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
  61. */
  62. deleteDomain(callback?: (err: AWSError, data: CodeArtifact.Types.DeleteDomainResult) => void): Request<CodeArtifact.Types.DeleteDomainResult, AWSError>;
  63. /**
  64. * Deletes the resource policy set on a domain.
  65. */
  66. deleteDomainPermissionsPolicy(params: CodeArtifact.Types.DeleteDomainPermissionsPolicyRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DeleteDomainPermissionsPolicyResult) => void): Request<CodeArtifact.Types.DeleteDomainPermissionsPolicyResult, AWSError>;
  67. /**
  68. * Deletes the resource policy set on a domain.
  69. */
  70. deleteDomainPermissionsPolicy(callback?: (err: AWSError, data: CodeArtifact.Types.DeleteDomainPermissionsPolicyResult) => void): Request<CodeArtifact.Types.DeleteDomainPermissionsPolicyResult, AWSError>;
  71. /**
  72. * Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.
  73. */
  74. deletePackage(params: CodeArtifact.Types.DeletePackageRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DeletePackageResult) => void): Request<CodeArtifact.Types.DeletePackageResult, AWSError>;
  75. /**
  76. * Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.
  77. */
  78. deletePackage(callback?: (err: AWSError, data: CodeArtifact.Types.DeletePackageResult) => void): Request<CodeArtifact.Types.DeletePackageResult, AWSError>;
  79. /**
  80. * Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group's direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.
  81. */
  82. deletePackageGroup(params: CodeArtifact.Types.DeletePackageGroupRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DeletePackageGroupResult) => void): Request<CodeArtifact.Types.DeletePackageGroupResult, AWSError>;
  83. /**
  84. * Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group's direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.
  85. */
  86. deletePackageGroup(callback?: (err: AWSError, data: CodeArtifact.Types.DeletePackageGroupResult) => void): Request<CodeArtifact.Types.DeletePackageGroupResult, AWSError>;
  87. /**
  88. * Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListPackageVersions), but you can restore them using UpdatePackageVersionsStatus.
  89. */
  90. deletePackageVersions(params: CodeArtifact.Types.DeletePackageVersionsRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DeletePackageVersionsResult) => void): Request<CodeArtifact.Types.DeletePackageVersionsResult, AWSError>;
  91. /**
  92. * Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListPackageVersions), but you can restore them using UpdatePackageVersionsStatus.
  93. */
  94. deletePackageVersions(callback?: (err: AWSError, data: CodeArtifact.Types.DeletePackageVersionsResult) => void): Request<CodeArtifact.Types.DeletePackageVersionsResult, AWSError>;
  95. /**
  96. * Deletes a repository.
  97. */
  98. deleteRepository(params: CodeArtifact.Types.DeleteRepositoryRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DeleteRepositoryResult) => void): Request<CodeArtifact.Types.DeleteRepositoryResult, AWSError>;
  99. /**
  100. * Deletes a repository.
  101. */
  102. deleteRepository(callback?: (err: AWSError, data: CodeArtifact.Types.DeleteRepositoryResult) => void): Request<CodeArtifact.Types.DeleteRepositoryResult, AWSError>;
  103. /**
  104. * Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate. Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.
  105. */
  106. deleteRepositoryPermissionsPolicy(params: CodeArtifact.Types.DeleteRepositoryPermissionsPolicyRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DeleteRepositoryPermissionsPolicyResult) => void): Request<CodeArtifact.Types.DeleteRepositoryPermissionsPolicyResult, AWSError>;
  107. /**
  108. * Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate. Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.
  109. */
  110. deleteRepositoryPermissionsPolicy(callback?: (err: AWSError, data: CodeArtifact.Types.DeleteRepositoryPermissionsPolicyResult) => void): Request<CodeArtifact.Types.DeleteRepositoryPermissionsPolicyResult, AWSError>;
  111. /**
  112. * Returns a DomainDescription object that contains information about the requested domain.
  113. */
  114. describeDomain(params: CodeArtifact.Types.DescribeDomainRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DescribeDomainResult) => void): Request<CodeArtifact.Types.DescribeDomainResult, AWSError>;
  115. /**
  116. * Returns a DomainDescription object that contains information about the requested domain.
  117. */
  118. describeDomain(callback?: (err: AWSError, data: CodeArtifact.Types.DescribeDomainResult) => void): Request<CodeArtifact.Types.DescribeDomainResult, AWSError>;
  119. /**
  120. * Returns a PackageDescription object that contains information about the requested package.
  121. */
  122. describePackage(params: CodeArtifact.Types.DescribePackageRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DescribePackageResult) => void): Request<CodeArtifact.Types.DescribePackageResult, AWSError>;
  123. /**
  124. * Returns a PackageDescription object that contains information about the requested package.
  125. */
  126. describePackage(callback?: (err: AWSError, data: CodeArtifact.Types.DescribePackageResult) => void): Request<CodeArtifact.Types.DescribePackageResult, AWSError>;
  127. /**
  128. * Returns a PackageGroupDescription object that contains information about the requested package group.
  129. */
  130. describePackageGroup(params: CodeArtifact.Types.DescribePackageGroupRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DescribePackageGroupResult) => void): Request<CodeArtifact.Types.DescribePackageGroupResult, AWSError>;
  131. /**
  132. * Returns a PackageGroupDescription object that contains information about the requested package group.
  133. */
  134. describePackageGroup(callback?: (err: AWSError, data: CodeArtifact.Types.DescribePackageGroupResult) => void): Request<CodeArtifact.Types.DescribePackageGroupResult, AWSError>;
  135. /**
  136. * Returns a PackageVersionDescription object that contains information about the requested package version.
  137. */
  138. describePackageVersion(params: CodeArtifact.Types.DescribePackageVersionRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DescribePackageVersionResult) => void): Request<CodeArtifact.Types.DescribePackageVersionResult, AWSError>;
  139. /**
  140. * Returns a PackageVersionDescription object that contains information about the requested package version.
  141. */
  142. describePackageVersion(callback?: (err: AWSError, data: CodeArtifact.Types.DescribePackageVersionResult) => void): Request<CodeArtifact.Types.DescribePackageVersionResult, AWSError>;
  143. /**
  144. * Returns a RepositoryDescription object that contains detailed information about the requested repository.
  145. */
  146. describeRepository(params: CodeArtifact.Types.DescribeRepositoryRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DescribeRepositoryResult) => void): Request<CodeArtifact.Types.DescribeRepositoryResult, AWSError>;
  147. /**
  148. * Returns a RepositoryDescription object that contains detailed information about the requested repository.
  149. */
  150. describeRepository(callback?: (err: AWSError, data: CodeArtifact.Types.DescribeRepositoryResult) => void): Request<CodeArtifact.Types.DescribeRepositoryResult, AWSError>;
  151. /**
  152. * Removes an existing external connection from a repository.
  153. */
  154. disassociateExternalConnection(params: CodeArtifact.Types.DisassociateExternalConnectionRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DisassociateExternalConnectionResult) => void): Request<CodeArtifact.Types.DisassociateExternalConnectionResult, AWSError>;
  155. /**
  156. * Removes an existing external connection from a repository.
  157. */
  158. disassociateExternalConnection(callback?: (err: AWSError, data: CodeArtifact.Types.DisassociateExternalConnectionResult) => void): Request<CodeArtifact.Types.DisassociateExternalConnectionResult, AWSError>;
  159. /**
  160. * Deletes the assets in package versions and sets the package versions' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted. To view all disposed package versions in a repository, use ListPackageVersions and set the status parameter to Disposed. To view information about a disposed package version, use DescribePackageVersion.
  161. */
  162. disposePackageVersions(params: CodeArtifact.Types.DisposePackageVersionsRequest, callback?: (err: AWSError, data: CodeArtifact.Types.DisposePackageVersionsResult) => void): Request<CodeArtifact.Types.DisposePackageVersionsResult, AWSError>;
  163. /**
  164. * Deletes the assets in package versions and sets the package versions' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted. To view all disposed package versions in a repository, use ListPackageVersions and set the status parameter to Disposed. To view information about a disposed package version, use DescribePackageVersion.
  165. */
  166. disposePackageVersions(callback?: (err: AWSError, data: CodeArtifact.Types.DisposePackageVersionsResult) => void): Request<CodeArtifact.Types.DisposePackageVersionsResult, AWSError>;
  167. /**
  168. * Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, GetAssociatedPackageGroup can be used to see which package group's origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
  169. */
  170. getAssociatedPackageGroup(params: CodeArtifact.Types.GetAssociatedPackageGroupRequest, callback?: (err: AWSError, data: CodeArtifact.Types.GetAssociatedPackageGroupResult) => void): Request<CodeArtifact.Types.GetAssociatedPackageGroupResult, AWSError>;
  171. /**
  172. * Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, GetAssociatedPackageGroup can be used to see which package group's origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
  173. */
  174. getAssociatedPackageGroup(callback?: (err: AWSError, data: CodeArtifact.Types.GetAssociatedPackageGroupResult) => void): Request<CodeArtifact.Types.GetAssociatedPackageGroupResult, AWSError>;
  175. /**
  176. * Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens. CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter. The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration. See Using IAM Roles for more information on controlling session duration.
  177. */
  178. getAuthorizationToken(params: CodeArtifact.Types.GetAuthorizationTokenRequest, callback?: (err: AWSError, data: CodeArtifact.Types.GetAuthorizationTokenResult) => void): Request<CodeArtifact.Types.GetAuthorizationTokenResult, AWSError>;
  179. /**
  180. * Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens. CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter. The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration. See Using IAM Roles for more information on controlling session duration.
  181. */
  182. getAuthorizationToken(callback?: (err: AWSError, data: CodeArtifact.Types.GetAuthorizationTokenResult) => void): Request<CodeArtifact.Types.GetAuthorizationTokenResult, AWSError>;
  183. /**
  184. * Returns the resource policy attached to the specified domain. The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the IAM User Guide.
  185. */
  186. getDomainPermissionsPolicy(params: CodeArtifact.Types.GetDomainPermissionsPolicyRequest, callback?: (err: AWSError, data: CodeArtifact.Types.GetDomainPermissionsPolicyResult) => void): Request<CodeArtifact.Types.GetDomainPermissionsPolicyResult, AWSError>;
  187. /**
  188. * Returns the resource policy attached to the specified domain. The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the IAM User Guide.
  189. */
  190. getDomainPermissionsPolicy(callback?: (err: AWSError, data: CodeArtifact.Types.GetDomainPermissionsPolicyResult) => void): Request<CodeArtifact.Types.GetDomainPermissionsPolicyResult, AWSError>;
  191. /**
  192. * Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version.
  193. */
  194. getPackageVersionAsset(params: CodeArtifact.Types.GetPackageVersionAssetRequest, callback?: (err: AWSError, data: CodeArtifact.Types.GetPackageVersionAssetResult) => void): Request<CodeArtifact.Types.GetPackageVersionAssetResult, AWSError>;
  195. /**
  196. * Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version.
  197. */
  198. getPackageVersionAsset(callback?: (err: AWSError, data: CodeArtifact.Types.GetPackageVersionAssetResult) => void): Request<CodeArtifact.Types.GetPackageVersionAssetResult, AWSError>;
  199. /**
  200. * Gets the readme file or descriptive text for a package version. The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.
  201. */
  202. getPackageVersionReadme(params: CodeArtifact.Types.GetPackageVersionReadmeRequest, callback?: (err: AWSError, data: CodeArtifact.Types.GetPackageVersionReadmeResult) => void): Request<CodeArtifact.Types.GetPackageVersionReadmeResult, AWSError>;
  203. /**
  204. * Gets the readme file or descriptive text for a package version. The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.
  205. */
  206. getPackageVersionReadme(callback?: (err: AWSError, data: CodeArtifact.Types.GetPackageVersionReadmeResult) => void): Request<CodeArtifact.Types.GetPackageVersionReadmeResult, AWSError>;
  207. /**
  208. * Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format: generic maven npm nuget pypi ruby swift
  209. */
  210. getRepositoryEndpoint(params: CodeArtifact.Types.GetRepositoryEndpointRequest, callback?: (err: AWSError, data: CodeArtifact.Types.GetRepositoryEndpointResult) => void): Request<CodeArtifact.Types.GetRepositoryEndpointResult, AWSError>;
  211. /**
  212. * Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format: generic maven npm nuget pypi ruby swift
  213. */
  214. getRepositoryEndpoint(callback?: (err: AWSError, data: CodeArtifact.Types.GetRepositoryEndpointResult) => void): Request<CodeArtifact.Types.GetRepositoryEndpointResult, AWSError>;
  215. /**
  216. * Returns the resource policy that is set on a repository.
  217. */
  218. getRepositoryPermissionsPolicy(params: CodeArtifact.Types.GetRepositoryPermissionsPolicyRequest, callback?: (err: AWSError, data: CodeArtifact.Types.GetRepositoryPermissionsPolicyResult) => void): Request<CodeArtifact.Types.GetRepositoryPermissionsPolicyResult, AWSError>;
  219. /**
  220. * Returns the resource policy that is set on a repository.
  221. */
  222. getRepositoryPermissionsPolicy(callback?: (err: AWSError, data: CodeArtifact.Types.GetRepositoryPermissionsPolicyResult) => void): Request<CodeArtifact.Types.GetRepositoryPermissionsPolicyResult, AWSError>;
  223. /**
  224. * Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.
  225. */
  226. listAllowedRepositoriesForGroup(params: CodeArtifact.Types.ListAllowedRepositoriesForGroupRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListAllowedRepositoriesForGroupResult) => void): Request<CodeArtifact.Types.ListAllowedRepositoriesForGroupResult, AWSError>;
  227. /**
  228. * Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.
  229. */
  230. listAllowedRepositoriesForGroup(callback?: (err: AWSError, data: CodeArtifact.Types.ListAllowedRepositoriesForGroupResult) => void): Request<CodeArtifact.Types.ListAllowedRepositoriesForGroupResult, AWSError>;
  231. /**
  232. * Returns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
  233. */
  234. listAssociatedPackages(params: CodeArtifact.Types.ListAssociatedPackagesRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListAssociatedPackagesResult) => void): Request<CodeArtifact.Types.ListAssociatedPackagesResult, AWSError>;
  235. /**
  236. * Returns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
  237. */
  238. listAssociatedPackages(callback?: (err: AWSError, data: CodeArtifact.Types.ListAssociatedPackagesResult) => void): Request<CodeArtifact.Types.ListAssociatedPackagesResult, AWSError>;
  239. /**
  240. * Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.
  241. */
  242. listDomains(params: CodeArtifact.Types.ListDomainsRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListDomainsResult) => void): Request<CodeArtifact.Types.ListDomainsResult, AWSError>;
  243. /**
  244. * Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.
  245. */
  246. listDomains(callback?: (err: AWSError, data: CodeArtifact.Types.ListDomainsResult) => void): Request<CodeArtifact.Types.ListDomainsResult, AWSError>;
  247. /**
  248. * Returns a list of package groups in the requested domain.
  249. */
  250. listPackageGroups(params: CodeArtifact.Types.ListPackageGroupsRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListPackageGroupsResult) => void): Request<CodeArtifact.Types.ListPackageGroupsResult, AWSError>;
  251. /**
  252. * Returns a list of package groups in the requested domain.
  253. */
  254. listPackageGroups(callback?: (err: AWSError, data: CodeArtifact.Types.ListPackageGroupsResult) => void): Request<CodeArtifact.Types.ListPackageGroupsResult, AWSError>;
  255. /**
  256. * Returns a list of AssetSummary objects for assets in a package version.
  257. */
  258. listPackageVersionAssets(params: CodeArtifact.Types.ListPackageVersionAssetsRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListPackageVersionAssetsResult) => void): Request<CodeArtifact.Types.ListPackageVersionAssetsResult, AWSError>;
  259. /**
  260. * Returns a list of AssetSummary objects for assets in a package version.
  261. */
  262. listPackageVersionAssets(callback?: (err: AWSError, data: CodeArtifact.Types.ListPackageVersionAssetsResult) => void): Request<CodeArtifact.Types.ListPackageVersionAssetsResult, AWSError>;
  263. /**
  264. * Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.
  265. */
  266. listPackageVersionDependencies(params: CodeArtifact.Types.ListPackageVersionDependenciesRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListPackageVersionDependenciesResult) => void): Request<CodeArtifact.Types.ListPackageVersionDependenciesResult, AWSError>;
  267. /**
  268. * Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.
  269. */
  270. listPackageVersionDependencies(callback?: (err: AWSError, data: CodeArtifact.Types.ListPackageVersionDependenciesResult) => void): Request<CodeArtifact.Types.ListPackageVersionDependenciesResult, AWSError>;
  271. /**
  272. * Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters. Package versions of all statuses will be returned by default when calling list-package-versions with no --status parameter.
  273. */
  274. listPackageVersions(params: CodeArtifact.Types.ListPackageVersionsRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListPackageVersionsResult) => void): Request<CodeArtifact.Types.ListPackageVersionsResult, AWSError>;
  275. /**
  276. * Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters. Package versions of all statuses will be returned by default when calling list-package-versions with no --status parameter.
  277. */
  278. listPackageVersions(callback?: (err: AWSError, data: CodeArtifact.Types.ListPackageVersionsResult) => void): Request<CodeArtifact.Types.ListPackageVersionsResult, AWSError>;
  279. /**
  280. * Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
  281. */
  282. listPackages(params: CodeArtifact.Types.ListPackagesRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListPackagesResult) => void): Request<CodeArtifact.Types.ListPackagesResult, AWSError>;
  283. /**
  284. * Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
  285. */
  286. listPackages(callback?: (err: AWSError, data: CodeArtifact.Types.ListPackagesResult) => void): Request<CodeArtifact.Types.ListPackagesResult, AWSError>;
  287. /**
  288. * Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified Amazon Web Services account and that matches the input parameters.
  289. */
  290. listRepositories(params: CodeArtifact.Types.ListRepositoriesRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListRepositoriesResult) => void): Request<CodeArtifact.Types.ListRepositoriesResult, AWSError>;
  291. /**
  292. * Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified Amazon Web Services account and that matches the input parameters.
  293. */
  294. listRepositories(callback?: (err: AWSError, data: CodeArtifact.Types.ListRepositoriesResult) => void): Request<CodeArtifact.Types.ListRepositoriesResult, AWSError>;
  295. /**
  296. * Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.
  297. */
  298. listRepositoriesInDomain(params: CodeArtifact.Types.ListRepositoriesInDomainRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListRepositoriesInDomainResult) => void): Request<CodeArtifact.Types.ListRepositoriesInDomainResult, AWSError>;
  299. /**
  300. * Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.
  301. */
  302. listRepositoriesInDomain(callback?: (err: AWSError, data: CodeArtifact.Types.ListRepositoriesInDomainResult) => void): Request<CodeArtifact.Types.ListRepositoriesInDomainResult, AWSError>;
  303. /**
  304. * Returns a list of direct children of the specified package group. For information package group hierarchy, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
  305. */
  306. listSubPackageGroups(params: CodeArtifact.Types.ListSubPackageGroupsRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListSubPackageGroupsResult) => void): Request<CodeArtifact.Types.ListSubPackageGroupsResult, AWSError>;
  307. /**
  308. * Returns a list of direct children of the specified package group. For information package group hierarchy, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
  309. */
  310. listSubPackageGroups(callback?: (err: AWSError, data: CodeArtifact.Types.ListSubPackageGroupsResult) => void): Request<CodeArtifact.Types.ListSubPackageGroupsResult, AWSError>;
  311. /**
  312. * Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
  313. */
  314. listTagsForResource(params: CodeArtifact.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CodeArtifact.Types.ListTagsForResourceResult) => void): Request<CodeArtifact.Types.ListTagsForResourceResult, AWSError>;
  315. /**
  316. * Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
  317. */
  318. listTagsForResource(callback?: (err: AWSError, data: CodeArtifact.Types.ListTagsForResourceResult) => void): Request<CodeArtifact.Types.ListTagsForResourceResult, AWSError>;
  319. /**
  320. * Creates a new package version containing one or more assets (or files). The unfinished flag can be used to keep the package version in the Unfinished state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status to Published, omit the unfinished flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set to Published, it cannot change back to Unfinished. Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.
  321. */
  322. publishPackageVersion(params: CodeArtifact.Types.PublishPackageVersionRequest, callback?: (err: AWSError, data: CodeArtifact.Types.PublishPackageVersionResult) => void): Request<CodeArtifact.Types.PublishPackageVersionResult, AWSError>;
  323. /**
  324. * Creates a new package version containing one or more assets (or files). The unfinished flag can be used to keep the package version in the Unfinished state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status to Published, omit the unfinished flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set to Published, it cannot change back to Unfinished. Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.
  325. */
  326. publishPackageVersion(callback?: (err: AWSError, data: CodeArtifact.Types.PublishPackageVersionResult) => void): Request<CodeArtifact.Types.PublishPackageVersionResult, AWSError>;
  327. /**
  328. * Sets a resource policy on a domain that specifies permissions to access it. When you call PutDomainPermissionsPolicy, the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.
  329. */
  330. putDomainPermissionsPolicy(params: CodeArtifact.Types.PutDomainPermissionsPolicyRequest, callback?: (err: AWSError, data: CodeArtifact.Types.PutDomainPermissionsPolicyResult) => void): Request<CodeArtifact.Types.PutDomainPermissionsPolicyResult, AWSError>;
  331. /**
  332. * Sets a resource policy on a domain that specifies permissions to access it. When you call PutDomainPermissionsPolicy, the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.
  333. */
  334. putDomainPermissionsPolicy(callback?: (err: AWSError, data: CodeArtifact.Types.PutDomainPermissionsPolicyResult) => void): Request<CodeArtifact.Types.PutDomainPermissionsPolicyResult, AWSError>;
  335. /**
  336. * Sets the package origin configuration for a package. The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide. PutPackageOriginConfiguration can be called on a package that doesn't yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.
  337. */
  338. putPackageOriginConfiguration(params: CodeArtifact.Types.PutPackageOriginConfigurationRequest, callback?: (err: AWSError, data: CodeArtifact.Types.PutPackageOriginConfigurationResult) => void): Request<CodeArtifact.Types.PutPackageOriginConfigurationResult, AWSError>;
  339. /**
  340. * Sets the package origin configuration for a package. The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide. PutPackageOriginConfiguration can be called on a package that doesn't yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.
  341. */
  342. putPackageOriginConfiguration(callback?: (err: AWSError, data: CodeArtifact.Types.PutPackageOriginConfigurationResult) => void): Request<CodeArtifact.Types.PutPackageOriginConfigurationResult, AWSError>;
  343. /**
  344. * Sets the resource policy on a repository that specifies permissions to access it. When you call PutRepositoryPermissionsPolicy, the resource policy on the repository is ignored when evaluting permissions. This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being able to update the resource policy.
  345. */
  346. putRepositoryPermissionsPolicy(params: CodeArtifact.Types.PutRepositoryPermissionsPolicyRequest, callback?: (err: AWSError, data: CodeArtifact.Types.PutRepositoryPermissionsPolicyResult) => void): Request<CodeArtifact.Types.PutRepositoryPermissionsPolicyResult, AWSError>;
  347. /**
  348. * Sets the resource policy on a repository that specifies permissions to access it. When you call PutRepositoryPermissionsPolicy, the resource policy on the repository is ignored when evaluting permissions. This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being able to update the resource policy.
  349. */
  350. putRepositoryPermissionsPolicy(callback?: (err: AWSError, data: CodeArtifact.Types.PutRepositoryPermissionsPolicyResult) => void): Request<CodeArtifact.Types.PutRepositoryPermissionsPolicyResult, AWSError>;
  351. /**
  352. * Adds or updates tags for a resource in CodeArtifact.
  353. */
  354. tagResource(params: CodeArtifact.Types.TagResourceRequest, callback?: (err: AWSError, data: CodeArtifact.Types.TagResourceResult) => void): Request<CodeArtifact.Types.TagResourceResult, AWSError>;
  355. /**
  356. * Adds or updates tags for a resource in CodeArtifact.
  357. */
  358. tagResource(callback?: (err: AWSError, data: CodeArtifact.Types.TagResourceResult) => void): Request<CodeArtifact.Types.TagResourceResult, AWSError>;
  359. /**
  360. * Removes tags from a resource in CodeArtifact.
  361. */
  362. untagResource(params: CodeArtifact.Types.UntagResourceRequest, callback?: (err: AWSError, data: CodeArtifact.Types.UntagResourceResult) => void): Request<CodeArtifact.Types.UntagResourceResult, AWSError>;
  363. /**
  364. * Removes tags from a resource in CodeArtifact.
  365. */
  366. untagResource(callback?: (err: AWSError, data: CodeArtifact.Types.UntagResourceResult) => void): Request<CodeArtifact.Types.UntagResourceResult, AWSError>;
  367. /**
  368. * Updates a package group. This API cannot be used to update a package group's origin configuration or pattern. To update a package group's origin configuration, use UpdatePackageGroupOriginConfiguration.
  369. */
  370. updatePackageGroup(params: CodeArtifact.Types.UpdatePackageGroupRequest, callback?: (err: AWSError, data: CodeArtifact.Types.UpdatePackageGroupResult) => void): Request<CodeArtifact.Types.UpdatePackageGroupResult, AWSError>;
  371. /**
  372. * Updates a package group. This API cannot be used to update a package group's origin configuration or pattern. To update a package group's origin configuration, use UpdatePackageGroupOriginConfiguration.
  373. */
  374. updatePackageGroup(callback?: (err: AWSError, data: CodeArtifact.Types.UpdatePackageGroupResult) => void): Request<CodeArtifact.Types.UpdatePackageGroupResult, AWSError>;
  375. /**
  376. * Updates the package origin configuration for a package group. The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package group origin controls and configuration, see Package group origin controls in the CodeArtifact User Guide.
  377. */
  378. updatePackageGroupOriginConfiguration(params: CodeArtifact.Types.UpdatePackageGroupOriginConfigurationRequest, callback?: (err: AWSError, data: CodeArtifact.Types.UpdatePackageGroupOriginConfigurationResult) => void): Request<CodeArtifact.Types.UpdatePackageGroupOriginConfigurationResult, AWSError>;
  379. /**
  380. * Updates the package origin configuration for a package group. The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package group origin controls and configuration, see Package group origin controls in the CodeArtifact User Guide.
  381. */
  382. updatePackageGroupOriginConfiguration(callback?: (err: AWSError, data: CodeArtifact.Types.UpdatePackageGroupOriginConfigurationResult) => void): Request<CodeArtifact.Types.UpdatePackageGroupOriginConfigurationResult, AWSError>;
  383. /**
  384. * Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, you can update the status of package versions to Archived, Published, or Unlisted. To set the status of a package version to Disposed, use DisposePackageVersions.
  385. */
  386. updatePackageVersionsStatus(params: CodeArtifact.Types.UpdatePackageVersionsStatusRequest, callback?: (err: AWSError, data: CodeArtifact.Types.UpdatePackageVersionsStatusResult) => void): Request<CodeArtifact.Types.UpdatePackageVersionsStatusResult, AWSError>;
  387. /**
  388. * Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, you can update the status of package versions to Archived, Published, or Unlisted. To set the status of a package version to Disposed, use DisposePackageVersions.
  389. */
  390. updatePackageVersionsStatus(callback?: (err: AWSError, data: CodeArtifact.Types.UpdatePackageVersionsStatusResult) => void): Request<CodeArtifact.Types.UpdatePackageVersionsStatusResult, AWSError>;
  391. /**
  392. * Update the properties of a repository.
  393. */
  394. updateRepository(params: CodeArtifact.Types.UpdateRepositoryRequest, callback?: (err: AWSError, data: CodeArtifact.Types.UpdateRepositoryResult) => void): Request<CodeArtifact.Types.UpdateRepositoryResult, AWSError>;
  395. /**
  396. * Update the properties of a repository.
  397. */
  398. updateRepository(callback?: (err: AWSError, data: CodeArtifact.Types.UpdateRepositoryResult) => void): Request<CodeArtifact.Types.UpdateRepositoryResult, AWSError>;
  399. }
  400. declare namespace CodeArtifact {
  401. export type AccountId = string;
  402. export type AllowPublish = "ALLOW"|"BLOCK"|string;
  403. export type AllowUpstream = "ALLOW"|"BLOCK"|string;
  404. export type Arn = string;
  405. export type Asset = Buffer|Uint8Array|Blob|string|Readable;
  406. export type AssetHashes = {[key: string]: HashValue};
  407. export type AssetName = string;
  408. export interface AssetSummary {
  409. /**
  410. * The name of the asset.
  411. */
  412. name: AssetName;
  413. /**
  414. * The size of the asset.
  415. */
  416. size?: LongOptional;
  417. /**
  418. * The hashes of the asset.
  419. */
  420. hashes?: AssetHashes;
  421. }
  422. export type AssetSummaryList = AssetSummary[];
  423. export interface AssociateExternalConnectionRequest {
  424. /**
  425. * The name of the domain that contains the repository.
  426. */
  427. domain: DomainName;
  428. /**
  429. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  430. */
  431. domainOwner?: AccountId;
  432. /**
  433. * The name of the repository to which the external connection is added.
  434. */
  435. repository: RepositoryName;
  436. /**
  437. * The name of the external connection to add to the repository. The following values are supported: public:npmjs - for the npm public repository. public:nuget-org - for the NuGet Gallery. public:pypi - for the Python Package Index. public:maven-central - for Maven Central. public:maven-googleandroid - for the Google Android repository. public:maven-gradleplugins - for the Gradle plugins repository. public:maven-commonsware - for the CommonsWare Android repository. public:maven-clojars - for the Clojars repository.
  438. */
  439. externalConnection: ExternalConnectionName;
  440. }
  441. export interface AssociateExternalConnectionResult {
  442. /**
  443. * Information about the connected repository after processing the request.
  444. */
  445. repository?: RepositoryDescription;
  446. }
  447. export interface AssociatedPackage {
  448. /**
  449. * A format that specifies the type of the associated package.
  450. */
  451. format?: PackageFormat;
  452. /**
  453. * The namespace of the associated package. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  454. */
  455. namespace?: PackageNamespace;
  456. /**
  457. * The name of the associated package.
  458. */
  459. package?: PackageName;
  460. /**
  461. * Describes the strength of the association between the package and package group. A strong match can be thought of as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches a variation of the package group pattern. For more information about package group pattern matching, including strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
  462. */
  463. associationType?: PackageGroupAssociationType;
  464. }
  465. export type AssociatedPackageList = AssociatedPackage[];
  466. export type AuthorizationTokenDurationSeconds = number;
  467. export type BooleanOptional = boolean;
  468. export interface CopyPackageVersionsRequest {
  469. /**
  470. * The name of the domain that contains the source and destination repositories.
  471. */
  472. domain: DomainName;
  473. /**
  474. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  475. */
  476. domainOwner?: AccountId;
  477. /**
  478. * The name of the repository that contains the package versions to be copied.
  479. */
  480. sourceRepository: RepositoryName;
  481. /**
  482. * The name of the repository into which package versions are copied.
  483. */
  484. destinationRepository: RepositoryName;
  485. /**
  486. * The format of the package versions to be copied.
  487. */
  488. format: PackageFormat;
  489. /**
  490. * The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example: The namespace is required when copying package versions of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  491. */
  492. namespace?: PackageNamespace;
  493. /**
  494. * The name of the package that contains the versions to be copied.
  495. */
  496. package: PackageName;
  497. /**
  498. * The versions of the package to be copied. You must specify versions or versionRevisions. You cannot specify both.
  499. */
  500. versions?: PackageVersionList;
  501. /**
  502. * A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision. You must specify versions or versionRevisions. You cannot specify both.
  503. */
  504. versionRevisions?: PackageVersionRevisionMap;
  505. /**
  506. * Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code.
  507. */
  508. allowOverwrite?: BooleanOptional;
  509. /**
  510. * Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories.
  511. */
  512. includeFromUpstream?: BooleanOptional;
  513. }
  514. export interface CopyPackageVersionsResult {
  515. /**
  516. * A list of the package versions that were successfully copied to your repository.
  517. */
  518. successfulVersions?: SuccessfulPackageVersionInfoMap;
  519. /**
  520. * A map of package versions that failed to copy and their error codes. The possible error codes are in the PackageVersionError data type. They are: ALREADY_EXISTS MISMATCHED_REVISION MISMATCHED_STATUS NOT_ALLOWED NOT_FOUND SKIPPED
  521. */
  522. failedVersions?: PackageVersionErrorMap;
  523. }
  524. export interface CreateDomainRequest {
  525. /**
  526. * The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
  527. */
  528. domain: DomainName;
  529. /**
  530. * The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide. CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.
  531. */
  532. encryptionKey?: Arn;
  533. /**
  534. * One or more tag key-value pairs for the domain.
  535. */
  536. tags?: TagList;
  537. }
  538. export interface CreateDomainResult {
  539. /**
  540. * Contains information about the created domain after processing the request.
  541. */
  542. domain?: DomainDescription;
  543. }
  544. export interface CreatePackageGroupRequest {
  545. /**
  546. * The name of the domain in which you want to create a package group.
  547. */
  548. domain: DomainName;
  549. /**
  550. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  551. */
  552. domainOwner?: AccountId;
  553. /**
  554. * The pattern of the package group to create. The pattern is also the identifier of the package group.
  555. */
  556. packageGroup: PackageGroupPattern;
  557. /**
  558. * The contact information for the created package group.
  559. */
  560. contactInfo?: PackageGroupContactInfo;
  561. /**
  562. * A description of the package group.
  563. */
  564. description?: Description;
  565. /**
  566. * One or more tag key-value pairs for the package group.
  567. */
  568. tags?: TagList;
  569. }
  570. export interface CreatePackageGroupResult {
  571. /**
  572. * Information about the created package group after processing the request.
  573. */
  574. packageGroup?: PackageGroupDescription;
  575. }
  576. export interface CreateRepositoryRequest {
  577. /**
  578. * The name of the domain that contains the created repository.
  579. */
  580. domain: DomainName;
  581. /**
  582. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  583. */
  584. domainOwner?: AccountId;
  585. /**
  586. * The name of the repository to create.
  587. */
  588. repository: RepositoryName;
  589. /**
  590. * A description of the created repository.
  591. */
  592. description?: Description;
  593. /**
  594. * A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.
  595. */
  596. upstreams?: UpstreamRepositoryList;
  597. /**
  598. * One or more tag key-value pairs for the repository.
  599. */
  600. tags?: TagList;
  601. }
  602. export interface CreateRepositoryResult {
  603. /**
  604. * Information about the created repository after processing the request.
  605. */
  606. repository?: RepositoryDescription;
  607. }
  608. export interface DeleteDomainPermissionsPolicyRequest {
  609. /**
  610. * The name of the domain associated with the resource policy to be deleted.
  611. */
  612. domain: DomainName;
  613. /**
  614. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  615. */
  616. domainOwner?: AccountId;
  617. /**
  618. * The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
  619. */
  620. policyRevision?: PolicyRevision;
  621. }
  622. export interface DeleteDomainPermissionsPolicyResult {
  623. /**
  624. * Information about the deleted resource policy after processing the request.
  625. */
  626. policy?: ResourcePolicy;
  627. }
  628. export interface DeleteDomainRequest {
  629. /**
  630. * The name of the domain to delete.
  631. */
  632. domain: DomainName;
  633. /**
  634. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  635. */
  636. domainOwner?: AccountId;
  637. }
  638. export interface DeleteDomainResult {
  639. /**
  640. * Contains information about the deleted domain after processing the request.
  641. */
  642. domain?: DomainDescription;
  643. }
  644. export interface DeletePackageGroupRequest {
  645. /**
  646. * The domain that contains the package group to be deleted.
  647. */
  648. domain: DomainName;
  649. /**
  650. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  651. */
  652. domainOwner?: AccountId;
  653. /**
  654. * The pattern of the package group to be deleted.
  655. */
  656. packageGroup: String;
  657. }
  658. export interface DeletePackageGroupResult {
  659. /**
  660. * Information about the deleted package group after processing the request.
  661. */
  662. packageGroup?: PackageGroupDescription;
  663. }
  664. export interface DeletePackageRequest {
  665. /**
  666. * The name of the domain that contains the package to delete.
  667. */
  668. domain: DomainName;
  669. /**
  670. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  671. */
  672. domainOwner?: AccountId;
  673. /**
  674. * The name of the repository that contains the package to delete.
  675. */
  676. repository: RepositoryName;
  677. /**
  678. * The format of the requested package to delete.
  679. */
  680. format: PackageFormat;
  681. /**
  682. * The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example: The namespace is required when deleting packages of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  683. */
  684. namespace?: PackageNamespace;
  685. /**
  686. * The name of the package to delete.
  687. */
  688. package: PackageName;
  689. }
  690. export interface DeletePackageResult {
  691. deletedPackage?: PackageSummary;
  692. }
  693. export interface DeletePackageVersionsRequest {
  694. /**
  695. * The name of the domain that contains the package to delete.
  696. */
  697. domain: DomainName;
  698. /**
  699. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  700. */
  701. domainOwner?: AccountId;
  702. /**
  703. * The name of the repository that contains the package versions to delete.
  704. */
  705. repository: RepositoryName;
  706. /**
  707. * The format of the package versions to delete.
  708. */
  709. format: PackageFormat;
  710. /**
  711. * The namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example: The namespace is required when deleting package versions of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  712. */
  713. namespace?: PackageNamespace;
  714. /**
  715. * The name of the package with the versions to delete.
  716. */
  717. package: PackageName;
  718. /**
  719. * An array of strings that specify the versions of the package to delete.
  720. */
  721. versions: PackageVersionList;
  722. /**
  723. * The expected status of the package version to delete.
  724. */
  725. expectedStatus?: PackageVersionStatus;
  726. }
  727. export interface DeletePackageVersionsResult {
  728. /**
  729. * A list of the package versions that were successfully deleted. The status of every successful version will be Deleted.
  730. */
  731. successfulVersions?: SuccessfulPackageVersionInfoMap;
  732. /**
  733. * A PackageVersionError object that contains a map of errors codes for the deleted package that failed. The possible error codes are: ALREADY_EXISTS MISMATCHED_REVISION MISMATCHED_STATUS NOT_ALLOWED NOT_FOUND SKIPPED
  734. */
  735. failedVersions?: PackageVersionErrorMap;
  736. }
  737. export interface DeleteRepositoryPermissionsPolicyRequest {
  738. /**
  739. * The name of the domain that contains the repository associated with the resource policy to be deleted.
  740. */
  741. domain: DomainName;
  742. /**
  743. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  744. */
  745. domainOwner?: AccountId;
  746. /**
  747. * The name of the repository that is associated with the resource policy to be deleted
  748. */
  749. repository: RepositoryName;
  750. /**
  751. * The revision of the repository's resource policy to be deleted. This revision is used for optimistic locking, which prevents others from accidentally overwriting your changes to the repository's resource policy.
  752. */
  753. policyRevision?: PolicyRevision;
  754. }
  755. export interface DeleteRepositoryPermissionsPolicyResult {
  756. /**
  757. * Information about the deleted policy after processing the request.
  758. */
  759. policy?: ResourcePolicy;
  760. }
  761. export interface DeleteRepositoryRequest {
  762. /**
  763. * The name of the domain that contains the repository to delete.
  764. */
  765. domain: DomainName;
  766. /**
  767. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  768. */
  769. domainOwner?: AccountId;
  770. /**
  771. * The name of the repository to delete.
  772. */
  773. repository: RepositoryName;
  774. }
  775. export interface DeleteRepositoryResult {
  776. /**
  777. * Information about the deleted repository after processing the request.
  778. */
  779. repository?: RepositoryDescription;
  780. }
  781. export interface DescribeDomainRequest {
  782. /**
  783. * A string that specifies the name of the requested domain.
  784. */
  785. domain: DomainName;
  786. /**
  787. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  788. */
  789. domainOwner?: AccountId;
  790. }
  791. export interface DescribeDomainResult {
  792. domain?: DomainDescription;
  793. }
  794. export interface DescribePackageGroupRequest {
  795. /**
  796. * The name of the domain that contains the package group.
  797. */
  798. domain: DomainName;
  799. /**
  800. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  801. */
  802. domainOwner?: AccountId;
  803. /**
  804. * The pattern of the requested package group.
  805. */
  806. packageGroup: PackageGroupPattern;
  807. }
  808. export interface DescribePackageGroupResult {
  809. /**
  810. * A PackageGroupDescription object that contains information about the requested package group.
  811. */
  812. packageGroup?: PackageGroupDescription;
  813. }
  814. export interface DescribePackageRequest {
  815. /**
  816. * The name of the domain that contains the repository that contains the package.
  817. */
  818. domain: DomainName;
  819. /**
  820. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  821. */
  822. domainOwner?: AccountId;
  823. /**
  824. * The name of the repository that contains the requested package.
  825. */
  826. repository: RepositoryName;
  827. /**
  828. * A format that specifies the type of the requested package.
  829. */
  830. format: PackageFormat;
  831. /**
  832. * The namespace of the requested package. The package component that specifies its namespace depends on its type. For example: The namespace is required when requesting packages of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  833. */
  834. namespace?: PackageNamespace;
  835. /**
  836. * The name of the requested package.
  837. */
  838. package: PackageName;
  839. }
  840. export interface DescribePackageResult {
  841. /**
  842. * A PackageDescription object that contains information about the requested package.
  843. */
  844. package: PackageDescription;
  845. }
  846. export interface DescribePackageVersionRequest {
  847. /**
  848. * The name of the domain that contains the repository that contains the package version.
  849. */
  850. domain: DomainName;
  851. /**
  852. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  853. */
  854. domainOwner?: AccountId;
  855. /**
  856. * The name of the repository that contains the package version.
  857. */
  858. repository: RepositoryName;
  859. /**
  860. * A format that specifies the type of the requested package version.
  861. */
  862. format: PackageFormat;
  863. /**
  864. * The namespace of the requested package version. The package component that specifies its namespace depends on its type. For example: The namespace is required when requesting package versions of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  865. */
  866. namespace?: PackageNamespace;
  867. /**
  868. * The name of the requested package version.
  869. */
  870. package: PackageName;
  871. /**
  872. * A string that contains the package version (for example, 3.5.2).
  873. */
  874. packageVersion: PackageVersion;
  875. }
  876. export interface DescribePackageVersionResult {
  877. /**
  878. * A PackageVersionDescription object that contains information about the requested package version.
  879. */
  880. packageVersion: PackageVersionDescription;
  881. }
  882. export interface DescribeRepositoryRequest {
  883. /**
  884. * The name of the domain that contains the repository to describe.
  885. */
  886. domain: DomainName;
  887. /**
  888. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  889. */
  890. domainOwner?: AccountId;
  891. /**
  892. * A string that specifies the name of the requested repository.
  893. */
  894. repository: RepositoryName;
  895. }
  896. export interface DescribeRepositoryResult {
  897. /**
  898. * A RepositoryDescription object that contains the requested repository information.
  899. */
  900. repository?: RepositoryDescription;
  901. }
  902. export type Description = string;
  903. export interface DisassociateExternalConnectionRequest {
  904. /**
  905. * The name of the domain that contains the repository from which to remove the external repository.
  906. */
  907. domain: DomainName;
  908. /**
  909. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  910. */
  911. domainOwner?: AccountId;
  912. /**
  913. * The name of the repository from which the external connection will be removed.
  914. */
  915. repository: RepositoryName;
  916. /**
  917. * The name of the external connection to be removed from the repository.
  918. */
  919. externalConnection: ExternalConnectionName;
  920. }
  921. export interface DisassociateExternalConnectionResult {
  922. /**
  923. * The repository associated with the removed external connection.
  924. */
  925. repository?: RepositoryDescription;
  926. }
  927. export interface DisposePackageVersionsRequest {
  928. /**
  929. * The name of the domain that contains the repository you want to dispose.
  930. */
  931. domain: DomainName;
  932. /**
  933. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  934. */
  935. domainOwner?: AccountId;
  936. /**
  937. * The name of the repository that contains the package versions you want to dispose.
  938. */
  939. repository: RepositoryName;
  940. /**
  941. * A format that specifies the type of package versions you want to dispose.
  942. */
  943. format: PackageFormat;
  944. /**
  945. * The namespace of the package versions to be disposed. The package component that specifies its namespace depends on its type. For example: The namespace is required when disposing package versions of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  946. */
  947. namespace?: PackageNamespace;
  948. /**
  949. * The name of the package with the versions you want to dispose.
  950. */
  951. package: PackageName;
  952. /**
  953. * The versions of the package you want to dispose.
  954. */
  955. versions: PackageVersionList;
  956. /**
  957. * The revisions of the package versions you want to dispose.
  958. */
  959. versionRevisions?: PackageVersionRevisionMap;
  960. /**
  961. * The expected status of the package version to dispose.
  962. */
  963. expectedStatus?: PackageVersionStatus;
  964. }
  965. export interface DisposePackageVersionsResult {
  966. /**
  967. * A list of the package versions that were successfully disposed.
  968. */
  969. successfulVersions?: SuccessfulPackageVersionInfoMap;
  970. /**
  971. * A PackageVersionError object that contains a map of errors codes for the disposed package versions that failed. The possible error codes are: ALREADY_EXISTS MISMATCHED_REVISION MISMATCHED_STATUS NOT_ALLOWED NOT_FOUND SKIPPED
  972. */
  973. failedVersions?: PackageVersionErrorMap;
  974. }
  975. export interface DomainDescription {
  976. /**
  977. * The name of the domain.
  978. */
  979. name?: DomainName;
  980. /**
  981. * The Amazon Web Services account ID that owns the domain.
  982. */
  983. owner?: AccountId;
  984. /**
  985. * The Amazon Resource Name (ARN) of the domain.
  986. */
  987. arn?: Arn;
  988. /**
  989. * The current status of a domain.
  990. */
  991. status?: DomainStatus;
  992. /**
  993. * A timestamp that represents the date and time the domain was created.
  994. */
  995. createdTime?: Timestamp;
  996. /**
  997. * The ARN of an Key Management Service (KMS) key associated with a domain.
  998. */
  999. encryptionKey?: Arn;
  1000. /**
  1001. * The number of repositories in the domain.
  1002. */
  1003. repositoryCount?: Integer;
  1004. /**
  1005. * The total size of all assets in the domain.
  1006. */
  1007. assetSizeBytes?: Long;
  1008. /**
  1009. * The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.
  1010. */
  1011. s3BucketArn?: Arn;
  1012. }
  1013. export interface DomainEntryPoint {
  1014. /**
  1015. * The name of the repository that a package was originally published to.
  1016. */
  1017. repositoryName?: RepositoryName;
  1018. /**
  1019. * The name of the external connection that a package was ingested from.
  1020. */
  1021. externalConnectionName?: ExternalConnectionName;
  1022. }
  1023. export type DomainName = string;
  1024. export type DomainStatus = "Active"|"Deleted"|string;
  1025. export interface DomainSummary {
  1026. /**
  1027. * The name of the domain.
  1028. */
  1029. name?: DomainName;
  1030. /**
  1031. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1032. */
  1033. owner?: AccountId;
  1034. /**
  1035. * The ARN of the domain.
  1036. */
  1037. arn?: Arn;
  1038. /**
  1039. * A string that contains the status of the domain.
  1040. */
  1041. status?: DomainStatus;
  1042. /**
  1043. * A timestamp that contains the date and time the domain was created.
  1044. */
  1045. createdTime?: Timestamp;
  1046. /**
  1047. * The key used to encrypt the domain.
  1048. */
  1049. encryptionKey?: Arn;
  1050. }
  1051. export type DomainSummaryList = DomainSummary[];
  1052. export type ErrorMessage = string;
  1053. export type ExternalConnectionName = string;
  1054. export type ExternalConnectionStatus = "Available"|string;
  1055. export interface GetAssociatedPackageGroupRequest {
  1056. /**
  1057. * The name of the domain that contains the package from which to get the associated package group.
  1058. */
  1059. domain: DomainName;
  1060. /**
  1061. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1062. */
  1063. domainOwner?: AccountId;
  1064. /**
  1065. * The format of the package from which to get the associated package group.
  1066. */
  1067. format: PackageFormat;
  1068. /**
  1069. * The namespace of the package from which to get the associated package group. The package component that specifies its namespace depends on its type. For example: The namespace is required when getting associated package groups from packages of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1070. */
  1071. namespace?: PackageNamespace;
  1072. /**
  1073. * The package from which to get the associated package group.
  1074. */
  1075. package: PackageName;
  1076. }
  1077. export interface GetAssociatedPackageGroupResult {
  1078. /**
  1079. * The package group that is associated with the requested package.
  1080. */
  1081. packageGroup?: PackageGroupDescription;
  1082. /**
  1083. * Describes the strength of the association between the package and package group. A strong match is also known as an exact match, and a weak match is known as a relative match.
  1084. */
  1085. associationType?: PackageGroupAssociationType;
  1086. }
  1087. export interface GetAuthorizationTokenRequest {
  1088. /**
  1089. * The name of the domain that is in scope for the generated authorization token.
  1090. */
  1091. domain: DomainName;
  1092. /**
  1093. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1094. */
  1095. domainOwner?: AccountId;
  1096. /**
  1097. * The time, in seconds, that the generated authorization token is valid. Valid values are 0 and any number between 900 (15 minutes) and 43200 (12 hours). A value of 0 will set the expiration of the authorization token to the same expiration of the user's role's temporary credentials.
  1098. */
  1099. durationSeconds?: AuthorizationTokenDurationSeconds;
  1100. }
  1101. export interface GetAuthorizationTokenResult {
  1102. /**
  1103. * The returned authentication token.
  1104. */
  1105. authorizationToken?: String;
  1106. /**
  1107. * A timestamp that specifies the date and time the authorization token expires.
  1108. */
  1109. expiration?: Timestamp;
  1110. }
  1111. export interface GetDomainPermissionsPolicyRequest {
  1112. /**
  1113. * The name of the domain to which the resource policy is attached.
  1114. */
  1115. domain: DomainName;
  1116. /**
  1117. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1118. */
  1119. domainOwner?: AccountId;
  1120. }
  1121. export interface GetDomainPermissionsPolicyResult {
  1122. /**
  1123. * The returned resource policy.
  1124. */
  1125. policy?: ResourcePolicy;
  1126. }
  1127. export interface GetPackageVersionAssetRequest {
  1128. /**
  1129. * The name of the domain that contains the repository that contains the package version with the requested asset.
  1130. */
  1131. domain: DomainName;
  1132. /**
  1133. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1134. */
  1135. domainOwner?: AccountId;
  1136. /**
  1137. * The repository that contains the package version with the requested asset.
  1138. */
  1139. repository: RepositoryName;
  1140. /**
  1141. * A format that specifies the type of the package version with the requested asset file.
  1142. */
  1143. format: PackageFormat;
  1144. /**
  1145. * The namespace of the package version with the requested asset file. The package component that specifies its namespace depends on its type. For example: The namespace is required when requesting assets from package versions of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1146. */
  1147. namespace?: PackageNamespace;
  1148. /**
  1149. * The name of the package that contains the requested asset.
  1150. */
  1151. package: PackageName;
  1152. /**
  1153. * A string that contains the package version (for example, 3.5.2).
  1154. */
  1155. packageVersion: PackageVersion;
  1156. /**
  1157. * The name of the requested asset.
  1158. */
  1159. asset: AssetName;
  1160. /**
  1161. * The name of the package version revision that contains the requested asset.
  1162. */
  1163. packageVersionRevision?: PackageVersionRevision;
  1164. }
  1165. export interface GetPackageVersionAssetResult {
  1166. /**
  1167. * The binary file, or asset, that is downloaded.
  1168. */
  1169. asset?: Asset;
  1170. /**
  1171. * The name of the asset that is downloaded.
  1172. */
  1173. assetName?: AssetName;
  1174. /**
  1175. * A string that contains the package version (for example, 3.5.2).
  1176. */
  1177. packageVersion?: PackageVersion;
  1178. /**
  1179. * The name of the package version revision that contains the downloaded asset.
  1180. */
  1181. packageVersionRevision?: PackageVersionRevision;
  1182. }
  1183. export interface GetPackageVersionReadmeRequest {
  1184. /**
  1185. * The name of the domain that contains the repository that contains the package version with the requested readme file.
  1186. */
  1187. domain: DomainName;
  1188. /**
  1189. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1190. */
  1191. domainOwner?: AccountId;
  1192. /**
  1193. * The repository that contains the package with the requested readme file.
  1194. */
  1195. repository: RepositoryName;
  1196. /**
  1197. * A format that specifies the type of the package version with the requested readme file.
  1198. */
  1199. format: PackageFormat;
  1200. /**
  1201. * The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example: The namespace is required when requesting the readme from package versions of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1202. */
  1203. namespace?: PackageNamespace;
  1204. /**
  1205. * The name of the package version that contains the requested readme file.
  1206. */
  1207. package: PackageName;
  1208. /**
  1209. * A string that contains the package version (for example, 3.5.2).
  1210. */
  1211. packageVersion: PackageVersion;
  1212. }
  1213. export interface GetPackageVersionReadmeResult {
  1214. /**
  1215. * The format of the package with the requested readme file.
  1216. */
  1217. format?: PackageFormat;
  1218. /**
  1219. * The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1220. */
  1221. namespace?: PackageNamespace;
  1222. /**
  1223. * The name of the package that contains the returned readme file.
  1224. */
  1225. package?: PackageName;
  1226. /**
  1227. * The version of the package with the requested readme file.
  1228. */
  1229. version?: PackageVersion;
  1230. /**
  1231. * The current revision associated with the package version.
  1232. */
  1233. versionRevision?: PackageVersionRevision;
  1234. /**
  1235. * The text of the returned readme file.
  1236. */
  1237. readme?: String;
  1238. }
  1239. export interface GetRepositoryEndpointRequest {
  1240. /**
  1241. * The name of the domain that contains the repository.
  1242. */
  1243. domain: DomainName;
  1244. /**
  1245. * The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.
  1246. */
  1247. domainOwner?: AccountId;
  1248. /**
  1249. * The name of the repository.
  1250. */
  1251. repository: RepositoryName;
  1252. /**
  1253. * Returns which endpoint of a repository to return. A repository has one endpoint for each package format.
  1254. */
  1255. format: PackageFormat;
  1256. }
  1257. export interface GetRepositoryEndpointResult {
  1258. /**
  1259. * A string that specifies the URL of the returned endpoint.
  1260. */
  1261. repositoryEndpoint?: String;
  1262. }
  1263. export interface GetRepositoryPermissionsPolicyRequest {
  1264. /**
  1265. * The name of the domain containing the repository whose associated resource policy is to be retrieved.
  1266. */
  1267. domain: DomainName;
  1268. /**
  1269. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1270. */
  1271. domainOwner?: AccountId;
  1272. /**
  1273. * The name of the repository whose associated resource policy is to be retrieved.
  1274. */
  1275. repository: RepositoryName;
  1276. }
  1277. export interface GetRepositoryPermissionsPolicyResult {
  1278. /**
  1279. * The returned resource policy.
  1280. */
  1281. policy?: ResourcePolicy;
  1282. }
  1283. export type HashAlgorithm = "MD5"|"SHA-1"|"SHA-256"|"SHA-512"|string;
  1284. export type HashValue = string;
  1285. export type Integer = number;
  1286. export interface LicenseInfo {
  1287. /**
  1288. * Name of the license.
  1289. */
  1290. name?: String;
  1291. /**
  1292. * The URL for license data.
  1293. */
  1294. url?: String;
  1295. }
  1296. export type LicenseInfoList = LicenseInfo[];
  1297. export type ListAllowedRepositoriesForGroupMaxResults = number;
  1298. export interface ListAllowedRepositoriesForGroupRequest {
  1299. /**
  1300. * The name of the domain that contains the package group from which to list allowed repositories.
  1301. */
  1302. domain: DomainName;
  1303. /**
  1304. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1305. */
  1306. domainOwner?: AccountId;
  1307. /**
  1308. * The pattern of the package group from which to list allowed repositories.
  1309. */
  1310. packageGroup: PackageGroupPattern;
  1311. /**
  1312. * The origin configuration restriction type of which to list allowed repositories.
  1313. */
  1314. originRestrictionType: PackageGroupOriginRestrictionType;
  1315. /**
  1316. * The maximum number of results to return per page.
  1317. */
  1318. maxResults?: ListAllowedRepositoriesForGroupMaxResults;
  1319. /**
  1320. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1321. */
  1322. nextToken?: PaginationToken;
  1323. }
  1324. export interface ListAllowedRepositoriesForGroupResult {
  1325. /**
  1326. * The list of allowed repositories for the package group and origin configuration restriction type.
  1327. */
  1328. allowedRepositories?: RepositoryNameList;
  1329. /**
  1330. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1331. */
  1332. nextToken?: PaginationToken;
  1333. }
  1334. export interface ListAssociatedPackagesRequest {
  1335. /**
  1336. * The name of the domain that contains the package group from which to list associated packages.
  1337. */
  1338. domain: DomainName;
  1339. /**
  1340. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1341. */
  1342. domainOwner?: AccountId;
  1343. /**
  1344. * The pattern of the package group from which to list associated packages.
  1345. */
  1346. packageGroup: PackageGroupPattern;
  1347. /**
  1348. * The maximum number of results to return per page.
  1349. */
  1350. maxResults?: ListPackagesMaxResults;
  1351. /**
  1352. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1353. */
  1354. nextToken?: PaginationToken;
  1355. /**
  1356. * When this flag is included, ListAssociatedPackages will return a list of packages that would be associated with a package group, even if it does not exist.
  1357. */
  1358. preview?: BooleanOptional;
  1359. }
  1360. export interface ListAssociatedPackagesResult {
  1361. /**
  1362. * The list of packages associated with the requested package group.
  1363. */
  1364. packages?: AssociatedPackageList;
  1365. /**
  1366. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1367. */
  1368. nextToken?: PaginationToken;
  1369. }
  1370. export type ListDomainsMaxResults = number;
  1371. export interface ListDomainsRequest {
  1372. /**
  1373. * The maximum number of results to return per page.
  1374. */
  1375. maxResults?: ListDomainsMaxResults;
  1376. /**
  1377. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1378. */
  1379. nextToken?: PaginationToken;
  1380. }
  1381. export interface ListDomainsResult {
  1382. /**
  1383. * The returned list of DomainSummary objects.
  1384. */
  1385. domains?: DomainSummaryList;
  1386. /**
  1387. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1388. */
  1389. nextToken?: PaginationToken;
  1390. }
  1391. export type ListPackageGroupsMaxResults = number;
  1392. export interface ListPackageGroupsRequest {
  1393. /**
  1394. * The domain for which you want to list package groups.
  1395. */
  1396. domain: DomainName;
  1397. /**
  1398. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1399. */
  1400. domainOwner?: AccountId;
  1401. /**
  1402. * The maximum number of results to return per page.
  1403. */
  1404. maxResults?: ListPackageGroupsMaxResults;
  1405. /**
  1406. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1407. */
  1408. nextToken?: PaginationToken;
  1409. /**
  1410. * A prefix for which to search package groups. When included, ListPackageGroups will return only package groups with patterns that match the prefix.
  1411. */
  1412. prefix?: PackageGroupPatternPrefix;
  1413. }
  1414. export interface ListPackageGroupsResult {
  1415. /**
  1416. * The list of package groups in the requested domain.
  1417. */
  1418. packageGroups?: PackageGroupSummaryList;
  1419. /**
  1420. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1421. */
  1422. nextToken?: PaginationToken;
  1423. }
  1424. export type ListPackageVersionAssetsMaxResults = number;
  1425. export interface ListPackageVersionAssetsRequest {
  1426. /**
  1427. * The name of the domain that contains the repository associated with the package version assets.
  1428. */
  1429. domain: DomainName;
  1430. /**
  1431. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1432. */
  1433. domainOwner?: AccountId;
  1434. /**
  1435. * The name of the repository that contains the package that contains the requested package version assets.
  1436. */
  1437. repository: RepositoryName;
  1438. /**
  1439. * The format of the package that contains the requested package version assets.
  1440. */
  1441. format: PackageFormat;
  1442. /**
  1443. * The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example: The namespace is required requesting assets from package versions of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1444. */
  1445. namespace?: PackageNamespace;
  1446. /**
  1447. * The name of the package that contains the requested package version assets.
  1448. */
  1449. package: PackageName;
  1450. /**
  1451. * A string that contains the package version (for example, 3.5.2).
  1452. */
  1453. packageVersion: PackageVersion;
  1454. /**
  1455. * The maximum number of results to return per page.
  1456. */
  1457. maxResults?: ListPackageVersionAssetsMaxResults;
  1458. /**
  1459. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1460. */
  1461. nextToken?: PaginationToken;
  1462. }
  1463. export interface ListPackageVersionAssetsResult {
  1464. /**
  1465. * The format of the package that contains the requested package version assets.
  1466. */
  1467. format?: PackageFormat;
  1468. /**
  1469. * The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1470. */
  1471. namespace?: PackageNamespace;
  1472. /**
  1473. * The name of the package that contains the requested package version assets.
  1474. */
  1475. package?: PackageName;
  1476. /**
  1477. * The version of the package associated with the requested assets.
  1478. */
  1479. version?: PackageVersion;
  1480. /**
  1481. * The current revision associated with the package version.
  1482. */
  1483. versionRevision?: PackageVersionRevision;
  1484. /**
  1485. * If there are additional results, this is the token for the next set of results.
  1486. */
  1487. nextToken?: PaginationToken;
  1488. /**
  1489. * The returned list of AssetSummary objects.
  1490. */
  1491. assets?: AssetSummaryList;
  1492. }
  1493. export interface ListPackageVersionDependenciesRequest {
  1494. /**
  1495. * The name of the domain that contains the repository that contains the requested package version dependencies.
  1496. */
  1497. domain: DomainName;
  1498. /**
  1499. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1500. */
  1501. domainOwner?: AccountId;
  1502. /**
  1503. * The name of the repository that contains the requested package version.
  1504. */
  1505. repository: RepositoryName;
  1506. /**
  1507. * The format of the package with the requested dependencies.
  1508. */
  1509. format: PackageFormat;
  1510. /**
  1511. * The namespace of the package version with the requested dependencies. The package component that specifies its namespace depends on its type. For example: The namespace is required when listing dependencies from package versions of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1512. */
  1513. namespace?: PackageNamespace;
  1514. /**
  1515. * The name of the package versions' package.
  1516. */
  1517. package: PackageName;
  1518. /**
  1519. * A string that contains the package version (for example, 3.5.2).
  1520. */
  1521. packageVersion: PackageVersion;
  1522. /**
  1523. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1524. */
  1525. nextToken?: PaginationToken;
  1526. }
  1527. export interface ListPackageVersionDependenciesResult {
  1528. /**
  1529. * A format that specifies the type of the package that contains the returned dependencies.
  1530. */
  1531. format?: PackageFormat;
  1532. /**
  1533. * The namespace of the package version that contains the returned dependencies. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1534. */
  1535. namespace?: PackageNamespace;
  1536. /**
  1537. * The name of the package that contains the returned package versions dependencies.
  1538. */
  1539. package?: PackageName;
  1540. /**
  1541. * The version of the package that is specified in the request.
  1542. */
  1543. version?: PackageVersion;
  1544. /**
  1545. * The current revision associated with the package version.
  1546. */
  1547. versionRevision?: PackageVersionRevision;
  1548. /**
  1549. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1550. */
  1551. nextToken?: PaginationToken;
  1552. /**
  1553. * The returned list of PackageDependency objects.
  1554. */
  1555. dependencies?: PackageDependencyList;
  1556. }
  1557. export type ListPackageVersionsMaxResults = number;
  1558. export interface ListPackageVersionsRequest {
  1559. /**
  1560. * The name of the domain that contains the repository that contains the requested package versions.
  1561. */
  1562. domain: DomainName;
  1563. /**
  1564. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1565. */
  1566. domainOwner?: AccountId;
  1567. /**
  1568. * The name of the repository that contains the requested package versions.
  1569. */
  1570. repository: RepositoryName;
  1571. /**
  1572. * The format of the package versions you want to list.
  1573. */
  1574. format: PackageFormat;
  1575. /**
  1576. * The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example: The namespace is required when deleting package versions of the following formats: Maven Swift generic The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1577. */
  1578. namespace?: PackageNamespace;
  1579. /**
  1580. * The name of the package for which you want to request package versions.
  1581. */
  1582. package: PackageName;
  1583. /**
  1584. * A string that filters the requested package versions by status.
  1585. */
  1586. status?: PackageVersionStatus;
  1587. /**
  1588. * How to sort the requested list of package versions.
  1589. */
  1590. sortBy?: PackageVersionSortType;
  1591. /**
  1592. * The maximum number of results to return per page.
  1593. */
  1594. maxResults?: ListPackageVersionsMaxResults;
  1595. /**
  1596. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1597. */
  1598. nextToken?: PaginationToken;
  1599. /**
  1600. * The originType used to filter package versions. Only package versions with the provided originType will be returned.
  1601. */
  1602. originType?: PackageVersionOriginType;
  1603. }
  1604. export interface ListPackageVersionsResult {
  1605. /**
  1606. * The default package version to display. This depends on the package format: For Maven and PyPI packages, it's the most recently published package version. For npm packages, it's the version referenced by the latest tag. If the latest tag is not set, it's the most recently published package version.
  1607. */
  1608. defaultDisplayVersion?: PackageVersion;
  1609. /**
  1610. * A format of the package.
  1611. */
  1612. format?: PackageFormat;
  1613. /**
  1614. * The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1615. */
  1616. namespace?: PackageNamespace;
  1617. /**
  1618. * The name of the package.
  1619. */
  1620. package?: PackageName;
  1621. /**
  1622. * The returned list of PackageVersionSummary objects.
  1623. */
  1624. versions?: PackageVersionSummaryList;
  1625. /**
  1626. * If there are additional results, this is the token for the next set of results.
  1627. */
  1628. nextToken?: PaginationToken;
  1629. }
  1630. export type ListPackagesMaxResults = number;
  1631. export interface ListPackagesRequest {
  1632. /**
  1633. * The name of the domain that contains the repository that contains the requested packages.
  1634. */
  1635. domain: DomainName;
  1636. /**
  1637. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1638. */
  1639. domainOwner?: AccountId;
  1640. /**
  1641. * The name of the repository that contains the requested packages.
  1642. */
  1643. repository: RepositoryName;
  1644. /**
  1645. * The format used to filter requested packages. Only packages from the provided format will be returned.
  1646. */
  1647. format?: PackageFormat;
  1648. /**
  1649. * The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior. Each package format uses namespace as follows: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1650. */
  1651. namespace?: PackageNamespace;
  1652. /**
  1653. * A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.
  1654. */
  1655. packagePrefix?: PackageName;
  1656. /**
  1657. * The maximum number of results to return per page.
  1658. */
  1659. maxResults?: ListPackagesMaxResults;
  1660. /**
  1661. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1662. */
  1663. nextToken?: PaginationToken;
  1664. /**
  1665. * The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
  1666. */
  1667. publish?: AllowPublish;
  1668. /**
  1669. * The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
  1670. */
  1671. upstream?: AllowUpstream;
  1672. }
  1673. export interface ListPackagesResult {
  1674. /**
  1675. * The list of returned PackageSummary objects.
  1676. */
  1677. packages?: PackageSummaryList;
  1678. /**
  1679. * If there are additional results, this is the token for the next set of results.
  1680. */
  1681. nextToken?: PaginationToken;
  1682. }
  1683. export type ListRepositoriesInDomainMaxResults = number;
  1684. export interface ListRepositoriesInDomainRequest {
  1685. /**
  1686. * The name of the domain that contains the returned list of repositories.
  1687. */
  1688. domain: DomainName;
  1689. /**
  1690. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1691. */
  1692. domainOwner?: AccountId;
  1693. /**
  1694. * Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID.
  1695. */
  1696. administratorAccount?: AccountId;
  1697. /**
  1698. * A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.
  1699. */
  1700. repositoryPrefix?: RepositoryName;
  1701. /**
  1702. * The maximum number of results to return per page.
  1703. */
  1704. maxResults?: ListRepositoriesInDomainMaxResults;
  1705. /**
  1706. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1707. */
  1708. nextToken?: PaginationToken;
  1709. }
  1710. export interface ListRepositoriesInDomainResult {
  1711. /**
  1712. * The returned list of repositories.
  1713. */
  1714. repositories?: RepositorySummaryList;
  1715. /**
  1716. * If there are additional results, this is the token for the next set of results.
  1717. */
  1718. nextToken?: PaginationToken;
  1719. }
  1720. export type ListRepositoriesMaxResults = number;
  1721. export interface ListRepositoriesRequest {
  1722. /**
  1723. * A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.
  1724. */
  1725. repositoryPrefix?: RepositoryName;
  1726. /**
  1727. * The maximum number of results to return per page.
  1728. */
  1729. maxResults?: ListRepositoriesMaxResults;
  1730. /**
  1731. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1732. */
  1733. nextToken?: PaginationToken;
  1734. }
  1735. export interface ListRepositoriesResult {
  1736. /**
  1737. * The returned list of RepositorySummary objects.
  1738. */
  1739. repositories?: RepositorySummaryList;
  1740. /**
  1741. * If there are additional results, this is the token for the next set of results.
  1742. */
  1743. nextToken?: PaginationToken;
  1744. }
  1745. export interface ListSubPackageGroupsRequest {
  1746. /**
  1747. * The name of the domain which contains the package group from which to list sub package groups.
  1748. */
  1749. domain: DomainName;
  1750. /**
  1751. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1752. */
  1753. domainOwner?: AccountId;
  1754. /**
  1755. * The pattern of the package group from which to list sub package groups.
  1756. */
  1757. packageGroup: PackageGroupPattern;
  1758. /**
  1759. * The maximum number of results to return per page.
  1760. */
  1761. maxResults?: ListPackageGroupsMaxResults;
  1762. /**
  1763. * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  1764. */
  1765. nextToken?: PaginationToken;
  1766. }
  1767. export interface ListSubPackageGroupsResult {
  1768. /**
  1769. * A list of sub package groups for the requested package group.
  1770. */
  1771. packageGroups?: PackageGroupSummaryList;
  1772. /**
  1773. * If there are additional results, this is the token for the next set of results.
  1774. */
  1775. nextToken?: PaginationToken;
  1776. }
  1777. export interface ListTagsForResourceRequest {
  1778. /**
  1779. * The Amazon Resource Name (ARN) of the resource to get tags for.
  1780. */
  1781. resourceArn: Arn;
  1782. }
  1783. export interface ListTagsForResourceResult {
  1784. /**
  1785. * A list of tag key and value pairs associated with the specified resource.
  1786. */
  1787. tags?: TagList;
  1788. }
  1789. export type Long = number;
  1790. export type LongOptional = number;
  1791. export type OriginRestrictions = {[key: string]: PackageGroupOriginRestrictionMode};
  1792. export interface PackageDependency {
  1793. /**
  1794. * The namespace of the package that this package depends on. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1795. */
  1796. namespace?: PackageNamespace;
  1797. /**
  1798. * The name of the package that this package depends on.
  1799. */
  1800. package?: PackageName;
  1801. /**
  1802. * The type of a package dependency. The possible values depend on the package type. npm: regular, dev, peer, optional maven: optional, parent, compile, runtime, test, system, provided. Note that parent is not a regular Maven dependency type; instead this is extracted from the &lt;parent&gt; element if one is defined in the package version's POM file. nuget: The dependencyType field is never set for NuGet packages. pypi: Requires-Dist
  1803. */
  1804. dependencyType?: String;
  1805. /**
  1806. * The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.
  1807. */
  1808. versionRequirement?: String;
  1809. }
  1810. export type PackageDependencyList = PackageDependency[];
  1811. export interface PackageDescription {
  1812. /**
  1813. * A format that specifies the type of the package.
  1814. */
  1815. format?: PackageFormat;
  1816. /**
  1817. * The namespace of the package. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1818. */
  1819. namespace?: PackageNamespace;
  1820. /**
  1821. * The name of the package.
  1822. */
  1823. name?: PackageName;
  1824. /**
  1825. * The package origin configuration for the package.
  1826. */
  1827. originConfiguration?: PackageOriginConfiguration;
  1828. }
  1829. export type PackageFormat = "npm"|"pypi"|"maven"|"nuget"|"generic"|"ruby"|"swift"|string;
  1830. export interface PackageGroupAllowedRepository {
  1831. /**
  1832. * The name of the allowed repository.
  1833. */
  1834. repositoryName?: RepositoryName;
  1835. /**
  1836. * The origin configuration restriction type of the allowed repository.
  1837. */
  1838. originRestrictionType?: PackageGroupOriginRestrictionType;
  1839. }
  1840. export type PackageGroupAllowedRepositoryList = PackageGroupAllowedRepository[];
  1841. export type PackageGroupAllowedRepositoryUpdate = {[key: string]: RepositoryNameList};
  1842. export type PackageGroupAllowedRepositoryUpdateType = "ADDED"|"REMOVED"|string;
  1843. export type PackageGroupAllowedRepositoryUpdates = {[key: string]: PackageGroupAllowedRepositoryUpdate};
  1844. export type PackageGroupAssociationType = "STRONG"|"WEAK"|string;
  1845. export type PackageGroupContactInfo = string;
  1846. export interface PackageGroupDescription {
  1847. /**
  1848. * The ARN of the package group.
  1849. */
  1850. arn?: Arn;
  1851. /**
  1852. * The pattern of the package group. The pattern determines which packages are associated with the package group.
  1853. */
  1854. pattern?: PackageGroupPattern;
  1855. /**
  1856. * The name of the domain that contains the package group.
  1857. */
  1858. domainName?: DomainName;
  1859. /**
  1860. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1861. */
  1862. domainOwner?: AccountId;
  1863. /**
  1864. * A timestamp that represents the date and time the package group was created.
  1865. */
  1866. createdTime?: Timestamp;
  1867. /**
  1868. * The contact information of the package group.
  1869. */
  1870. contactInfo?: PackageGroupContactInfo;
  1871. /**
  1872. * The description of the package group.
  1873. */
  1874. description?: Description;
  1875. /**
  1876. * The package group origin configuration that determines how package versions can enter repositories.
  1877. */
  1878. originConfiguration?: PackageGroupOriginConfiguration;
  1879. /**
  1880. * The direct parent package group of the package group.
  1881. */
  1882. parent?: PackageGroupReference;
  1883. }
  1884. export interface PackageGroupOriginConfiguration {
  1885. /**
  1886. * The origin configuration settings that determine how package versions can enter repositories.
  1887. */
  1888. restrictions?: PackageGroupOriginRestrictions;
  1889. }
  1890. export interface PackageGroupOriginRestriction {
  1891. /**
  1892. * The package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.
  1893. */
  1894. mode?: PackageGroupOriginRestrictionMode;
  1895. /**
  1896. * The effective package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value of mode is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.
  1897. */
  1898. effectiveMode?: PackageGroupOriginRestrictionMode;
  1899. /**
  1900. * The parent package group that the package group origin restrictions are inherited from.
  1901. */
  1902. inheritedFrom?: PackageGroupReference;
  1903. /**
  1904. * The number of repositories in the allowed repository list.
  1905. */
  1906. repositoriesCount?: LongOptional;
  1907. }
  1908. export type PackageGroupOriginRestrictionMode = "ALLOW"|"ALLOW_SPECIFIC_REPOSITORIES"|"BLOCK"|"INHERIT"|string;
  1909. export type PackageGroupOriginRestrictionType = "EXTERNAL_UPSTREAM"|"INTERNAL_UPSTREAM"|"PUBLISH"|string;
  1910. export type PackageGroupOriginRestrictions = {[key: string]: PackageGroupOriginRestriction};
  1911. export type PackageGroupPattern = string;
  1912. export type PackageGroupPatternPrefix = string;
  1913. export interface PackageGroupReference {
  1914. /**
  1915. * The ARN of the package group.
  1916. */
  1917. arn?: Arn;
  1918. /**
  1919. * The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.
  1920. */
  1921. pattern?: PackageGroupPattern;
  1922. }
  1923. export interface PackageGroupSummary {
  1924. /**
  1925. * The ARN of the package group.
  1926. */
  1927. arn?: Arn;
  1928. /**
  1929. * The pattern of the package group. The pattern determines which packages are associated with the package group.
  1930. */
  1931. pattern?: PackageGroupPattern;
  1932. /**
  1933. * The domain that contains the package group.
  1934. */
  1935. domainName?: DomainName;
  1936. /**
  1937. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  1938. */
  1939. domainOwner?: AccountId;
  1940. /**
  1941. * A timestamp that represents the date and time the repository was created.
  1942. */
  1943. createdTime?: Timestamp;
  1944. /**
  1945. * The contact information of the package group.
  1946. */
  1947. contactInfo?: PackageGroupContactInfo;
  1948. /**
  1949. * The description of the package group.
  1950. */
  1951. description?: Description;
  1952. /**
  1953. * Details about the package origin configuration of a package group.
  1954. */
  1955. originConfiguration?: PackageGroupOriginConfiguration;
  1956. /**
  1957. * The direct parent package group of the package group.
  1958. */
  1959. parent?: PackageGroupReference;
  1960. }
  1961. export type PackageGroupSummaryList = PackageGroupSummary[];
  1962. export type PackageName = string;
  1963. export type PackageNamespace = string;
  1964. export interface PackageOriginConfiguration {
  1965. /**
  1966. * A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.
  1967. */
  1968. restrictions?: PackageOriginRestrictions;
  1969. }
  1970. export interface PackageOriginRestrictions {
  1971. /**
  1972. * The package origin configuration that determines if new versions of the package can be published directly to the repository.
  1973. */
  1974. publish: AllowPublish;
  1975. /**
  1976. * The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.
  1977. */
  1978. upstream: AllowUpstream;
  1979. }
  1980. export interface PackageSummary {
  1981. /**
  1982. * The format of the package.
  1983. */
  1984. format?: PackageFormat;
  1985. /**
  1986. * The namespace of the package. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  1987. */
  1988. namespace?: PackageNamespace;
  1989. /**
  1990. * The name of the package.
  1991. */
  1992. package?: PackageName;
  1993. /**
  1994. * A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.
  1995. */
  1996. originConfiguration?: PackageOriginConfiguration;
  1997. }
  1998. export type PackageSummaryList = PackageSummary[];
  1999. export type PackageVersion = string;
  2000. export interface PackageVersionDescription {
  2001. /**
  2002. * The format of the package version.
  2003. */
  2004. format?: PackageFormat;
  2005. /**
  2006. * The namespace of the package version. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  2007. */
  2008. namespace?: PackageNamespace;
  2009. /**
  2010. * The name of the requested package.
  2011. */
  2012. packageName?: PackageName;
  2013. /**
  2014. * The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.
  2015. */
  2016. displayName?: String255;
  2017. /**
  2018. * The version of the package.
  2019. */
  2020. version?: PackageVersion;
  2021. /**
  2022. * A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.
  2023. */
  2024. summary?: String;
  2025. /**
  2026. * The homepage associated with the package.
  2027. */
  2028. homePage?: String;
  2029. /**
  2030. * The repository for the source code in the package version, or the source code used to build it.
  2031. */
  2032. sourceCodeRepository?: String;
  2033. /**
  2034. * A timestamp that contains the date and time the package version was published.
  2035. */
  2036. publishedTime?: Timestamp;
  2037. /**
  2038. * Information about licenses associated with the package version.
  2039. */
  2040. licenses?: LicenseInfoList;
  2041. /**
  2042. * The revision of the package version.
  2043. */
  2044. revision?: PackageVersionRevision;
  2045. /**
  2046. * A string that contains the status of the package version.
  2047. */
  2048. status?: PackageVersionStatus;
  2049. /**
  2050. * A PackageVersionOrigin object that contains information about how the package version was added to the repository.
  2051. */
  2052. origin?: PackageVersionOrigin;
  2053. }
  2054. export interface PackageVersionError {
  2055. /**
  2056. * The error code associated with the error. Valid error codes are: ALREADY_EXISTS MISMATCHED_REVISION MISMATCHED_STATUS NOT_ALLOWED NOT_FOUND SKIPPED
  2057. */
  2058. errorCode?: PackageVersionErrorCode;
  2059. /**
  2060. * The error message associated with the error.
  2061. */
  2062. errorMessage?: ErrorMessage;
  2063. }
  2064. export type PackageVersionErrorCode = "ALREADY_EXISTS"|"MISMATCHED_REVISION"|"MISMATCHED_STATUS"|"NOT_ALLOWED"|"NOT_FOUND"|"SKIPPED"|string;
  2065. export type PackageVersionErrorMap = {[key: string]: PackageVersionError};
  2066. export type PackageVersionList = PackageVersion[];
  2067. export interface PackageVersionOrigin {
  2068. /**
  2069. * A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.
  2070. */
  2071. domainEntryPoint?: DomainEntryPoint;
  2072. /**
  2073. * Describes how the package version was originally added to the domain. An INTERNAL origin type means the package version was published directly to a repository in the domain. An EXTERNAL origin type means the package version was ingested from an external connection.
  2074. */
  2075. originType?: PackageVersionOriginType;
  2076. }
  2077. export type PackageVersionOriginType = "INTERNAL"|"EXTERNAL"|"UNKNOWN"|string;
  2078. export type PackageVersionRevision = string;
  2079. export type PackageVersionRevisionMap = {[key: string]: PackageVersionRevision};
  2080. export type PackageVersionSortType = "PUBLISHED_TIME"|string;
  2081. export type PackageVersionStatus = "Published"|"Unfinished"|"Unlisted"|"Archived"|"Disposed"|"Deleted"|string;
  2082. export interface PackageVersionSummary {
  2083. /**
  2084. * Information about a package version.
  2085. */
  2086. version: PackageVersion;
  2087. /**
  2088. * The revision associated with a package version.
  2089. */
  2090. revision?: PackageVersionRevision;
  2091. /**
  2092. * A string that contains the status of the package version. It can be one of the following:
  2093. */
  2094. status: PackageVersionStatus;
  2095. /**
  2096. * A PackageVersionOrigin object that contains information about how the package version was added to the repository.
  2097. */
  2098. origin?: PackageVersionOrigin;
  2099. }
  2100. export type PackageVersionSummaryList = PackageVersionSummary[];
  2101. export type PaginationToken = string;
  2102. export type PolicyDocument = string;
  2103. export type PolicyRevision = string;
  2104. export interface PublishPackageVersionRequest {
  2105. /**
  2106. * The name of the domain that contains the repository that contains the package version to publish.
  2107. */
  2108. domain: DomainName;
  2109. /**
  2110. * The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
  2111. */
  2112. domainOwner?: AccountId;
  2113. /**
  2114. * The name of the repository that the package version will be published to.
  2115. */
  2116. repository: RepositoryName;
  2117. /**
  2118. * A format that specifies the type of the package version with the requested asset file. The only supported value is generic.
  2119. */
  2120. format: PackageFormat;
  2121. /**
  2122. * The namespace of the package version to publish.
  2123. */
  2124. namespace?: PackageNamespace;
  2125. /**
  2126. * The name of the package version to publish.
  2127. */
  2128. package: PackageName;
  2129. /**
  2130. * The package version to publish (for example, 3.5.2).
  2131. */
  2132. packageVersion: PackageVersion;
  2133. /**
  2134. * The content of the asset to publish.
  2135. */
  2136. assetContent: Asset;
  2137. /**
  2138. * The name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special characters: ~ ! @ ^ &amp; ( ) - ` _ + [ ] { } ; , . `
  2139. */
  2140. assetName: AssetName;
  2141. /**
  2142. * The SHA256 hash of the assetContent to publish. This value must be calculated by the caller and provided with the request (see Publishing a generic package in the CodeArtifact User Guide). This value is used as an integrity check to verify that the assetContent has not changed after it was originally sent.
  2143. */
  2144. assetSHA256: SHA256;
  2145. /**
  2146. * Specifies whether the package version should remain in the unfinished state. If omitted, the package version status will be set to Published (see Package version status in the CodeArtifact User Guide). Valid values: unfinished
  2147. */
  2148. unfinished?: BooleanOptional;
  2149. }
  2150. export interface PublishPackageVersionResult {
  2151. /**
  2152. * The format of the package version.
  2153. */
  2154. format?: PackageFormat;
  2155. /**
  2156. * The namespace of the package version.
  2157. */
  2158. namespace?: PackageNamespace;
  2159. /**
  2160. * The name of the package.
  2161. */
  2162. package?: PackageName;
  2163. /**
  2164. * The version of the package.
  2165. */
  2166. version?: PackageVersion;
  2167. /**
  2168. * The revision of the package version.
  2169. */
  2170. versionRevision?: PackageVersionRevision;
  2171. /**
  2172. * A string that contains the status of the package version. For more information, see Package version status in the CodeArtifact User Guide.
  2173. */
  2174. status?: PackageVersionStatus;
  2175. /**
  2176. * An AssetSummary for the published asset.
  2177. */
  2178. asset?: AssetSummary;
  2179. }
  2180. export interface PutDomainPermissionsPolicyRequest {
  2181. /**
  2182. * The name of the domain on which to set the resource policy.
  2183. */
  2184. domain: DomainName;
  2185. /**
  2186. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  2187. */
  2188. domainOwner?: AccountId;
  2189. /**
  2190. * The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
  2191. */
  2192. policyRevision?: PolicyRevision;
  2193. /**
  2194. * A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.
  2195. */
  2196. policyDocument: PolicyDocument;
  2197. }
  2198. export interface PutDomainPermissionsPolicyResult {
  2199. /**
  2200. * The resource policy that was set after processing the request.
  2201. */
  2202. policy?: ResourcePolicy;
  2203. }
  2204. export interface PutPackageOriginConfigurationRequest {
  2205. /**
  2206. * The name of the domain that contains the repository that contains the package.
  2207. */
  2208. domain: DomainName;
  2209. /**
  2210. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  2211. */
  2212. domainOwner?: AccountId;
  2213. /**
  2214. * The name of the repository that contains the package.
  2215. */
  2216. repository: RepositoryName;
  2217. /**
  2218. * A format that specifies the type of the package to be updated.
  2219. */
  2220. format: PackageFormat;
  2221. /**
  2222. * The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  2223. */
  2224. namespace?: PackageNamespace;
  2225. /**
  2226. * The name of the package to be updated.
  2227. */
  2228. package: PackageName;
  2229. /**
  2230. * A PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions. The upstream restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. The publish restriction determines if new package versions can be published directly to the repository. You must include both the desired upstream and publish restrictions.
  2231. */
  2232. restrictions: PackageOriginRestrictions;
  2233. }
  2234. export interface PutPackageOriginConfigurationResult {
  2235. /**
  2236. * A PackageOriginConfiguration object that describes the origin configuration set for the package. It contains a PackageOriginRestrictions object that describes how new versions of the package can be introduced to the repository.
  2237. */
  2238. originConfiguration?: PackageOriginConfiguration;
  2239. }
  2240. export interface PutRepositoryPermissionsPolicyRequest {
  2241. /**
  2242. * The name of the domain containing the repository to set the resource policy on.
  2243. */
  2244. domain: DomainName;
  2245. /**
  2246. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  2247. */
  2248. domainOwner?: AccountId;
  2249. /**
  2250. * The name of the repository to set the resource policy on.
  2251. */
  2252. repository: RepositoryName;
  2253. /**
  2254. * Sets the revision of the resource policy that specifies permissions to access the repository. This revision is used for optimistic locking, which prevents others from overwriting your changes to the repository's resource policy.
  2255. */
  2256. policyRevision?: PolicyRevision;
  2257. /**
  2258. * A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.
  2259. */
  2260. policyDocument: PolicyDocument;
  2261. }
  2262. export interface PutRepositoryPermissionsPolicyResult {
  2263. /**
  2264. * The resource policy that was set after processing the request.
  2265. */
  2266. policy?: ResourcePolicy;
  2267. }
  2268. export interface RepositoryDescription {
  2269. /**
  2270. * The name of the repository.
  2271. */
  2272. name?: RepositoryName;
  2273. /**
  2274. * The 12-digit account number of the Amazon Web Services account that manages the repository.
  2275. */
  2276. administratorAccount?: AccountId;
  2277. /**
  2278. * The name of the domain that contains the repository.
  2279. */
  2280. domainName?: DomainName;
  2281. /**
  2282. * The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.
  2283. */
  2284. domainOwner?: AccountId;
  2285. /**
  2286. * The Amazon Resource Name (ARN) of the repository.
  2287. */
  2288. arn?: Arn;
  2289. /**
  2290. * A text description of the repository.
  2291. */
  2292. description?: Description;
  2293. /**
  2294. * A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.
  2295. */
  2296. upstreams?: UpstreamRepositoryInfoList;
  2297. /**
  2298. * An array of external connections associated with the repository.
  2299. */
  2300. externalConnections?: RepositoryExternalConnectionInfoList;
  2301. /**
  2302. * A timestamp that represents the date and time the repository was created.
  2303. */
  2304. createdTime?: Timestamp;
  2305. }
  2306. export interface RepositoryExternalConnectionInfo {
  2307. /**
  2308. * The name of the external connection associated with a repository.
  2309. */
  2310. externalConnectionName?: ExternalConnectionName;
  2311. /**
  2312. * The package format associated with a repository's external connection. The valid package formats are: npm: A Node Package Manager (npm) package. pypi: A Python Package Index (PyPI) package. maven: A Maven package that contains compiled code in a distributable format, such as a JAR file. nuget: A NuGet package.
  2313. */
  2314. packageFormat?: PackageFormat;
  2315. /**
  2316. * The status of the external connection of a repository. There is one valid value, Available.
  2317. */
  2318. status?: ExternalConnectionStatus;
  2319. }
  2320. export type RepositoryExternalConnectionInfoList = RepositoryExternalConnectionInfo[];
  2321. export type RepositoryName = string;
  2322. export type RepositoryNameList = RepositoryName[];
  2323. export interface RepositorySummary {
  2324. /**
  2325. * The name of the repository.
  2326. */
  2327. name?: RepositoryName;
  2328. /**
  2329. * The Amazon Web Services account ID that manages the repository.
  2330. */
  2331. administratorAccount?: AccountId;
  2332. /**
  2333. * The name of the domain that contains the repository.
  2334. */
  2335. domainName?: DomainName;
  2336. /**
  2337. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  2338. */
  2339. domainOwner?: AccountId;
  2340. /**
  2341. * The ARN of the repository.
  2342. */
  2343. arn?: Arn;
  2344. /**
  2345. * The description of the repository.
  2346. */
  2347. description?: Description;
  2348. /**
  2349. * A timestamp that represents the date and time the repository was created.
  2350. */
  2351. createdTime?: Timestamp;
  2352. }
  2353. export type RepositorySummaryList = RepositorySummary[];
  2354. export interface ResourcePolicy {
  2355. /**
  2356. * The ARN of the resource associated with the resource policy
  2357. */
  2358. resourceArn?: Arn;
  2359. /**
  2360. * The current revision of the resource policy.
  2361. */
  2362. revision?: PolicyRevision;
  2363. /**
  2364. * The resource policy formatted in JSON.
  2365. */
  2366. document?: PolicyDocument;
  2367. }
  2368. export type SHA256 = string;
  2369. export type String = string;
  2370. export type String255 = string;
  2371. export interface SuccessfulPackageVersionInfo {
  2372. /**
  2373. * The revision of a package version.
  2374. */
  2375. revision?: String;
  2376. /**
  2377. * The status of a package version.
  2378. */
  2379. status?: PackageVersionStatus;
  2380. }
  2381. export type SuccessfulPackageVersionInfoMap = {[key: string]: SuccessfulPackageVersionInfo};
  2382. export interface Tag {
  2383. /**
  2384. * The tag key.
  2385. */
  2386. key: TagKey;
  2387. /**
  2388. * The tag value.
  2389. */
  2390. value: TagValue;
  2391. }
  2392. export type TagKey = string;
  2393. export type TagKeyList = TagKey[];
  2394. export type TagList = Tag[];
  2395. export interface TagResourceRequest {
  2396. /**
  2397. * The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.
  2398. */
  2399. resourceArn: Arn;
  2400. /**
  2401. * The tags you want to modify or add to the resource.
  2402. */
  2403. tags: TagList;
  2404. }
  2405. export interface TagResourceResult {
  2406. }
  2407. export type TagValue = string;
  2408. export type Timestamp = Date;
  2409. export interface UntagResourceRequest {
  2410. /**
  2411. * The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
  2412. */
  2413. resourceArn: Arn;
  2414. /**
  2415. * The tag key for each tag that you want to remove from the resource.
  2416. */
  2417. tagKeys: TagKeyList;
  2418. }
  2419. export interface UntagResourceResult {
  2420. }
  2421. export interface UpdatePackageGroupOriginConfigurationRequest {
  2422. /**
  2423. * The name of the domain which contains the package group for which to update the origin configuration.
  2424. */
  2425. domain: DomainName;
  2426. /**
  2427. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  2428. */
  2429. domainOwner?: AccountId;
  2430. /**
  2431. * The pattern of the package group for which to update the origin configuration.
  2432. */
  2433. packageGroup: PackageGroupPattern;
  2434. /**
  2435. * The origin configuration settings that determine how package versions can enter repositories.
  2436. */
  2437. restrictions?: OriginRestrictions;
  2438. /**
  2439. * The repository name and restrictions to add to the allowed repository list of the specified package group.
  2440. */
  2441. addAllowedRepositories?: PackageGroupAllowedRepositoryList;
  2442. /**
  2443. * The repository name and restrictions to remove from the allowed repository list of the specified package group.
  2444. */
  2445. removeAllowedRepositories?: PackageGroupAllowedRepositoryList;
  2446. }
  2447. export interface UpdatePackageGroupOriginConfigurationResult {
  2448. /**
  2449. * The package group and information about it after processing the request.
  2450. */
  2451. packageGroup?: PackageGroupDescription;
  2452. /**
  2453. * Information about the updated allowed repositories after processing the request.
  2454. */
  2455. allowedRepositoryUpdates?: PackageGroupAllowedRepositoryUpdates;
  2456. }
  2457. export interface UpdatePackageGroupRequest {
  2458. /**
  2459. * The name of the domain which contains the package group to be updated.
  2460. */
  2461. domain: DomainName;
  2462. /**
  2463. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  2464. */
  2465. domainOwner?: AccountId;
  2466. /**
  2467. * The pattern of the package group to be updated.
  2468. */
  2469. packageGroup: PackageGroupPattern;
  2470. /**
  2471. * Contact information which you want to update the requested package group with.
  2472. */
  2473. contactInfo?: PackageGroupContactInfo;
  2474. /**
  2475. * The description you want to update the requested package group with.
  2476. */
  2477. description?: Description;
  2478. }
  2479. export interface UpdatePackageGroupResult {
  2480. /**
  2481. * The package group and information about it after the request has been processed.
  2482. */
  2483. packageGroup?: PackageGroupDescription;
  2484. }
  2485. export interface UpdatePackageVersionsStatusRequest {
  2486. /**
  2487. * The name of the domain that contains the repository that contains the package versions with a status to be updated.
  2488. */
  2489. domain: DomainName;
  2490. /**
  2491. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  2492. */
  2493. domainOwner?: AccountId;
  2494. /**
  2495. * The repository that contains the package versions with the status you want to update.
  2496. */
  2497. repository: RepositoryName;
  2498. /**
  2499. * A format that specifies the type of the package with the statuses to update.
  2500. */
  2501. format: PackageFormat;
  2502. /**
  2503. * The namespace of the package version to be updated. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm or Swift package version is its scope. The namespace of a generic package is its namespace. Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  2504. */
  2505. namespace?: PackageNamespace;
  2506. /**
  2507. * The name of the package with the version statuses to update.
  2508. */
  2509. package: PackageName;
  2510. /**
  2511. * An array of strings that specify the versions of the package with the statuses to update.
  2512. */
  2513. versions: PackageVersionList;
  2514. /**
  2515. * A map of package versions and package version revisions. The map key is the package version (for example, 3.5.2), and the map value is the package version revision.
  2516. */
  2517. versionRevisions?: PackageVersionRevisionMap;
  2518. /**
  2519. * The package version’s expected status before it is updated. If expectedStatus is provided, the package version's status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.
  2520. */
  2521. expectedStatus?: PackageVersionStatus;
  2522. /**
  2523. * The status you want to change the package version status to.
  2524. */
  2525. targetStatus: PackageVersionStatus;
  2526. }
  2527. export interface UpdatePackageVersionsStatusResult {
  2528. /**
  2529. * A list of PackageVersionError objects, one for each package version with a status that failed to update.
  2530. */
  2531. successfulVersions?: SuccessfulPackageVersionInfoMap;
  2532. /**
  2533. * A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated.
  2534. */
  2535. failedVersions?: PackageVersionErrorMap;
  2536. }
  2537. export interface UpdateRepositoryRequest {
  2538. /**
  2539. * The name of the domain associated with the repository to update.
  2540. */
  2541. domain: DomainName;
  2542. /**
  2543. * The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  2544. */
  2545. domainOwner?: AccountId;
  2546. /**
  2547. * The name of the repository to update.
  2548. */
  2549. repository: RepositoryName;
  2550. /**
  2551. * An updated repository description.
  2552. */
  2553. description?: Description;
  2554. /**
  2555. * A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.
  2556. */
  2557. upstreams?: UpstreamRepositoryList;
  2558. }
  2559. export interface UpdateRepositoryResult {
  2560. /**
  2561. * The updated repository.
  2562. */
  2563. repository?: RepositoryDescription;
  2564. }
  2565. export interface UpstreamRepository {
  2566. /**
  2567. * The name of an upstream repository.
  2568. */
  2569. repositoryName: RepositoryName;
  2570. }
  2571. export interface UpstreamRepositoryInfo {
  2572. /**
  2573. * The name of an upstream repository.
  2574. */
  2575. repositoryName?: RepositoryName;
  2576. }
  2577. export type UpstreamRepositoryInfoList = UpstreamRepositoryInfo[];
  2578. export type UpstreamRepositoryList = UpstreamRepository[];
  2579. /**
  2580. * 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.
  2581. */
  2582. export type apiVersion = "2018-09-22"|"latest"|string;
  2583. export interface ClientApiVersions {
  2584. /**
  2585. * 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.
  2586. */
  2587. apiVersion?: apiVersion;
  2588. }
  2589. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  2590. /**
  2591. * Contains interfaces for use with the CodeArtifact client.
  2592. */
  2593. export import Types = CodeArtifact;
  2594. }
  2595. export = CodeArtifact;