|
123 | 123 | ],
|
124 | 124 | "documentation":"<p> Deletes the resource policy set on a domain. </p>"
|
125 | 125 | },
|
| 126 | + "DeletePackage":{ |
| 127 | + "name":"DeletePackage", |
| 128 | + "http":{ |
| 129 | + "method":"DELETE", |
| 130 | + "requestUri":"/v1/package" |
| 131 | + }, |
| 132 | + "input":{"shape":"DeletePackageRequest"}, |
| 133 | + "output":{"shape":"DeletePackageResult"}, |
| 134 | + "errors":[ |
| 135 | + {"shape":"AccessDeniedException"}, |
| 136 | + {"shape":"ConflictException"}, |
| 137 | + {"shape":"InternalServerException"}, |
| 138 | + {"shape":"ResourceNotFoundException"}, |
| 139 | + {"shape":"ThrottlingException"}, |
| 140 | + {"shape":"ValidationException"} |
| 141 | + ], |
| 142 | + "documentation":"<p>Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeletePackageVersions.html\">DeletePackageVersions</a> API.</p>" |
| 143 | + }, |
126 | 144 | "DeletePackageVersions":{
|
127 | 145 | "name":"DeletePackageVersions",
|
128 | 146 | "http":{
|
|
139 | 157 | {"shape":"ThrottlingException"},
|
140 | 158 | {"shape":"ValidationException"}
|
141 | 159 | ],
|
142 |
| - "documentation":"<p> 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 <code>Archived</code>. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html\">ListPackageVersions</a>), but you can restore them using <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html\">UpdatePackageVersionsStatus</a>. </p>" |
| 160 | + "documentation":"<p> 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 <code>Archived</code>. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html\">ListackageVersions</a>), but you can restore them using <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html\">UpdatePackageVersionsStatus</a>. </p>" |
143 | 161 | },
|
144 | 162 | "DeleteRepository":{
|
145 | 163 | "name":"DeleteRepository",
|
|
451 | 469 | {"shape":"ThrottlingException"},
|
452 | 470 | {"shape":"ValidationException"}
|
453 | 471 | ],
|
454 |
| - "documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html\">PackageVersionSummary</a> objects for package versions in a repository that match the request parameters. </p>" |
| 472 | + "documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html\">PackageVersionSummary</a> objects for package versions in a repository that match the request parameters. Package versions of all statuses will be returned by default when calling <code>list-package-versions</code> with no <code>--status</code> parameter. </p>" |
455 | 473 | },
|
456 | 474 | "ListPackages":{
|
457 | 475 | "name":"ListPackages",
|
|
1007 | 1025 | }
|
1008 | 1026 | }
|
1009 | 1027 | },
|
| 1028 | + "DeletePackageRequest":{ |
| 1029 | + "type":"structure", |
| 1030 | + "required":[ |
| 1031 | + "domain", |
| 1032 | + "repository", |
| 1033 | + "format", |
| 1034 | + "package" |
| 1035 | + ], |
| 1036 | + "members":{ |
| 1037 | + "domain":{ |
| 1038 | + "shape":"DomainName", |
| 1039 | + "documentation":"<p>The name of the domain that contains the package to delete.</p>", |
| 1040 | + "location":"querystring", |
| 1041 | + "locationName":"domain" |
| 1042 | + }, |
| 1043 | + "domainOwner":{ |
| 1044 | + "shape":"AccountId", |
| 1045 | + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", |
| 1046 | + "location":"querystring", |
| 1047 | + "locationName":"domain-owner" |
| 1048 | + }, |
| 1049 | + "repository":{ |
| 1050 | + "shape":"RepositoryName", |
| 1051 | + "documentation":"<p>The name of the repository that contains the package to delete.</p>", |
| 1052 | + "location":"querystring", |
| 1053 | + "locationName":"repository" |
| 1054 | + }, |
| 1055 | + "format":{ |
| 1056 | + "shape":"PackageFormat", |
| 1057 | + "documentation":"<p>The format of the requested package to delete.</p>", |
| 1058 | + "location":"querystring", |
| 1059 | + "locationName":"format" |
| 1060 | + }, |
| 1061 | + "namespace":{ |
| 1062 | + "shape":"PackageNamespace", |
| 1063 | + "documentation":"<p>The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package is its <code>groupId</code>. The namespace is required when deleting Maven package versions. </p> </li> <li> <p> The namespace of an npm package is its <code>scope</code>. </p> </li> <li> <p> Python and NuGet packages do not contain corresponding components, packages of those formats do not have a namespace. </p> </li> </ul>", |
| 1064 | + "location":"querystring", |
| 1065 | + "locationName":"namespace" |
| 1066 | + }, |
| 1067 | + "package":{ |
| 1068 | + "shape":"PackageName", |
| 1069 | + "documentation":"<p>The name of the package to delete.</p>", |
| 1070 | + "location":"querystring", |
| 1071 | + "locationName":"package" |
| 1072 | + } |
| 1073 | + } |
| 1074 | + }, |
| 1075 | + "DeletePackageResult":{ |
| 1076 | + "type":"structure", |
| 1077 | + "members":{ |
| 1078 | + "deletedPackage":{"shape":"PackageSummary"} |
| 1079 | + } |
| 1080 | + }, |
1010 | 1081 | "DeletePackageVersionsRequest":{
|
1011 | 1082 | "type":"structure",
|
1012 | 1083 | "required":[
|
|
2313 | 2384 | },
|
2314 | 2385 | "namespace":{
|
2315 | 2386 | "shape":"PackageNamespace",
|
2316 |
| - "documentation":"<p>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 <code>--namespace</code> and not <code>--namespace-prefix</code>, it has prefix-matching behavior.</p> <p>Each package format uses namespace as follows:</p> <ul> <li> <p> The namespace of a Maven package is its <code>groupId</code>. </p> </li> <li> <p> The namespace of an npm package is its <code>scope</code>. </p> </li> <li> <p> Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace. </p> </li> </ul>", |
| 2387 | + "documentation":"<p>The namespace used to filter requested packages. Only packages with the provided namespace will be returned. The package component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package is its <code>groupId</code>. </p> </li> <li> <p> The namespace of an npm package is its <code>scope</code>. </p> </li> <li> <p> Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace. </p> </li> </ul>", |
2317 | 2388 | "location":"querystring",
|
2318 | 2389 | "locationName":"namespace"
|
2319 | 2390 | },
|
|
2499 | 2570 | },
|
2500 | 2571 | "dependencyType":{
|
2501 | 2572 | "shape":"String",
|
2502 |
| - "documentation":"<p> The type of a package dependency. The possible values depend on the package type.</p> <ul> <li> <p>npm: <code>regular</code>, <code>dev</code>, <code>peer</code>, <code>optional</code> </p> </li> <li> <p>maven: <code>optional</code>, <code>parent</code>, <code>compile</code>, <code>runtime</code>, <code>test</code>, <code>system</code>, <code>provided</code>.</p> <note> <p>Note that <code>parent</code> is not a regular Maven dependency type; instead this is extracted from the <code><parent></code> element if one is defined in the package version's POM file.</p> </note> </li> <li> <p>nuget: The <code>dependencyType</code> field is never set for NuGet packages.</p> </li> <li> <p>pypi: <code>Requires-Dist</code> </p> </li> </ul>" |
| 2573 | + "documentation":"<p> The type of a package dependency. The possible values depend on the package type. Example types are <code>compile</code>, <code>runtime</code>, and <code>test</code> for Maven packages, and <code>dev</code>, <code>prod</code>, and <code>optional</code> for npm packages. </p>" |
2503 | 2574 | },
|
2504 | 2575 | "versionRequirement":{
|
2505 | 2576 | "shape":"String",
|
|
2603 | 2674 | "documentation":"<p>A <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html\">PackageOriginConfiguration</a> object that contains a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html\">PackageOriginRestrictions</a> object that contains information about the upstream and publish package origin restrictions.</p>"
|
2604 | 2675 | }
|
2605 | 2676 | },
|
2606 |
| - "documentation":"<p> Details about a package, including its format, namespace, and name. The <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackages.html\">ListPackages</a> operation returns a list of <code>PackageSummary</code> objects. </p>" |
| 2677 | + "documentation":"<p> Details about a package, including its format, namespace, and name. </p>" |
2607 | 2678 | },
|
2608 | 2679 | "PackageSummaryList":{
|
2609 | 2680 | "type":"list",
|
|
0 commit comments