Skip to content

Commit 923f378

Browse files
author
AWS
committed
CodeArtifact Update: Documentation updates for CodeArtifact
1 parent ad2dcc1 commit 923f378

File tree

2 files changed

+25
-19
lines changed

2 files changed

+25
-19
lines changed

‎.changes/next-release/feature-CodeArtifact-35ce15b.json

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": "Documentation updates for CodeArtifact"
6+
}

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

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@
192192
{"shape":"ThrottlingException"},
193193
{"shape":"ValidationException"}
194194
],
195-
"documentation":"<p> Returns a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html\"> <code>DomainDescription</code> </a> object that contains information about the requested domain. </p>"
195+
"documentation":"<p> Returns a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html\">DomainDescription</a> object that contains information about the requested domain. </p>"
196196
},
197197
"DescribePackageVersion":{
198198
"name":"DescribePackageVersion",
@@ -210,7 +210,7 @@
210210
{"shape":"ThrottlingException"},
211211
{"shape":"ValidationException"}
212212
],
213-
"documentation":"<p> Returns a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html\"> <code>PackageVersionDescription</code> </a> object that contains information about the requested package version. </p>"
213+
"documentation":"<p> Returns a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html\">PackageVersionDescription</a> object that contains information about the requested package version. </p>"
214214
},
215215
"DescribeRepository":{
216216
"name":"DescribeRepository",
@@ -264,7 +264,7 @@
264264
{"shape":"ThrottlingException"},
265265
{"shape":"ValidationException"}
266266
],
267-
"documentation":"<p> Deletes the assets in package versions and sets the package versions' status to <code>Disposed</code>. A disposed package version cannot be restored in your repository because its assets are deleted. </p> <p> To view all disposed package versions in a repository, use <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html\"> <code>ListPackageVersions</code> </a> and set the <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html#API_ListPackageVersions_RequestSyntax\"> <code>status</code> </a> parameter to <code>Disposed</code>. </p> <p> To view information about a disposed package version, use <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DescribePackageVersion.html\"> <code>DescribePackageVersion</code> </a>.. </p>"
267+
"documentation":"<p> Deletes the assets in package versions and sets the package versions' status to <code>Disposed</code>. A disposed package version cannot be restored in your repository because its assets are deleted. </p> <p> To view all disposed package versions in a repository, use <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html\">ListPackageVersions</a> and set the <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html#API_ListPackageVersions_RequestSyntax\">status</a> parameter to <code>Disposed</code>. </p> <p> To view information about a disposed package version, use <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DescribePackageVersion.html\">DescribePackageVersion</a>. </p>"
268268
},
269269
"GetAuthorizationToken":{
270270
"name":"GetAuthorizationToken",
@@ -400,7 +400,7 @@
400400
{"shape":"ThrottlingException"},
401401
{"shape":"ValidationException"}
402402
],
403-
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html\"> <code>AssetSummary</code> </a> objects for assets in a package version. </p>"
403+
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html\">AssetSummary</a> objects for assets in a package version. </p>"
404404
},
405405
"ListPackageVersionDependencies":{
406406
"name":"ListPackageVersionDependencies",
@@ -417,7 +417,7 @@
417417
{"shape":"ThrottlingException"},
418418
{"shape":"ValidationException"}
419419
],
420-
"documentation":"<p> Returns the direct dependencies for a package version. The dependencies are returned as <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html\"> <code>PackageDependency</code> </a> objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the <code>package.json</code> file for npm packages and the <code>pom.xml</code> file for Maven). Any package version dependencies that are not listed in the configuration file are not returned. </p>"
420+
"documentation":"<p> Returns the direct dependencies for a package version. The dependencies are returned as <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html\">PackageDependency</a> objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the <code>package.json</code> file for npm packages and the <code>pom.xml</code> file for Maven). Any package version dependencies that are not listed in the configuration file are not returned. </p>"
421421
},
422422
"ListPackageVersions":{
423423
"name":"ListPackageVersions",
@@ -434,7 +434,7 @@
434434
{"shape":"ThrottlingException"},
435435
{"shape":"ValidationException"}
436436
],
437-
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html\"> <code>PackageVersionSummary</code> </a> objects for package versions in a repository that match the request parameters. </p>"
437+
"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>"
438438
},
439439
"ListPackages":{
440440
"name":"ListPackages",
@@ -451,7 +451,7 @@
451451
{"shape":"ThrottlingException"},
452452
{"shape":"ValidationException"}
453453
],
454-
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html\"> <code>PackageSummary</code> </a> objects for packages in a repository that match the request parameters. </p>"
454+
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html\">PackageSummary</a> objects for packages in a repository that match the request parameters. </p>"
455455
},
456456
"ListRepositories":{
457457
"name":"ListRepositories",
@@ -467,7 +467,7 @@
467467
{"shape":"ThrottlingException"},
468468
{"shape":"ValidationException"}
469469
],
470-
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html\"> <code>RepositorySummary</code> </a> objects. Each <code>RepositorySummary</code> contains information about a repository in the specified AWS account and that matches the input parameters. </p>"
470+
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html\">RepositorySummary</a> objects. Each <code>RepositorySummary</code> contains information about a repository in the specified AWS account and that matches the input parameters. </p>"
471471
},
472472
"ListRepositoriesInDomain":{
473473
"name":"ListRepositoriesInDomain",
@@ -484,7 +484,7 @@
484484
{"shape":"ThrottlingException"},
485485
{"shape":"ValidationException"}
486486
],
487-
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html\"> <code>RepositorySummary</code> </a> objects. Each <code>RepositorySummary</code> contains information about a repository in the specified domain and that matches the input parameters. </p>"
487+
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html\">RepositorySummary</a> objects. Each <code>RepositorySummary</code> contains information about a repository in the specified domain and that matches the input parameters. </p>"
488488
},
489489
"ListTagsForResource":{
490490
"name":"ListTagsForResource",
@@ -1434,7 +1434,7 @@
14341434
"documentation":"<p> The key used to encrypt the domain. </p>"
14351435
}
14361436
},
1437-
"documentation":"<p> Information about a domain, including its name, Amazon Resource Name (ARN), and status. The <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListDomains.html\"> <code>ListDomains</code> </a> operation returns a list of <code>DomainSummary</code> objects. </p>"
1437+
"documentation":"<p> Information about a domain, including its name, Amazon Resource Name (ARN), and status. The <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListDomains.html\">ListDomains</a> operation returns a list of <code>DomainSummary</code> objects. </p>"
14381438
},
14391439
"DomainSummaryList":{
14401440
"type":"list",
@@ -1946,7 +1946,7 @@
19461946
},
19471947
"assets":{
19481948
"shape":"AssetSummaryList",
1949-
"documentation":"<p> The returned list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html\"> <code>AssetSummary</code> </a> objects. </p>"
1949+
"documentation":"<p> The returned list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html\">AssetSummary</a> objects. </p>"
19501950
}
19511951
}
19521952
},
@@ -2039,7 +2039,7 @@
20392039
},
20402040
"dependencies":{
20412041
"shape":"PackageDependencyList",
2042-
"documentation":"<p> The returned list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html\"> <code>PackageDependency</code> </a> objects. </p>"
2042+
"documentation":"<p> The returned list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html\">PackageDependency</a> objects. </p>"
20432043
}
20442044
}
20452045
},
@@ -2140,7 +2140,7 @@
21402140
},
21412141
"versions":{
21422142
"shape":"PackageVersionSummaryList",
2143-
"documentation":"<p> The returned list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html\"> <code>PackageVersionSummary</code> </a> objects. </p>"
2143+
"documentation":"<p> The returned list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html\">PackageVersionSummary</a> objects. </p>"
21442144
},
21452145
"nextToken":{
21462146
"shape":"PaginationToken",
@@ -2215,7 +2215,7 @@
22152215
"members":{
22162216
"packages":{
22172217
"shape":"PackageSummaryList",
2218-
"documentation":"<p> The list of returned <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html\"> <code>PackageSummary</code> </a> objects. </p>"
2218+
"documentation":"<p> The list of returned <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html\">PackageSummary</a> objects. </p>"
22192219
},
22202220
"nextToken":{
22212221
"shape":"PaginationToken",
@@ -2316,7 +2316,7 @@
23162316
"members":{
23172317
"repositories":{
23182318
"shape":"RepositorySummaryList",
2319-
"documentation":"<p> The returned list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html\"> <code>RepositorySummary</code> </a> objects. </p>"
2319+
"documentation":"<p> The returned list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html\">RepositorySummary</a> objects. </p>"
23202320
},
23212321
"nextToken":{
23222322
"shape":"PaginationToken",
@@ -2410,7 +2410,7 @@
24102410
"documentation":"<p> The name of the package. </p>"
24112411
}
24122412
},
2413-
"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\"> <code>ListPackages</code> </a> operation returns a list of <code>PackageSummary</code> objects. </p>"
2413+
"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>"
24142414
},
24152415
"PackageSummaryList":{
24162416
"type":"list",
@@ -2557,7 +2557,7 @@
25572557
"documentation":"<p> A string that contains the status of the package version. It can be one of the following: </p> <ul> <li> <p> <code>Published</code> </p> </li> <li> <p> <code>Unfinished</code> </p> </li> <li> <p> <code>Unlisted</code> </p> </li> <li> <p> <code>Archived</code> </p> </li> <li> <p> <code>Disposed</code> </p> </li> </ul>"
25582558
}
25592559
},
2560-
"documentation":"<p> Details about a package version, including its status, version, and revision. The <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html\"> <code>ListPackageVersions</code> </a> operation returns a list of <code>PackageVersionSummary</code> objects. </p>"
2560+
"documentation":"<p> Details about a package version, including its status, version, and revision. The <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html\">ListPackageVersions</a> operation returns a list of <code>PackageVersionSummary</code> objects. </p>"
25612561
},
25622562
"PackageVersionSummaryList":{
25632563
"type":"list",
@@ -2753,7 +2753,7 @@
27532753
"documentation":"<p> The description of the repository. </p>"
27542754
}
27552755
},
2756-
"documentation":"<p> Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListRepositories.html\"> <code>ListRepositories</code> </a> operation returns a list of <code>RepositorySummary</code> objects. </p>"
2756+
"documentation":"<p> Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListRepositories.html\">ListRepositories</a> operation returns a list of <code>RepositorySummary</code> objects. </p>"
27572757
},
27582758
"RepositorySummaryList":{
27592759
"type":"list",
@@ -3085,7 +3085,7 @@
30853085
"documentation":"<p> The name of an upstream repository. </p>"
30863086
}
30873087
},
3088-
"documentation":"<p> Information about an upstream repository. A list of <code>UpstreamRepository</code> objects is an input parameter to <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html\"> <code>CreateRepository</code> </a> and <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdateRepository.html\"> <code>UpdateRepository</code> </a>. </p>"
3088+
"documentation":"<p> Information about an upstream repository. A list of <code>UpstreamRepository</code> objects is an input parameter to <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html\">CreateRepository</a> and <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdateRepository.html\">UpdateRepository</a>. </p>"
30893089
},
30903090
"UpstreamRepositoryInfo":{
30913091
"type":"structure",

0 commit comments

Comments
 (0)