@aws-sdk/client-ecr 3.288.0 → 3.289.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.
Files changed (10) hide show
  1. package/dist-types/commands/BatchDeleteImageCommand.d.ts +27 -0
  2. package/dist-types/commands/BatchGetImageCommand.d.ts +32 -0
  3. package/dist-types/commands/CreateRepositoryCommand.d.ts +20 -0
  4. package/dist-types/commands/DeleteRepositoryCommand.d.ts +21 -0
  5. package/dist-types/commands/DeleteRepositoryPolicyCommand.d.ts +18 -0
  6. package/dist-types/commands/DescribeRepositoriesCommand.d.ts +25 -0
  7. package/dist-types/commands/GetAuthorizationTokenCommand.d.ts +20 -0
  8. package/dist-types/commands/GetRepositoryPolicyCommand.d.ts +18 -0
  9. package/dist-types/commands/ListImagesCommand.d.ts +21 -0
  10. package/package.json +30 -30
package/dist-types/commands/BatchDeleteImageCommand.d.ts CHANGED
@@ -34,6 +34,33 @@ export interface BatchDeleteImageCommandOutput extends BatchDeleteImageResponse,
34
34
  * @see {@link BatchDeleteImageCommandOutput} for command's `response` shape.
35
35
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
36
36
  *
37
+ * @example To delete multiple images
38
+ * ```javascript
39
+ * // This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account.
40
+ * const input = {
41
+ * "imageIds": [
42
+ * {
43
+ * "imageTag": "precise"
44
+ * }
45
+ * ],
46
+ * "repositoryName": "ubuntu"
47
+ * };
48
+ * const command = new BatchDeleteImageCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "failures": [],
53
+ * "imageIds": [
54
+ * {
55
+ * "imageDigest": "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f",
56
+ * "imageTag": "precise"
57
+ * }
58
+ * ]
59
+ * }
60
+ * *\/
61
+ * // example id: batchdeleteimages-example-1470860541707
62
+ * ```
63
+ *
37
64
  */
