Skip to content

Commit 82936d0

Browse files
author
AWS
committed
CodeArtifact Update: This release introduces a new DeletePackage API, which enables deletion of a package and all of its versions from a repository.
1 parent 4d48efe commit 82936d0

File tree

2 files changed

+82
-5
lines changed

2 files changed

+82
-5
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "CodeArtifact",
4+
"contributor": "",
5+
"description": "This release introduces a new DeletePackage API, which enables deletion of a package and all of its versions from a repository."
6+
}

services/codeartifact/src/main/resources/codegen-resources/service-2.json

Lines changed: 76 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,24 @@
123123
],
124124
"documentation":"<p> Deletes the resource policy set on a domain. </p>"
125125
},
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+
},
126144
"DeletePackageVersions":{
127145
"name":"DeletePackageVersions",
128146
"http":{
@@ -139,7 +157,7 @@
139157
{"shape":"ThrottlingException"},
140158
{"shape":"ValidationException"}
141159
],
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>"
143161
},
144162
"DeleteRepository":{
145163
"name":"DeleteRepository",
@@ -451,7 +469,7 @@
451469
{"shape":"ThrottlingException"},
452470
{"shape":"ValidationException"}
453471
],
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>"
455473
},
456474
"ListPackages":{
457475
"name":"ListPackages",
@@ -1007,6 +1025,59 @@
10071025
}
10081026
}
10091027
},
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+
},
10101081
"DeletePackageVersionsRequest":{
10111082
"type":"structure",
10121083
"required":[
@@ -2313,7 +2384,7 @@
23132384
},
23142385
"namespace":{
23152386
"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>",
23172388
"location":"querystring",
23182389
"locationName":"namespace"
23192390
},
@@ -2499,7 +2570,7 @@
24992570
},
25002571
"dependencyType":{
25012572
"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>&lt;parent&gt;</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>"
25032574
},
25042575
"versionRequirement":{
25052576
"shape":"String",
@@ -2603,7 +2674,7 @@
26032674
"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>"
26042675
}
26052676
},
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>"
26072678
},
26082679
"PackageSummaryList":{
26092680
"type":"list",

0 commit comments

Comments
 (0)