Skip to content

Commit 013e253

Browse files
author
awstools
committed
docs(client-codeartifact): Documentation updates for CodeArtifact
1 parent 96a2ec3 commit 013e253

17 files changed

+306
-731
lines changed

‎clients/client-codeartifact/README.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99

1010
AWS SDK for JavaScript Codeartifact Client for Node.js, Browser and React Native.
1111

12-
<p> AWS CodeArtifact is a fully managed artifact repository compatible with language-native
13-
package managers and build tools such as npm, Apache Maven, and pip. You can use CodeArtifact to
12+
<p> CodeArtifact is a fully managed artifact repository compatible with language-native
13+
package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to
1414
share packages with development teams and pull packages. Packages can be pulled from both
1515
public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact
1616
repository and another repository, which effectively merges their contents from the point of
1717
view of a package manager client. </p>
1818

1919
<p>
20-
<b>AWS CodeArtifact Components</b>
20+
<b>CodeArtifact Components</b>
2121
</p>
2222
<p>Use the information in this guide to help you work with the following CodeArtifact components:</p>
2323

@@ -32,9 +32,9 @@ repository exposes endpoints for fetching and publishing packages using tools li
3232
<code>npm</code>
3333
</b> CLI, the Maven CLI (<b>
3434
<code>mvn</code>
35-
</b>), and <b>
35+
</b>), Python CLIs (<b>
3636
<code>pip</code>
37-
</b>.</p>
37+
</b> and <code>twine</code>), and NuGet CLIs (<code>nuget</code> and <code>dotnet</code>).</p>
3838
</li>
3939
<li>
4040
<p>
@@ -43,7 +43,7 @@ repository exposes endpoints for fetching and publishing packages using tools li
4343
but are consumed through repositories. A given package asset, such as a Maven JAR file, is
4444
stored once per domain, no matter how many repositories it's present in. All of the assets
4545
and metadata in a domain are encrypted with the same customer master key (CMK) stored in
46-
AWS Key Management Service (AWS KMS).</p>
46+
Key Management Service (KMS).</p>
4747
<p>Each repository is a member of a single domain and can't be moved to a
4848
different domain.</p>
4949
<p>The domain allows organizational policy to be applied across multiple
@@ -56,7 +56,7 @@ across their organization.</p>
5656
<li>
5757
<p>
5858
<b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to
59-
resolve dependencies and install the software. CodeArtifact supports <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html">npm</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html">PyPI</a>, and <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven">Maven</a> package formats.</p>
59+
resolve dependencies and install the software. CodeArtifact supports <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html">npm</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html">PyPI</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven">Maven</a>, and <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget">NuGet</a> package formats.</p>
6060
<p>In CodeArtifact, a package consists of:</p>
6161
<ul>
6262
<li>
@@ -194,17 +194,22 @@ package format:
194194
<ul>
195195
<li>
196196
<p>
197+
<code>maven</code>
198+
</p>
199+
</li>
200+
<li>
201+
<p>
197202
<code>npm</code>
198203
</p>
199204
</li>
200205
<li>
201206
<p>
202-
<code>pypi</code>
207+
<code>nuget</code>
203208
</p>
204209
</li>
205210
<li>
206211
<p>
207-
<code>maven</code>
212+
<code>pypi</code>
208213
</p>
209214
</li>
210215
</ul>
@@ -239,7 +244,7 @@ package in a repository.</p>
239244
</li>
240245
<li>
241246
<p>
242-
<code>ListRepositories</code>: Returns a list of repositories owned by the AWS account that called this method.</p>
247+
<code>ListRepositories</code>: Returns a list of repositories owned by the Amazon Web Services account that called this method.</p>
243248
</li>
244249
<li>
245250
<p>

‎clients/client-codeartifact/src/Codeartifact.ts

+36-25
Original file line numberDiff line numberDiff line change
@@ -166,15 +166,15 @@ import {
166166
} from "./commands/UpdateRepositoryCommand";
167167