38
65
  export declare class BatchDeleteImageCommand extends $Command<BatchDeleteImageCommandInput, BatchDeleteImageCommandOutput, ECRClientResolvedConfig> {
39
66
  readonly input: BatchDeleteImageCommandInput;
package/dist-types/commands/BatchGetImageCommand.d.ts CHANGED
@@ -32,6 +32,38 @@ export interface BatchGetImageCommandOutput extends BatchGetImageResponse, __Met
32
32
  * @see {@link BatchGetImageCommandOutput} for command's `response` shape.
33
33
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
34
34
  *
35
+ * @example To obtain multiple images in a single request
36
+ * ```javascript
37
+ * // This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.
38
+ * const input = {
39
+ * "imageIds": [
40
+ * {
41
+ * "imageTag": "precise"
42
+ * }
43
+ * ],
44
+ * "repositoryName": "ubuntu"
45
+ * };
46
+ * const command = new BatchGetImageCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "failures": [],
51
+ * "images": [
52
+ * {
53
+ * "imageId": {
54
+ * "imageDigest": "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a",
55
+ * "imageTag": "precise"
56
+ * },
57
+ * "imageManifest": "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...",
58
+ * "registryId": "244698725403",
59
+ * "repositoryName": "ubuntu"
60
+ * }
61
+ * ]
62
+ * }
63
+ * *\/
64
+ * // example id: batchgetimage-example-1470862771437
65
+ * ```
66
+ *
35
67
  */
36
68
  export declare class BatchGetImageCommand extends $Command<BatchGetImageCommandInput, BatchGetImageCommandOutput, ECRClientResolvedConfig> {
37
69
  readonly input: BatchGetImageCommandInput;
package/dist-types/commands/CreateRepositoryCommand.d.ts CHANGED
@@ -30,6 +30,26 @@ export interface CreateRepositoryCommandOutput extends CreateRepositoryResponse,
30
30
  * @see {@link CreateRepositoryCommandOutput} for command's `response` shape.
31
31
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
32
32
  *
33
+ * @example To create a new repository
34
+ * ```javascript
35
+ * // This example creates a repository called nginx-web-app inside the project-a namespace in the default registry for an account.
36
+ * const input = {
37
+ * "repositoryName": "project-a/nginx-web-app"
38
+ * };
39
+ * const command = new CreateRepositoryCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "repository": {
44
+ * "registryId": "012345678901",
45
+ * "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/project-a/nginx-web-app",
46
+ * "repositoryName": "project-a/nginx-web-app"
47
+ * }
48
+ * }
49
+ * *\/
50
+ * // example id: createrepository-example-1470863688724
51
+ * ```
52
+ *
33
53
  */
34
54
  export declare class CreateRepositoryCommand extends $Command<CreateRepositoryCommandInput, CreateRepositoryCommandOutput, ECRClientResolvedConfig> {
35
55
  readonly input: CreateRepositoryCommandInput;
package/dist-types/commands/DeleteRepositoryCommand.d.ts CHANGED
@@ -31,6 +31,27 @@ export interface DeleteRepositoryCommandOutput extends DeleteRepositoryResponse,
31
31
  * @see {@link DeleteRepositoryCommandOutput} for command's `response` shape.
32
32
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
33
33
  *
34
+ * @example To force delete a repository
35
+ * ```javascript
36
+ * // This example force deletes a repository named ubuntu in the default registry for an account. The force parameter is required if the repository contains images.
37
+ * const input = {
38
+ * "force": true,
39
+ * "repositoryName": "ubuntu"
40
+ * };
41
+ * const command = new DeleteRepositoryCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "repository": {
46
+ * "registryId": "012345678901",
47
+ * "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/ubuntu",
48
+ * "repositoryName": "ubuntu"
49
+ * }
50
+ * }
51
+ * *\/
52
+ * // example id: deleterepository-example-1470863805703
53
+ * ```
54
+ *
34
55
  */
35
56
  export declare class DeleteRepositoryCommand extends $Command<DeleteRepositoryCommandInput, DeleteRepositoryCommandOutput, ECRClientResolvedConfig> {
36
57
  readonly input: DeleteRepositoryCommandInput;
package/dist-types/commands/DeleteRepositoryPolicyCommand.d.ts CHANGED
@@ -29,6 +29,24 @@ export interface DeleteRepositoryPolicyCommandOutput extends DeleteRepositoryPol
29
29
  * @see {@link DeleteRepositoryPolicyCommandOutput} for command's `response` shape.
30
30
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
31
31
  *
32
+ * @example To delete the policy associated with a repository
33
+ * ```javascript
34
+ * // This example deletes the policy associated with the repository named ubuntu in the current account.
35
+ * const input = {
36
+ * "repositoryName": "ubuntu"
37
+ * };
38
+ * const command = new DeleteRepositoryPolicyCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "policyText": "{ ... }",
43
+ * "registryId": "012345678901",
44
+ * "repositoryName": "ubuntu"
45
+ * }
46
+ * *\/
47
+ * // example id: deleterepositorypolicy-example-1470866943748
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class DeleteRepositoryPolicyCommand extends $Command<DeleteRepositoryPolicyCommandInput, DeleteRepositoryPolicyCommandOutput, ECRClientResolvedConfig> {
34
52
  readonly input: DeleteRepositoryPolicyCommandInput;
package/dist-types/commands/DescribeRepositoriesCommand.d.ts CHANGED
@@ -29,6 +29,31 @@ export interface DescribeRepositoriesCommandOutput extends DescribeRepositoriesR
29
29
  * @see {@link DescribeRepositoriesCommandOutput} for command's `response` shape.
30
30
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
31
31
  *
32
+ * @example To describe all repositories in the current account
33
+ * ```javascript
34
+ * // The following example obtains a list and description of all repositories in the default registry to which the current user has access.
35
+ * const input = {};
36
+ * const command = new DescribeRepositoriesCommand(input);
37
+ * const response = await client.send(command);
38
+ * /* response ==
39
+ * {
40
+ * "repositories": [
41
+ * {
42
+ * "registryId": "012345678910",
43
+ * "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/ubuntu",
44
+ * "repositoryName": "ubuntu"
45
+ * },
46
+ * {
47
+ * "registryId": "012345678910",
48
+ * "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/test",
49
+ * "repositoryName": "test"
50
+ * }
51
+ * ]
52
+ * }
53
+ * *\/
54
+ * // example id: describe-repositories-1470856017467
55
+ * ```
56
+ *
32
57
  */
33
58
  export declare class DescribeRepositoriesCommand extends $Command<DescribeRepositoriesCommandInput, DescribeRepositoriesCommandOutput, ECRClientResolvedConfig> {
34
59
  readonly input: DescribeRepositoriesCommandInput;
package/dist-types/commands/GetAuthorizationTokenCommand.d.ts CHANGED
@@ -36,6 +36,26 @@ export interface GetAuthorizationTokenCommandOutput extends GetAuthorizationToke
36
36
  * @see {@link GetAuthorizationTokenCommandOutput} for command's `response` shape.
37
37
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
38
38
  *
39
+ * @example To obtain an authorization token
40
+ * ```javascript
41
+ * // This example gets an authorization token for your default registry.
42
+ * const input = {};
43
+ * const command = new GetAuthorizationTokenCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "authorizationData": [
48
+ * {
49
+ * "authorizationToken": "QVdTOkN...",
50
+ * "expiresAt": "1470951892432",
51
+ * "proxyEndpoint": "https://012345678901.dkr.ecr.us-west-2.amazonaws.com"
52
+ * }
53
+ * ]
54
+ * }
55
+ * *\/
56
+ * // example id: getauthorizationtoken-example-1470867047084
57
+ * ```
58
+ *
39
59
  */
40
60
  export declare class GetAuthorizationTokenCommand extends $Command<GetAuthorizationTokenCommandInput, GetAuthorizationTokenCommandOutput, ECRClientResolvedConfig> {
41
61
  readonly input: GetAuthorizationTokenCommandInput;
package/dist-types/commands/GetRepositoryPolicyCommand.d.ts CHANGED
@@ -29,6 +29,24 @@ export interface GetRepositoryPolicyCommandOutput extends GetRepositoryPolicyRes
29
29
  * @see {@link GetRepositoryPolicyCommandOutput} for command's `response` shape.
30
30
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
31
31
  *
32
+ * @example To get the current policy for a repository
33
+ * ```javascript
34
+ * // This example obtains the repository policy for the repository named ubuntu.
35
+ * const input = {
36
+ * "repositoryName": "ubuntu"
37
+ * };
38
+ * const command = new GetRepositoryPolicyCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"new statement\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::012345678901:role/CodeDeployDemo\"\n },\n\"Action\" : [ \"ecr:GetDownloadUrlForLayer\", \"ecr:BatchGetImage\", \"ecr:BatchCheckLayerAvailability\" ]\n } ]\n}",
43
+ * "registryId": "012345678901",
44
+ * "repositoryName": "ubuntu"
45
+ * }
46
+ * *\/
47
+ * // example id: getrepositorypolicy-example-1470867669211
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class GetRepositoryPolicyCommand extends $Command<GetRepositoryPolicyCommandInput, GetRepositoryPolicyCommandOutput, ECRClientResolvedConfig> {
34
52
  readonly input: GetRepositoryPolicyCommandInput;
package/dist-types/commands/ListImagesCommand.d.ts CHANGED
@@ -35,6 +35,27 @@ export interface ListImagesCommandOutput extends ListImagesResponse, __MetadataB
35
35
  * @see {@link ListImagesCommandOutput} for command's `response` shape.
36
36
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
37
37
  *
38
+ * @example To list all images in a repository
39
+ * ```javascript
40
+ * // This example lists all of the images in the repository named ubuntu in the default registry in the current account.
41
+ * const input = {
42
+ * "repositoryName": "ubuntu"
43
+ * };
44
+ * const command = new ListImagesCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "imageIds": [
49
+ * {
50
+ * "imageDigest": "sha256:764f63476bdff6d83a09ba2a818f0d35757063724a9ac3ba5019c56f74ebf42a",
51
+ * "imageTag": "precise"
52
+ * }
53
+ * ]
54
+ * }
55
+ * *\/
56
+ * // example id: listimages-example-1470868161594
57
+ * ```
58
+ *
38
59
  */
39
60
  export declare class ListImagesCommand extends $Command<ListImagesCommandInput, ListImagesCommandOutput, ECRClientResolvedConfig> {
40
61
  readonly input: ListImagesCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ecr",
3
3
  "description": "AWS SDK for JavaScript Ecr Client for Node.js, Browser and React Native",
4
- "version": "3.288.0",
4
+ "version": "3.289.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,39 +20,39 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.288.0",
24
- "@aws-sdk/config-resolver": "3.287.0",
25
- "@aws-sdk/credential-provider-node": "3.288.0",
26
- "@aws-sdk/fetch-http-handler": "3.282.0",
27
- "@aws-sdk/hash-node": "3.272.0",
28
- "@aws-sdk/invalid-dependency": "3.272.0",
29
- "@aws-sdk/middleware-content-length": "3.282.0",
30
- "@aws-sdk/middleware-endpoint": "3.282.0",
31
- "@aws-sdk/middleware-host-header": "3.282.0",
32
- "@aws-sdk/middleware-logger": "3.288.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
- "@aws-sdk/middleware-retry": "3.287.0",
35
- "@aws-sdk/middleware-serde": "3.272.0",
36
- "@aws-sdk/middleware-signing": "3.282.0",
37
- "@aws-sdk/middleware-stack": "3.272.0",
38
- "@aws-sdk/middleware-user-agent": "3.282.0",
39
- "@aws-sdk/node-config-provider": "3.287.0",
40
- "@aws-sdk/node-http-handler": "3.282.0",
41
- "@aws-sdk/protocol-http": "3.282.0",
42
- "@aws-sdk/smithy-client": "3.279.0",
43
- "@aws-sdk/types": "3.272.0",
44
- "@aws-sdk/url-parser": "3.272.0",
23
+ "@aws-sdk/client-sts": "3.289.0",
24
+ "@aws-sdk/config-resolver": "3.289.0",
25
+ "@aws-sdk/credential-provider-node": "3.289.0",
26
+ "@aws-sdk/fetch-http-handler": "3.289.0",
27
+ "@aws-sdk/hash-node": "3.289.0",
28
+ "@aws-sdk/invalid-dependency": "3.289.0",
29
+ "@aws-sdk/middleware-content-length": "3.289.0",
30
+ "@aws-sdk/middleware-endpoint": "3.289.0",
31
+ "@aws-sdk/middleware-host-header": "3.289.0",
32
+ "@aws-sdk/middleware-logger": "3.289.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.289.0",
34
+ "@aws-sdk/middleware-retry": "3.289.0",
35
+ "@aws-sdk/middleware-serde": "3.289.0",
36
+ "@aws-sdk/middleware-signing": "3.289.0",
37
+ "@aws-sdk/middleware-stack": "3.289.0",
38
+ "@aws-sdk/middleware-user-agent": "3.289.0",
39
+ "@aws-sdk/node-config-provider": "3.289.0",
40
+ "@aws-sdk/node-http-handler": "3.289.0",
41
+ "@aws-sdk/protocol-http": "3.289.0",
42
+ "@aws-sdk/smithy-client": "3.289.0",
43
+ "@aws-sdk/types": "3.289.0",
44
+ "@aws-sdk/url-parser": "3.289.0",
45
45
  "@aws-sdk/util-base64": "3.208.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.188.0",
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.279.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.287.0",
50
- "@aws-sdk/util-endpoints": "3.272.0",
51
- "@aws-sdk/util-retry": "3.272.0",
52
- "@aws-sdk/util-user-agent-browser": "3.282.0",
53
- "@aws-sdk/util-user-agent-node": "3.287.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.289.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.289.0",
50
+ "@aws-sdk/util-endpoints": "3.289.0",
51
+ "@aws-sdk/util-retry": "3.289.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.289.0",
53
+ "@aws-sdk/util-user-agent-node": "3.289.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
- "@aws-sdk/util-waiter": "3.272.0",
55
+ "@aws-sdk/util-waiter": "3.289.0",
56
56
  "tslib": "^2.3.1"
57
57
  },
58
58
  "devDependencies": {