@aws-sdk/client-codeartifact 3.128.0 → 3.130.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/README.md +10 -0
- package/dist-cjs/Codeartifact.js +30 -0
- package/dist-cjs/commands/DescribePackageCommand.js +36 -0
- package/dist-cjs/commands/PutPackageOriginConfigurationCommand.js +36 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +73 -3
- package/dist-cjs/protocols/Aws_restJson1.js +213 -2
- package/dist-es/Codeartifact.js +30 -0
- package/dist-es/commands/DescribePackageCommand.js +39 -0
- package/dist-es/commands/PutPackageOriginConfigurationCommand.js +39 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +52 -0
- package/dist-es/protocols/Aws_restJson1.js +247 -2
- package/dist-types/Codeartifact.d.ts +37 -1
- package/dist-types/CodeartifactClient.d.ts +14 -2
- package/dist-types/commands/DescribePackageCommand.d.ts +37 -0
- package/dist-types/commands/GetPackageVersionReadmeCommand.d.ts +3 -1
- package/dist-types/commands/PutPackageOriginConfigurationCommand.d.ts +43 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +466 -177
- package/dist-types/protocols/Aws_restJson1.d.ts +6 -0
- package/dist-types/ts3.4/Codeartifact.d.ts +10 -0
- package/dist-types/ts3.4/CodeartifactClient.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribePackageCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/PutPackageOriginConfigurationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +136 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +6 -0
- package/package.json +6 -6
|
@@ -10,6 +10,7 @@ import { DeletePackageVersionsCommandInput, DeletePackageVersionsCommandOutput }
|
|
|
10
10
|
import { DeleteRepositoryCommandInput, DeleteRepositoryCommandOutput } from "./commands/DeleteRepositoryCommand";
|
|
11
11
|
import { DeleteRepositoryPermissionsPolicyCommandInput, DeleteRepositoryPermissionsPolicyCommandOutput } from "./commands/DeleteRepositoryPermissionsPolicyCommand";
|
|
12
12
|
import { DescribeDomainCommandInput, DescribeDomainCommandOutput } from "./commands/DescribeDomainCommand";
|
|
13
|
+
import { DescribePackageCommandInput, DescribePackageCommandOutput } from "./commands/DescribePackageCommand";
|
|
13
14
|
import { DescribePackageVersionCommandInput, DescribePackageVersionCommandOutput } from "./commands/DescribePackageVersionCommand";
|
|
14
15
|
import { DescribeRepositoryCommandInput, DescribeRepositoryCommandOutput } from "./commands/DescribeRepositoryCommand";
|
|
15
16
|
import { DisassociateExternalConnectionCommandInput, DisassociateExternalConnectionCommandOutput } from "./commands/DisassociateExternalConnectionCommand";
|
|
@@ -29,6 +30,7 @@ import { ListRepositoriesCommandInput, ListRepositoriesCommandOutput } from "./c
|
|
|
29
30
|
import { ListRepositoriesInDomainCommandInput, ListRepositoriesInDomainCommandOutput } from "./commands/ListRepositoriesInDomainCommand";
|
|
30
31
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
31
32
|
import { PutDomainPermissionsPolicyCommandInput, PutDomainPermissionsPolicyCommandOutput } from "./commands/PutDomainPermissionsPolicyCommand";
|
|
33
|
+
import { PutPackageOriginConfigurationCommandInput, PutPackageOriginConfigurationCommandOutput } from "./commands/PutPackageOriginConfigurationCommand";
|
|
32
34
|
import { PutRepositoryPermissionsPolicyCommandInput, PutRepositoryPermissionsPolicyCommandOutput } from "./commands/PutRepositoryPermissionsPolicyCommand";
|
|
33
35
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
34
36
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
@@ -175,6 +177,11 @@ import { UpdateRepositoryCommandInput, UpdateRepositoryCommandOutput } from "./c
|
|
|
175
177
|
* </li>
|
|
176
178
|
* <li>
|
|
177
179
|
* <p>
|
|
180
|
+
* <code>DescribePackage</code>: Returns a <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html">PackageDescription</a>
|
|
181
|
+
* object that contains details about a package. </p>
|
|
182
|
+
* </li>
|
|
183
|
+
* <li>
|
|
184
|
+
* <p>
|
|
178
185
|
* <code>DescribePackageVersion</code>: Returns a <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html">PackageVersionDescription</a>
|
|
179
186
|
* object that contains details about a package version. </p>
|
|
180
187
|
* </li>
|
|
@@ -282,6 +289,11 @@ import { UpdateRepositoryCommandInput, UpdateRepositoryCommandOutput } from "./c
|
|
|
282
289
|
* </li>
|
|
283
290
|
* <li>
|
|
284
291
|
* <p>
|
|
292
|
+
* <code>PutPackageOriginConfiguration</code>: Sets the package origin configuration for a package, which determine
|
|
293
|
+
* how new versions of the package can be added to a specific repository.</p>
|
|
294
|
+
* </li>
|
|
295
|
+
* <li>
|
|
296
|
+
* <p>
|
|
285
297
|
* <code>PutRepositoryPermissionsPolicy</code>: Sets the resource policy on a repository
|
|
286
298
|
* that specifies permissions to access it. </p>
|
|
287
299
|
* </li>
|
|
@@ -403,6 +415,14 @@ export declare class Codeartifact extends CodeartifactClient {
|
|
|
403
415
|
describeDomain(args: DescribeDomainCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDomainCommandOutput>;
|
|
404
416
|
describeDomain(args: DescribeDomainCommandInput, cb: (err: any, data?: DescribeDomainCommandOutput) => void): void;
|
|
405
417
|
describeDomain(args: DescribeDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainCommandOutput) => void): void;
|
|
418
|
+
/**
|
|
419
|
+
* <p> Returns a
|
|
420
|
+
* <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html">PackageDescription</a>
|
|
421
|
+
* object that contains information about the requested package.</p>
|
|
422
|
+
*/
|
|
423
|
+
describePackage(args: DescribePackageCommandInput, options?: __HttpHandlerOptions): Promise<DescribePackageCommandOutput>;
|
|
424
|
+
describePackage(args: DescribePackageCommandInput, cb: (err: any, data?: DescribePackageCommandOutput) => void): void;
|
|
425
|
+
describePackage(args: DescribePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePackageCommandOutput) => void): void;
|
|
406
426
|
/**
|
|
407
427
|
* <p>
|
|
408
428
|
* Returns a
|
|
@@ -502,7 +522,9 @@ export declare class Codeartifact extends CodeartifactClient {
|
|
|
502
522
|
getPackageVersionAsset(args: GetPackageVersionAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPackageVersionAssetCommandOutput) => void): void;
|
|
503
523
|
/**
|
|
504
524
|
* <p>
|
|
505
|
-
* Gets the readme file or descriptive text for a package version.
|
|
525
|
+
* Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact
|
|
526
|
+
* extracts a description from a metadata file. For example, from the <code><description></code> element in the
|
|
527
|
+
* <code>pom.xml</code> file of a Maven package.
|
|
506
528
|
* </p>
|
|
507
529
|
* <p>
|
|
508
530
|
* The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.
|
|
@@ -641,6 +663,20 @@ export declare class Codeartifact extends CodeartifactClient {
|
|
|
641
663
|
putDomainPermissionsPolicy(args: PutDomainPermissionsPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutDomainPermissionsPolicyCommandOutput>;
|
|
642
664
|
putDomainPermissionsPolicy(args: PutDomainPermissionsPolicyCommandInput, cb: (err: any, data?: PutDomainPermissionsPolicyCommandOutput) => void): void;
|
|
643
665
|
putDomainPermissionsPolicy(args: PutDomainPermissionsPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDomainPermissionsPolicyCommandOutput) => void): void;
|
|
666
|
+
/**
|
|
667
|
+
* <p>Sets the package origin configuration for a package.</p>
|
|
668
|
+
* <p>The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct
|
|
669
|
+
* publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source.
|
|
670
|
+
* For more information about package origin controls and configuration, see <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/package-origin-controls.html">Editing package origin controls</a> in the <i>CodeArtifact User Guide</i>.</p>
|
|
671
|
+
* <p>
|
|
672
|
+
* <code>PutPackageOriginConfiguration</code> can be called on a package that doesn't yet exist in the repository. When called
|
|
673
|
+
* 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.
|
|
674
|
+
* This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block
|
|
675
|
+
* publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.</p>
|
|
676
|
+
*/
|
|
677
|
+
putPackageOriginConfiguration(args: PutPackageOriginConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutPackageOriginConfigurationCommandOutput>;
|
|
678
|
+
putPackageOriginConfiguration(args: PutPackageOriginConfigurationCommandInput, cb: (err: any, data?: PutPackageOriginConfigurationCommandOutput) => void): void;
|
|
679
|
+
putPackageOriginConfiguration(args: PutPackageOriginConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPackageOriginConfigurationCommandOutput) => void): void;
|
|
644
680
|
/**
|
|
645
681
|
* <p>
|
|
646
682
|
* Sets the resource policy on a repository that specifies permissions to access it.
|
|
@@ -16,6 +16,7 @@ import { DeletePackageVersionsCommandInput, DeletePackageVersionsCommandOutput }
|
|
|
16
16
|
import { DeleteRepositoryCommandInput, DeleteRepositoryCommandOutput } from "./commands/DeleteRepositoryCommand";
|
|
17
17
|
import { DeleteRepositoryPermissionsPolicyCommandInput, DeleteRepositoryPermissionsPolicyCommandOutput } from "./commands/DeleteRepositoryPermissionsPolicyCommand";
|
|
18
18
|
import { DescribeDomainCommandInput, DescribeDomainCommandOutput } from "./commands/DescribeDomainCommand";
|
|
19
|
+
import { DescribePackageCommandInput, DescribePackageCommandOutput } from "./commands/DescribePackageCommand";
|
|
19
20
|
import { DescribePackageVersionCommandInput, DescribePackageVersionCommandOutput } from "./commands/DescribePackageVersionCommand";
|
|
20
21
|
import { DescribeRepositoryCommandInput, DescribeRepositoryCommandOutput } from "./commands/DescribeRepositoryCommand";
|
|
21
22
|
import { DisassociateExternalConnectionCommandInput, DisassociateExternalConnectionCommandOutput } from "./commands/DisassociateExternalConnectionCommand";
|
|
@@ -35,13 +36,14 @@ import { ListRepositoriesCommandInput, ListRepositoriesCommandOutput } from "./c
|
|
|
35
36
|
import { ListRepositoriesInDomainCommandInput, ListRepositoriesInDomainCommandOutput } from "./commands/ListRepositoriesInDomainCommand";
|
|
36
37
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
37
38
|
import { PutDomainPermissionsPolicyCommandInput, PutDomainPermissionsPolicyCommandOutput } from "./commands/PutDomainPermissionsPolicyCommand";
|
|
39
|
+
import { PutPackageOriginConfigurationCommandInput, PutPackageOriginConfigurationCommandOutput } from "./commands/PutPackageOriginConfigurationCommand";
|
|
38
40
|
import { PutRepositoryPermissionsPolicyCommandInput, PutRepositoryPermissionsPolicyCommandOutput } from "./commands/PutRepositoryPermissionsPolicyCommand";
|
|
39
41
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
40
42
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
41
43
|
import { UpdatePackageVersionsStatusCommandInput, UpdatePackageVersionsStatusCommandOutput } from "./commands/UpdatePackageVersionsStatusCommand";
|
|
42
44
|
import { UpdateRepositoryCommandInput, UpdateRepositoryCommandOutput } from "./commands/UpdateRepositoryCommand";
|
|
43
|
-
export declare type ServiceInputTypes = AssociateExternalConnectionCommandInput | CopyPackageVersionsCommandInput | CreateDomainCommandInput | CreateRepositoryCommandInput | DeleteDomainCommandInput | DeleteDomainPermissionsPolicyCommandInput | DeletePackageVersionsCommandInput | DeleteRepositoryCommandInput | DeleteRepositoryPermissionsPolicyCommandInput | DescribeDomainCommandInput | DescribePackageVersionCommandInput | DescribeRepositoryCommandInput | DisassociateExternalConnectionCommandInput | DisposePackageVersionsCommandInput | GetAuthorizationTokenCommandInput | GetDomainPermissionsPolicyCommandInput | GetPackageVersionAssetCommandInput | GetPackageVersionReadmeCommandInput | GetRepositoryEndpointCommandInput | GetRepositoryPermissionsPolicyCommandInput | ListDomainsCommandInput | ListPackageVersionAssetsCommandInput | ListPackageVersionDependenciesCommandInput | ListPackageVersionsCommandInput | ListPackagesCommandInput | ListRepositoriesCommandInput | ListRepositoriesInDomainCommandInput | ListTagsForResourceCommandInput | PutDomainPermissionsPolicyCommandInput | PutRepositoryPermissionsPolicyCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdatePackageVersionsStatusCommandInput | UpdateRepositoryCommandInput;
|
|
44
|
-
export declare type ServiceOutputTypes = AssociateExternalConnectionCommandOutput | CopyPackageVersionsCommandOutput | CreateDomainCommandOutput | CreateRepositoryCommandOutput | DeleteDomainCommandOutput | DeleteDomainPermissionsPolicyCommandOutput | DeletePackageVersionsCommandOutput | DeleteRepositoryCommandOutput | DeleteRepositoryPermissionsPolicyCommandOutput | DescribeDomainCommandOutput | DescribePackageVersionCommandOutput | DescribeRepositoryCommandOutput | DisassociateExternalConnectionCommandOutput | DisposePackageVersionsCommandOutput | GetAuthorizationTokenCommandOutput | GetDomainPermissionsPolicyCommandOutput | GetPackageVersionAssetCommandOutput | GetPackageVersionReadmeCommandOutput | GetRepositoryEndpointCommandOutput | GetRepositoryPermissionsPolicyCommandOutput | ListDomainsCommandOutput | ListPackageVersionAssetsCommandOutput | ListPackageVersionDependenciesCommandOutput | ListPackageVersionsCommandOutput | ListPackagesCommandOutput | ListRepositoriesCommandOutput | ListRepositoriesInDomainCommandOutput | ListTagsForResourceCommandOutput | PutDomainPermissionsPolicyCommandOutput | PutRepositoryPermissionsPolicyCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdatePackageVersionsStatusCommandOutput | UpdateRepositoryCommandOutput;
|
|
45
|
+
export declare type ServiceInputTypes = AssociateExternalConnectionCommandInput | CopyPackageVersionsCommandInput | CreateDomainCommandInput | CreateRepositoryCommandInput | DeleteDomainCommandInput | DeleteDomainPermissionsPolicyCommandInput | DeletePackageVersionsCommandInput | DeleteRepositoryCommandInput | DeleteRepositoryPermissionsPolicyCommandInput | DescribeDomainCommandInput | DescribePackageCommandInput | DescribePackageVersionCommandInput | DescribeRepositoryCommandInput | DisassociateExternalConnectionCommandInput | DisposePackageVersionsCommandInput | GetAuthorizationTokenCommandInput | GetDomainPermissionsPolicyCommandInput | GetPackageVersionAssetCommandInput | GetPackageVersionReadmeCommandInput | GetRepositoryEndpointCommandInput | GetRepositoryPermissionsPolicyCommandInput | ListDomainsCommandInput | ListPackageVersionAssetsCommandInput | ListPackageVersionDependenciesCommandInput | ListPackageVersionsCommandInput | ListPackagesCommandInput | ListRepositoriesCommandInput | ListRepositoriesInDomainCommandInput | ListTagsForResourceCommandInput | PutDomainPermissionsPolicyCommandInput | PutPackageOriginConfigurationCommandInput | PutRepositoryPermissionsPolicyCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdatePackageVersionsStatusCommandInput | UpdateRepositoryCommandInput;
|
|
46
|
+
export declare type ServiceOutputTypes = AssociateExternalConnectionCommandOutput | CopyPackageVersionsCommandOutput | CreateDomainCommandOutput | CreateRepositoryCommandOutput | DeleteDomainCommandOutput | DeleteDomainPermissionsPolicyCommandOutput | DeletePackageVersionsCommandOutput | DeleteRepositoryCommandOutput | DeleteRepositoryPermissionsPolicyCommandOutput | DescribeDomainCommandOutput | DescribePackageCommandOutput | DescribePackageVersionCommandOutput | DescribeRepositoryCommandOutput | DisassociateExternalConnectionCommandOutput | DisposePackageVersionsCommandOutput | GetAuthorizationTokenCommandOutput | GetDomainPermissionsPolicyCommandOutput | GetPackageVersionAssetCommandOutput | GetPackageVersionReadmeCommandOutput | GetRepositoryEndpointCommandOutput | GetRepositoryPermissionsPolicyCommandOutput | ListDomainsCommandOutput | ListPackageVersionAssetsCommandOutput | ListPackageVersionDependenciesCommandOutput | ListPackageVersionsCommandOutput | ListPackagesCommandOutput | ListRepositoriesCommandOutput | ListRepositoriesInDomainCommandOutput | ListTagsForResourceCommandOutput | PutDomainPermissionsPolicyCommandOutput | PutPackageOriginConfigurationCommandOutput | PutRepositoryPermissionsPolicyCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdatePackageVersionsStatusCommandOutput | UpdateRepositoryCommandOutput;
|
|
45
47
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
46
48
|
/**
|
|
47
49
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -300,6 +302,11 @@ export interface CodeartifactClientResolvedConfig extends CodeartifactClientReso
|
|
|
300
302
|
* </li>
|
|
301
303
|
* <li>
|
|
302
304
|
* <p>
|
|
305
|
+
* <code>DescribePackage</code>: Returns a <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html">PackageDescription</a>
|
|
306
|
+
* object that contains details about a package. </p>
|
|
307
|
+
* </li>
|
|
308
|
+
* <li>
|
|
309
|
+
* <p>
|
|
303
310
|
* <code>DescribePackageVersion</code>: Returns a <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html">PackageVersionDescription</a>
|
|
304
311
|
* object that contains details about a package version. </p>
|
|
305
312
|
* </li>
|
|
@@ -407,6 +414,11 @@ export interface CodeartifactClientResolvedConfig extends CodeartifactClientReso
|
|
|
407
414
|
* </li>
|
|
408
415
|
* <li>
|
|
409
416
|
* <p>
|
|
417
|
+
* <code>PutPackageOriginConfiguration</code>: Sets the package origin configuration for a package, which determine
|
|
418
|
+
* how new versions of the package can be added to a specific repository.</p>
|
|
419
|
+
* </li>
|
|
420
|
+
* <li>
|
|
421
|
+
* <p>
|
|
410
422
|
* <code>PutRepositoryPermissionsPolicy</code>: Sets the resource policy on a repository
|
|
411
423
|
* that specifies permissions to access it. </p>
|
|
412
424
|
* </li>
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { CodeartifactClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeartifactClient";
|
|
4
|
+
import { DescribePackageRequest, DescribePackageResult } from "../models/models_0";
|
|
5
|
+
export interface DescribePackageCommandInput extends DescribePackageRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface DescribePackageCommandOutput extends DescribePackageResult, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p> Returns a
|
|
11
|
+
* <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html">PackageDescription</a>
|
|
12
|
+
* object that contains information about the requested package.</p>
|
|
13
|
+
* @example
|
|
14
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
15
|
+
* ```javascript
|
|
16
|
+
* import { CodeartifactClient, DescribePackageCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import
|
|
17
|
+
* // const { CodeartifactClient, DescribePackageCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import
|
|
18
|
+
* const client = new CodeartifactClient(config);
|
|
19
|
+
* const command = new DescribePackageCommand(input);
|
|
20
|
+
* const response = await client.send(command);
|
|
21
|
+
* ```
|
|
22
|
+
*
|
|
23
|
+
* @see {@link DescribePackageCommandInput} for command's `input` shape.
|
|
24
|
+
* @see {@link DescribePackageCommandOutput} for command's `response` shape.
|
|
25
|
+
* @see {@link CodeartifactClientResolvedConfig | config} for CodeartifactClient's `config` shape.
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export declare class DescribePackageCommand extends $Command<DescribePackageCommandInput, DescribePackageCommandOutput, CodeartifactClientResolvedConfig> {
|
|
29
|
+
readonly input: DescribePackageCommandInput;
|
|
30
|
+
constructor(input: DescribePackageCommandInput);
|
|
31
|
+
/**
|
|
32
|
+
* @internal
|
|
33
|
+
*/
|
|
34
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeartifactClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePackageCommandInput, DescribePackageCommandOutput>;
|
|
35
|
+
private serialize;
|
|
36
|
+
private deserialize;
|
|
37
|
+
}
|
|
@@ -8,7 +8,9 @@ export interface GetPackageVersionReadmeCommandOutput extends GetPackageVersionR
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>
|
|
11
|
-
* Gets the readme file or descriptive text for a package version.
|
|
11
|
+
* Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact
|
|
12
|
+
* extracts a description from a metadata file. For example, from the <code><description></code> element in the
|
|
13
|
+
* <code>pom.xml</code> file of a Maven package.
|
|
12
14
|
* </p>
|
|
13
15
|
* <p>
|
|
14
16
|
* The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { CodeartifactClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeartifactClient";
|
|
4
|
+
import { PutPackageOriginConfigurationRequest, PutPackageOriginConfigurationResult } from "../models/models_0";
|
|
5
|
+
export interface PutPackageOriginConfigurationCommandInput extends PutPackageOriginConfigurationRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface PutPackageOriginConfigurationCommandOutput extends PutPackageOriginConfigurationResult, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Sets the package origin configuration for a package.</p>
|
|
11
|
+
* <p>The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct
|
|
12
|
+
* publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source.
|
|
13
|
+
* For more information about package origin controls and configuration, see <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/package-origin-controls.html">Editing package origin controls</a> in the <i>CodeArtifact User Guide</i>.</p>
|
|
14
|
+
* <p>
|
|
15
|
+
* <code>PutPackageOriginConfiguration</code> can be called on a package that doesn't yet exist in the repository. When called
|
|
16
|
+
* 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.
|
|
17
|
+
* This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block
|
|
18
|
+
* publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.</p>
|
|
19
|
+
* @example
|
|
20
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
21
|
+
* ```javascript
|
|
22
|
+
* import { CodeartifactClient, PutPackageOriginConfigurationCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import
|
|
23
|
+
* // const { CodeartifactClient, PutPackageOriginConfigurationCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import
|
|
24
|
+
* const client = new CodeartifactClient(config);
|
|
25
|
+
* const command = new PutPackageOriginConfigurationCommand(input);
|
|
26
|
+
* const response = await client.send(command);
|
|
27
|
+
* ```
|
|
28
|
+
*
|
|
29
|
+
* @see {@link PutPackageOriginConfigurationCommandInput} for command's `input` shape.
|
|
30
|
+
* @see {@link PutPackageOriginConfigurationCommandOutput} for command's `response` shape.
|
|
31
|
+
* @see {@link CodeartifactClientResolvedConfig | config} for CodeartifactClient's `config` shape.
|
|
32
|
+
*
|
|
33
|
+
*/
|
|
34
|
+
export declare class PutPackageOriginConfigurationCommand extends $Command<PutPackageOriginConfigurationCommandInput, PutPackageOriginConfigurationCommandOutput, CodeartifactClientResolvedConfig> {
|
|
35
|
+
readonly input: PutPackageOriginConfigurationCommandInput;
|
|
36
|
+
constructor(input: PutPackageOriginConfigurationCommandInput);
|
|
37
|
+
/**
|
|
38
|
+
* @internal
|
|
39
|
+
*/
|
|
40
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeartifactClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutPackageOriginConfigurationCommandInput, PutPackageOriginConfigurationCommandOutput>;
|
|
41
|
+
private serialize;
|
|
42
|
+
private deserialize;
|
|
43
|
+
}
|
|
@@ -8,6 +8,7 @@ export * from "./DeletePackageVersionsCommand";
|
|
|
8
8
|
export * from "./DeleteRepositoryCommand";
|
|
9
9
|
export * from "./DeleteRepositoryPermissionsPolicyCommand";
|
|
10
10
|
export * from "./DescribeDomainCommand";
|
|
11
|
+
export * from "./DescribePackageCommand";
|
|
11
12
|
export * from "./DescribePackageVersionCommand";
|
|
12
13
|
export * from "./DescribeRepositoryCommand";
|
|
13
14
|
export * from "./DisassociateExternalConnectionCommand";
|
|
@@ -27,6 +28,7 @@ export * from "./ListRepositoriesCommand";
|
|
|
27
28
|
export * from "./ListRepositoriesInDomainCommand";
|
|
28
29
|
export * from "./ListTagsForResourceCommand";
|
|
29
30
|
export * from "./PutDomainPermissionsPolicyCommand";
|
|
31
|
+
export * from "./PutPackageOriginConfigurationCommand";
|
|
30
32
|
export * from "./PutRepositoryPermissionsPolicyCommand";
|
|
31
33
|
export * from "./TagResourceCommand";
|
|
32
34
|
export * from "./UntagResourceCommand";
|