168168
/**
169-
* <p> AWS CodeArtifact is a fully managed artifact repository compatible with language-native
170-
* package managers and build tools such as npm, Apache Maven, and pip. You can use CodeArtifact to
169+
* <p> CodeArtifact is a fully managed artifact repository compatible with language-native
170+
* package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to
171171
* share packages with development teams and pull packages. Packages can be pulled from both
172172
* public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact
173173
* repository and another repository, which effectively merges their contents from the point of
174174
* view of a package manager client. </p>
175175
*
176176
* <p>
177-
* <b>AWS CodeArtifact Components</b>
177+
* <b>CodeArtifact Components</b>
178178
* </p>
179179
* <p>Use the information in this guide to help you work with the following CodeArtifact components:</p>
180180
*
@@ -189,9 +189,9 @@ import {
189189
* <code>npm</code>
190190
* </b> CLI, the Maven CLI (<b>
191191
* <code>mvn</code>
192-
* </b>), and <b>
192+
* </b>), Python CLIs (<b>
193193
* <code>pip</code>
194-
* </b>.</p>
194+
* </b> and <code>twine</code>), and NuGet CLIs (<code>nuget</code> and <code>dotnet</code>).</p>
195195
* </li>
196196
* <li>
197197
* <p>
@@ -200,7 +200,7 @@ import {
200200
* but are consumed through repositories. A given package asset, such as a Maven JAR file, is
201201
* stored once per domain, no matter how many repositories it's present in. All of the assets
202202
* and metadata in a domain are encrypted with the same customer master key (CMK) stored in
203-
* AWS Key Management Service (AWS KMS).</p>
203+
* Key Management Service (KMS).</p>
204204
* <p>Each repository is a member of a single domain and can't be moved to a
205205
* different domain.</p>
206206
* <p>The domain allows organizational policy to be applied across multiple
@@ -213,7 +213,7 @@ import {
213213
* <li>
214214
* <p>
215215
* <b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to
216-
* resolve dependencies and install the software. CodeArtifact supports <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html">npm</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html">PyPI</a>, and <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven">Maven</a> package formats.</p>
216+
* resolve dependencies and install the software. CodeArtifact supports <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html">npm</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html">PyPI</a>, <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven">Maven</a>, and <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget">NuGet</a> package formats.</p>
217217
* <p>In CodeArtifact, a package consists of:</p>
218218
* <ul>
219219
* <li>
@@ -351,17 +351,22 @@ import {
351351
* <ul>
352352
* <li>
353353
* <p>
354+
* <code>maven</code>
355+
* </p>
356+
* </li>
357+
* <li>
358+
* <p>
354359
* <code>npm</code>
355360
* </p>
356361
* </li>
357362
* <li>
358363
* <p>
359-
* <code>pypi</code>
364+
* <code>nuget</code>
360365
* </p>
361366
* </li>
362367
* <li>
363368
* <p>
364-
* <code>maven</code>
369+
* <code>pypi</code>
365370
* </p>
366371
* </li>
367372
* </ul>
@@ -396,7 +401,7 @@ import {
396401
* </li>
397402
* <li>
398403
* <p>
399-
* <code>ListRepositories</code>: Returns a list of repositories owned by the AWS account that called this method.</p>
404+
* <code>ListRepositories</code>: Returns a list of repositories owned by the Amazon Web Services account that called this method.</p>
400405
* </li>
401406
* <li>
402407
* <p>
@@ -501,7 +506,7 @@ export class Codeartifact extends CodeartifactClient {
501506
* <p>
502507
* Creates a domain. CodeArtifact <i>domains</i> make it easier to manage multiple repositories across an
503508
* organization. You can use a domain to apply permissions across many
504-
* repositories owned by different AWS accounts. An asset is stored only once
509+
* repositories owned by different Amazon Web Services accounts. An asset is stored only once
505510
* in a domain, even if it's in multiple repositories.
506511
* </p>
507512
*
@@ -713,7 +718,7 @@ export class Codeartifact extends CodeartifactClient {
713718
* </p>
714719
* <important>
715720
* <p>
716-
* Use <code>DeleteRepositoryPermissionsPolicy</code> with caution. After a policy is deleted, AWS users, roles, and accounts lose permissions to perform
721+
* Use <code>DeleteRepositoryPermissionsPolicy</code> with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform
717722
* the repository actions granted by the deleted policy.
718723
* </p>
719724
* </important>
@@ -938,7 +943,7 @@ export class Codeartifact extends CodeartifactClient {
938943
* Generates a temporary authorization token for accessing repositories in the domain.
939944
* This API requires the <code>codeartifact:GetAuthorizationToken</code> and <code>sts:GetServiceBearerToken</code> permissions.
940945
* For more information about authorization tokens, see
941-
* <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/tokens-authentication.html">AWS CodeArtifact authentication and tokens</a>.
946+
* <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/tokens-authentication.html">CodeArtifact authentication and tokens</a>.
942947
* </p>
943948
* <note>
944949
* <p>CodeArtifact authorization tokens are valid for a period of 12 hours when created with the <code>login</code> command.
@@ -993,7 +998,7 @@ export class Codeartifact extends CodeartifactClient {
993998
* <p>
994999
* The policy is a resource-based policy, not an identity-based policy. For more information, see
9951000
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html">Identity-based policies
996-
* and resource-based policies </a> in the <i>AWS Identity and Access Management User Guide</i>.
1001+
* and resource-based policies </a> in the <i>IAM User Guide</i>.
9971002
* </p>
9981003
* </note>
9991004
*/
@@ -1064,9 +1069,7 @@ export class Codeartifact extends CodeartifactClient {
10641069

10651070
/**
10661071
* <p>
1067-
* Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact
1068-
* extracts a description from a metadata file. For example, from the <code><description></code> element in the
1069-
* <code>pom.xml</code> file of a Maven package.
1072+
* Gets the readme file or descriptive text for a package version.
10701073
* </p>
10711074
* <p>
10721075
* The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.
@@ -1109,17 +1112,22 @@ export class Codeartifact extends CodeartifactClient {
11091112
* <ul>
11101113
* <li>
11111114
* <p>
1115+
* <code>maven</code>
1116+
* </p>
1117+
* </li>
1118+
* <li>
1119+
* <p>
11121120
* <code>npm</code>
11131121
* </p>
11141122
* </li>
11151123
* <li>
11161124
* <p>
1117-
* <code>pypi</code>
1125+
* <code>nuget</code>
11181126
* </p>
11191127
* </li>
11201128
* <li>
11211129
* <p>
1122-
* <code>maven</code>
1130+
* <code>pypi</code>
11231131
* </p>
11241132
* </li>
11251133
* </ul>
@@ -1188,7 +1196,7 @@ export class Codeartifact extends CodeartifactClient {
11881196
}
11891197

11901198
/**
1191-
* <p> Returns a list of <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html">DomainSummary</a> objects for all domains owned by the AWS account that makes
1199+
* <p> Returns a list of <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html">DomainSummary</a> objects for all domains owned by the Amazon Web Services account that makes
11921200
* this call. Each returned <code>DomainSummary</code> object contains information about a
11931201
* domain. </p>
11941202
*/
@@ -1362,7 +1370,7 @@ export class Codeartifact extends CodeartifactClient {
13621370
* <p>
13631371
* Returns a list of
13641372
* <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html">RepositorySummary</a>
1365-
* objects. Each <code>RepositorySummary</code> contains information about a repository in the specified AWS account and that matches the input
1373+
* objects. Each <code>RepositorySummary</code> contains information about a repository in the specified Amazon Web Services account and that matches the input
13661374
* parameters.
13671375
* </p>
13681376
*/
@@ -1433,7 +1441,7 @@ export class Codeartifact extends CodeartifactClient {
14331441
}
14341442

14351443
/**
1436-
* <p>Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeArtifact.</p>
1444+
* <p>Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.</p>
14371445
*/
14381446
public listTagsForResource(
14391447
args: ListTagsForResourceCommandInput,
@@ -1543,7 +1551,7 @@ export class Codeartifact extends CodeartifactClient {
15431551
}
15441552

15451553
/**
1546-
* <p>Adds or updates tags for a resource in AWS CodeArtifact.</p>
1554+
* <p>Adds or updates tags for a resource in CodeArtifact.</p>
15471555
*/
15481556
public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
15491557
public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
@@ -1569,7 +1577,7 @@ export class Codeartifact extends CodeartifactClient {
15691577
}
15701578

15711579
/**
1572-
* <p>Removes tags from a resource in AWS CodeArtifact.</p>
1580+
* <p>Removes tags from a resource in CodeArtifact.</p>
15731581
*/
15741582
public untagResource(
15751583
args: UntagResourceCommandInput,
@@ -1602,7 +1610,10 @@ export class Codeartifact extends CodeartifactClient {
16021610

16031611
/**
16041612
* <p>
1605-
* Updates the status of one or more versions of a package.
1613+
* Updates the status of one or more versions of a package. Using <code>UpdatePackageVersionsStatus</code>,
1614+
* you can update the status of package versions to <code>Archived</code>, <code>Published</code>, or <code>Unlisted</code>.
1615+
* To set the status of a package version to <code>Disposed</code>, use
1616+
* <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DisposePackageVersions.html">DisposePackageVersions</a>.
16061617
* </p>
16071618
*/
16081619
public updatePackageVersionsStatus(

0 commit comments

Comments
 (0)