@aws-sdk/client-ecr 3.315.0 → 3.316.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.
@@ -41,410 +41,265 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
41
41
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
42
42
  import { UploadLayerPartCommandInput, UploadLayerPartCommandOutput } from "./commands/UploadLayerPartCommand";
43
43
  import { ECRClient } from "./ECRClient";
44
- /**
45
- * @public
46
- * <fullname>Amazon Elastic Container Registry</fullname>
47
- * <p>Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the
48
- * familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR
49
- * provides a secure, scalable, and reliable registry for your Docker or Open Container
50
- * Initiative (OCI) images. Amazon ECR supports private repositories with resource-based
51
- * permissions using IAM so that specific users or Amazon EC2 instances can access
52
- * repositories and images.</p>
53
- * <p>Amazon ECR has service endpoints in each supported Region. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/ecr.html">Amazon ECR endpoints</a> in the
54
- * <i>Amazon Web Services General Reference</i>.</p>
55
- */
56
- export declare class ECR extends ECRClient {
57
- /**
58
- * @public
59
- * <p>Checks the availability of one or more image layers in a repository.</p>
60
- * <p>When an image is pushed to a repository, each image layer is checked to verify if it
61
- * has been uploaded before. If it has been uploaded, then the image layer is
62
- * skipped.</p>
63
- * <note>
64
- * <p>This operation is used by the Amazon ECR proxy and is not generally used by
65
- * customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p>
66
- * </note>
44
+ export interface ECR {
45
+ /**
46
+ * @see {@link BatchCheckLayerAvailabilityCommand}
67
47
  */
68
48
  batchCheckLayerAvailability(args: BatchCheckLayerAvailabilityCommandInput, options?: __HttpHandlerOptions): Promise<BatchCheckLayerAvailabilityCommandOutput>;
69
49
  batchCheckLayerAvailability(args: BatchCheckLayerAvailabilityCommandInput, cb: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void): void;
70
50
  batchCheckLayerAvailability(args: BatchCheckLayerAvailabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void): void;
71
51
  /**
72
- * @public
73
- * <p>Deletes a list of specified images within a repository. Images are specified with
74
- * either an <code>imageTag</code> or <code>imageDigest</code>.</p>
75
- * <p>You can remove a tag from an image by specifying the image's tag in your request. When
76
- * you remove the last tag from an image, the image is deleted from your repository.</p>
77
- * <p>You can completely delete an image (and all of its tags) by specifying the image's
78
- * digest in your request.</p>
52
+ * @see {@link BatchDeleteImageCommand}
79
53
  */
80
54
  batchDeleteImage(args: BatchDeleteImageCommandInput, options?: __HttpHandlerOptions): Promise<BatchDeleteImageCommandOutput>;
81
55
  batchDeleteImage(args: BatchDeleteImageCommandInput, cb: (err: any, data?: BatchDeleteImageCommandOutput) => void): void;
82
56
  batchDeleteImage(args: BatchDeleteImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteImageCommandOutput) => void): void;
83
57
  /**
84
- * @public
85
- * <p>Gets detailed information for an image. Images are specified with either an
86
- * <code>imageTag</code> or <code>imageDigest</code>.</p>
87
- * <p>When an image is pulled, the BatchGetImage API is called once to retrieve the image
88
- * manifest.</p>
58
+ * @see {@link BatchGetImageCommand}
89
59
  */
90
60
  batchGetImage(args: BatchGetImageCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetImageCommandOutput>;
91
61
  batchGetImage(args: BatchGetImageCommandInput, cb: (err: any, data?: BatchGetImageCommandOutput) => void): void;
92
62
  batchGetImage(args: BatchGetImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetImageCommandOutput) => void): void;
93
63
  /**
94
- * @public
95
- * <p>Gets the scanning configuration for one or more repositories.</p>
64
+ * @see {@link BatchGetRepositoryScanningConfigurationCommand}
96
65
  */
97
66
  batchGetRepositoryScanningConfiguration(args: BatchGetRepositoryScanningConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetRepositoryScanningConfigurationCommandOutput>;
98
67
  batchGetRepositoryScanningConfiguration(args: BatchGetRepositoryScanningConfigurationCommandInput, cb: (err: any, data?: BatchGetRepositoryScanningConfigurationCommandOutput) => void): void;
99
68
  batchGetRepositoryScanningConfiguration(args: BatchGetRepositoryScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetRepositoryScanningConfigurationCommandOutput) => void): void;
100
69
  /**
101
- * @public
102
- * <p>Informs Amazon ECR that the image layer upload has completed for a specified registry,
103
- * repository name, and upload ID. You can optionally provide a <code>sha256</code> digest
104
- * of the image layer for data validation purposes.</p>
105
- * <p>When an image is pushed, the CompleteLayerUpload API is called once per each new image
106
- * layer to verify that the upload has completed.</p>
107
- * <note>
108
- * <p>This operation is used by the Amazon ECR proxy and is not generally used by
109
- * customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p>
110
- * </note>
70
+ * @see {@link CompleteLayerUploadCommand}
111
71
  */
112
72
  completeLayerUpload(args: CompleteLayerUploadCommandInput, options?: __HttpHandlerOptions): Promise<CompleteLayerUploadCommandOutput>;
113
73
  completeLayerUpload(args: CompleteLayerUploadCommandInput, cb: (err: any, data?: CompleteLayerUploadCommandOutput) => void): void;
114
74
  completeLayerUpload(args: CompleteLayerUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteLayerUploadCommandOutput) => void): void;
115
75
  /**
116
- * @public
117
- * <p>Creates a pull through cache rule. A pull through cache rule provides a way to cache
118
- * images from an external public registry in your Amazon ECR private registry.</p>
76
+ * @see {@link CreatePullThroughCacheRuleCommand}
119
77
  */
120
78
  createPullThroughCacheRule(args: CreatePullThroughCacheRuleCommandInput, options?: __HttpHandlerOptions): Promise<CreatePullThroughCacheRuleCommandOutput>;
121
79
  createPullThroughCacheRule(args: CreatePullThroughCacheRuleCommandInput, cb: (err: any, data?: CreatePullThroughCacheRuleCommandOutput) => void): void;
122
80
  createPullThroughCacheRule(args: CreatePullThroughCacheRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePullThroughCacheRuleCommandOutput) => void): void;
123
81
  /**
124
- * @public
125
- * <p>Creates a repository. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html">Amazon ECR repositories</a> in the
126
- * <i>Amazon Elastic Container Registry User Guide</i>.</p>
82
+ * @see {@link CreateRepositoryCommand}
127
83
  */
128
84
  createRepository(args: CreateRepositoryCommandInput, options?: __HttpHandlerOptions): Promise<CreateRepositoryCommandOutput>;
129
85
  createRepository(args: CreateRepositoryCommandInput, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
130
86
  createRepository(args: CreateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
131
87
  /**
132
- * @public
133
- * <p>Deletes the lifecycle policy associated with the specified repository.</p>
88
+ * @see {@link DeleteLifecyclePolicyCommand}
134
89
  */
135
90
  deleteLifecyclePolicy(args: DeleteLifecyclePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLifecyclePolicyCommandOutput>;
136
91
  deleteLifecyclePolicy(args: DeleteLifecyclePolicyCommandInput, cb: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void): void;
137
92
  deleteLifecyclePolicy(args: DeleteLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void): void;
138
93
  /**
139
- * @public
140
- * <p>Deletes a pull through cache rule.</p>
94
+ * @see {@link DeletePullThroughCacheRuleCommand}
141
95
  */
142
96
  deletePullThroughCacheRule(args: DeletePullThroughCacheRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeletePullThroughCacheRuleCommandOutput>;
143
97
  deletePullThroughCacheRule(args: DeletePullThroughCacheRuleCommandInput, cb: (err: any, data?: DeletePullThroughCacheRuleCommandOutput) => void): void;
144
98
  deletePullThroughCacheRule(args: DeletePullThroughCacheRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePullThroughCacheRuleCommandOutput) => void): void;
145
99
  /**
146
- * @public
147
- * <p>Deletes the registry permissions policy.</p>
100
+ * @see {@link DeleteRegistryPolicyCommand}
148
101
  */
149
102
  deleteRegistryPolicy(args: DeleteRegistryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRegistryPolicyCommandOutput>;
150
103
  deleteRegistryPolicy(args: DeleteRegistryPolicyCommandInput, cb: (err: any, data?: DeleteRegistryPolicyCommandOutput) => void): void;
151
104
  deleteRegistryPolicy(args: DeleteRegistryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegistryPolicyCommandOutput) => void): void;
152
105
  /**
153
- * @public
154
- * <p>Deletes a repository. If the repository contains images, you must either delete all
155
- * images in the repository or use the <code>force</code> option to delete the
156
- * repository.</p>
106
+ * @see {@link DeleteRepositoryCommand}
157
107
  */
158
108
  deleteRepository(args: DeleteRepositoryCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRepositoryCommandOutput>;
159
109
  deleteRepository(args: DeleteRepositoryCommandInput, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void): void;
160
110
  deleteRepository(args: DeleteRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void): void;
161
111
  /**
162
- * @public
163
- * <p>Deletes the repository policy associated with the specified repository.</p>
112
+ * @see {@link DeleteRepositoryPolicyCommand}
164
113
  */
165
114
  deleteRepositoryPolicy(args: DeleteRepositoryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRepositoryPolicyCommandOutput>;
166
115
  deleteRepositoryPolicy(args: DeleteRepositoryPolicyCommandInput, cb: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void): void;
167
116
  deleteRepositoryPolicy(args: DeleteRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void): void;
168
117
  /**
169
- * @public
170
- * <p>Returns the replication status for a specified image.</p>
118
+ * @see {@link DescribeImageReplicationStatusCommand}
171
119
  */
172
120
  describeImageReplicationStatus(args: DescribeImageReplicationStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeImageReplicationStatusCommandOutput>;
173
121
  describeImageReplicationStatus(args: DescribeImageReplicationStatusCommandInput, cb: (err: any, data?: DescribeImageReplicationStatusCommandOutput) => void): void;
174
122
  describeImageReplicationStatus(args: DescribeImageReplicationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageReplicationStatusCommandOutput) => void): void;
175
123
  /**
176
- * @public
177
- * <p>Returns metadata about the images in a repository.</p>
178
- * <note>
179
- * <p>Beginning with Docker version 1.9, the Docker client compresses image layers
180
- * before pushing them to a V2 Docker registry. The output of the <code>docker
181
- * images</code> command shows the uncompressed image size, so it may return a
182
- * larger image size than the image sizes returned by <a>DescribeImages</a>.</p>
183
- * </note>
124
+ * @see {@link DescribeImagesCommand}
184
125
  */
185
126
  describeImages(args: DescribeImagesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeImagesCommandOutput>;
186
127
  describeImages(args: DescribeImagesCommandInput, cb: (err: any, data?: DescribeImagesCommandOutput) => void): void;
187
128
  describeImages(args: DescribeImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImagesCommandOutput) => void): void;
188
129
  /**
189
- * @public
190
- * <p>Returns the scan findings for the specified image.</p>
130
+ * @see {@link DescribeImageScanFindingsCommand}
191
131
  */
192
132
  describeImageScanFindings(args: DescribeImageScanFindingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeImageScanFindingsCommandOutput>;
193
133
  describeImageScanFindings(args: DescribeImageScanFindingsCommandInput, cb: (err: any, data?: DescribeImageScanFindingsCommandOutput) => void): void;
194
134
  describeImageScanFindings(args: DescribeImageScanFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageScanFindingsCommandOutput) => void): void;
195
135
  /**
196
- * @public
197
- * <p>Returns the pull through cache rules for a registry.</p>
136
+ * @see {@link DescribePullThroughCacheRulesCommand}
198
137
  */
199
138
  describePullThroughCacheRules(args: DescribePullThroughCacheRulesCommandInput, options?: __HttpHandlerOptions): Promise<DescribePullThroughCacheRulesCommandOutput>;
200
139
  describePullThroughCacheRules(args: DescribePullThroughCacheRulesCommandInput, cb: (err: any, data?: DescribePullThroughCacheRulesCommandOutput) => void): void;
201
140
  describePullThroughCacheRules(args: DescribePullThroughCacheRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePullThroughCacheRulesCommandOutput) => void): void;
202
141
  /**
203
- * @public
204
- * <p>Describes the settings for a registry. The replication configuration for a repository
205
- * can be created or updated with the <a>PutReplicationConfiguration</a> API
206
- * action.</p>
142
+ * @see {@link DescribeRegistryCommand}
207
143
  */
208
144
  describeRegistry(args: DescribeRegistryCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRegistryCommandOutput>;
209
145
  describeRegistry(args: DescribeRegistryCommandInput, cb: (err: any, data?: DescribeRegistryCommandOutput) => void): void;
210
146
  describeRegistry(args: DescribeRegistryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRegistryCommandOutput) => void): void;
211
147
  /**
212
- * @public
213
- * <p>Describes image repositories in a registry.</p>
148
+ * @see {@link DescribeRepositoriesCommand}
214
149
  */
215
150
  describeRepositories(args: DescribeRepositoriesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRepositoriesCommandOutput>;
216
151
  describeRepositories(args: DescribeRepositoriesCommandInput, cb: (err: any, data?: DescribeRepositoriesCommandOutput) => void): void;
217
152
  describeRepositories(args: DescribeRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRepositoriesCommandOutput) => void): void;
218
153
  /**
219
- * @public
220
- * <p>Retrieves an authorization token. An authorization token represents your IAM
221
- * authentication credentials and can be used to access any Amazon ECR registry that your IAM
222
- * principal has access to. The authorization token is valid for 12 hours.</p>
223
- * <p>The <code>authorizationToken</code> returned is a base64 encoded string that can be
224
- * decoded and used in a <code>docker login</code> command to authenticate to a registry.
225
- * The CLI offers an <code>get-login-password</code> command that simplifies the login
226
- * process. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth">Registry
227
- * authentication</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
154
+ * @see {@link GetAuthorizationTokenCommand}
228
155
  */
229
156
  getAuthorizationToken(args: GetAuthorizationTokenCommandInput, options?: __HttpHandlerOptions): Promise<GetAuthorizationTokenCommandOutput>;
230
157
  getAuthorizationToken(args: GetAuthorizationTokenCommandInput, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void): void;
231
158
  getAuthorizationToken(args: GetAuthorizationTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void): void;
232
159
  /**
233
- * @public
234
- * <p>Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can
235
- * only get URLs for image layers that are referenced in an image.</p>
236
- * <p>When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer
237
- * that is not already cached.</p>
238
- * <note>
239
- * <p>This operation is used by the Amazon ECR proxy and is not generally used by
240
- * customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p>
241
- * </note>
160
+ * @see {@link GetDownloadUrlForLayerCommand}
242
161
  */
243
162
  getDownloadUrlForLayer(args: GetDownloadUrlForLayerCommandInput, options?: __HttpHandlerOptions): Promise<GetDownloadUrlForLayerCommandOutput>;
244
163
  getDownloadUrlForLayer(args: GetDownloadUrlForLayerCommandInput, cb: (err: any, data?: GetDownloadUrlForLayerCommandOutput) => void): void;
245
164
  getDownloadUrlForLayer(args: GetDownloadUrlForLayerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDownloadUrlForLayerCommandOutput) => void): void;
246
165
  /**
247
- * @public
248
- * <p>Retrieves the lifecycle policy for the specified repository.</p>
166
+ * @see {@link GetLifecyclePolicyCommand}
249
167
  */
250
168
  getLifecyclePolicy(args: GetLifecyclePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetLifecyclePolicyCommandOutput>;
251
169
  getLifecyclePolicy(args: GetLifecyclePolicyCommandInput, cb: (err: any, data?: GetLifecyclePolicyCommandOutput) => void): void;
252
170
  getLifecyclePolicy(args: GetLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLifecyclePolicyCommandOutput) => void): void;
253
171
  /**
254
- * @public
255
- * <p>Retrieves the results of the lifecycle policy preview request for the specified
256
- * repository.</p>
172
+ * @see {@link GetLifecyclePolicyPreviewCommand}
257
173
  */
258
174
  getLifecyclePolicyPreview(args: GetLifecyclePolicyPreviewCommandInput, options?: __HttpHandlerOptions): Promise<GetLifecyclePolicyPreviewCommandOutput>;
259
175
  getLifecyclePolicyPreview(args: GetLifecyclePolicyPreviewCommandInput, cb: (err: any, data?: GetLifecyclePolicyPreviewCommandOutput) => void): void;
260
176
  getLifecyclePolicyPreview(args: GetLifecyclePolicyPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLifecyclePolicyPreviewCommandOutput) => void): void;
261
177
  /**
262
- * @public
263
- * <p>Retrieves the permissions policy for a registry.</p>
178
+ * @see {@link GetRegistryPolicyCommand}
264
179
  */
265
180
  getRegistryPolicy(args: GetRegistryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetRegistryPolicyCommandOutput>;
266
181
  getRegistryPolicy(args: GetRegistryPolicyCommandInput, cb: (err: any, data?: GetRegistryPolicyCommandOutput) => void): void;
267
182
  getRegistryPolicy(args: GetRegistryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegistryPolicyCommandOutput) => void): void;
268
183
  /**
269
- * @public
270
- * <p>Retrieves the scanning configuration for a registry.</p>
184
+ * @see {@link GetRegistryScanningConfigurationCommand}
271
185
  */
272
186
  getRegistryScanningConfiguration(args: GetRegistryScanningConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetRegistryScanningConfigurationCommandOutput>;
273
187
  getRegistryScanningConfiguration(args: GetRegistryScanningConfigurationCommandInput, cb: (err: any, data?: GetRegistryScanningConfigurationCommandOutput) => void): void;
274
188
  getRegistryScanningConfiguration(args: GetRegistryScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegistryScanningConfigurationCommandOutput) => void): void;
275
189
  /**
276
- * @public
277
- * <p>Retrieves the repository policy for the specified repository.</p>
190
+ * @see {@link GetRepositoryPolicyCommand}
278
191
  */
279
192
  getRepositoryPolicy(args: GetRepositoryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetRepositoryPolicyCommandOutput>;
280
193
  getRepositoryPolicy(args: GetRepositoryPolicyCommandInput, cb: (err: any, data?: GetRepositoryPolicyCommandOutput) => void): void;
281
194
  getRepositoryPolicy(args: GetRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryPolicyCommandOutput) => void): void;
282
195
  /**
283
- * @public
284
- * <p>Notifies Amazon ECR that you intend to upload an image layer.</p>
285
- * <p>When an image is pushed, the InitiateLayerUpload API is called once per image layer
286
- * that has not already been uploaded. Whether or not an image layer has been uploaded is
287
- * determined by the BatchCheckLayerAvailability API action.</p>
288
- * <note>
289
- * <p>This operation is used by the Amazon ECR proxy and is not generally used by
290
- * customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p>
291
- * </note>
196
+ * @see {@link InitiateLayerUploadCommand}
292
197
  */
293
198
  initiateLayerUpload(args: InitiateLayerUploadCommandInput, options?: __HttpHandlerOptions): Promise<InitiateLayerUploadCommandOutput>;
294
199
  initiateLayerUpload(args: InitiateLayerUploadCommandInput, cb: (err: any, data?: InitiateLayerUploadCommandOutput) => void): void;
295
200
  initiateLayerUpload(args: InitiateLayerUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateLayerUploadCommandOutput) => void): void;
296
201
  /**
297
- * @public
298
- * <p>Lists all the image IDs for the specified repository.</p>
299
- * <p>You can filter images based on whether or not they are tagged by using the
300
- * <code>tagStatus</code> filter and specifying either <code>TAGGED</code>,
301
- * <code>UNTAGGED</code> or <code>ANY</code>. For example, you can filter your results
302
- * to return only <code>UNTAGGED</code> images and then pipe that result to a <a>BatchDeleteImage</a> operation to delete them. Or, you can filter your
303
- * results to return only <code>TAGGED</code> images to list all of the tags in your
304
- * repository.</p>
202
+ * @see {@link ListImagesCommand}
305
203
  */
306
204
  listImages(args: ListImagesCommandInput, options?: __HttpHandlerOptions): Promise<ListImagesCommandOutput>;
307
205
  listImages(args: ListImagesCommandInput, cb: (err: any, data?: ListImagesCommandOutput) => void): void;
308
206
  listImages(args: ListImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagesCommandOutput) => void): void;
309
207
  /**
310
- * @public
311
- * <p>List the tags for an Amazon ECR resource.</p>
208
+ * @see {@link ListTagsForResourceCommand}
312
209
  */
313
210
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
314
211
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
315
212
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
316
213
  /**
317
- * @public
318
- * <p>Creates or updates the image manifest and tags associated with an image.</p>
319
- * <p>When an image is pushed and all new image layers have been uploaded, the PutImage API
320
- * is called once to create or update the image manifest and the tags associated with the
321
- * image.</p>
322
- *
323
- * <note>
324
- * <p>This operation is used by the Amazon ECR proxy and is not generally used by
325
- * customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p>
326
- * </note>
214
+ * @see {@link PutImageCommand}
327
215
  */
328
216
  putImage(args: PutImageCommandInput, options?: __HttpHandlerOptions): Promise<PutImageCommandOutput>;
329
217
  putImage(args: PutImageCommandInput, cb: (err: any, data?: PutImageCommandOutput) => void): void;
330
218
  putImage(args: PutImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageCommandOutput) => void): void;
331
219
  /**
332
- * @public
333
- * <important>
334
- * <p>The <code>PutImageScanningConfiguration</code> API is being deprecated, in favor
335
- * of specifying the image scanning configuration at the registry level. For more
336
- * information, see <a>PutRegistryScanningConfiguration</a>.</p>
337
- * </important>
338
- * <p>Updates the image scanning configuration for the specified repository.</p>
220
+ * @see {@link PutImageScanningConfigurationCommand}
339
221
  */
340
222
  putImageScanningConfiguration(args: PutImageScanningConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutImageScanningConfigurationCommandOutput>;
341
223
  putImageScanningConfiguration(args: PutImageScanningConfigurationCommandInput, cb: (err: any, data?: PutImageScanningConfigurationCommandOutput) => void): void;
342
224
  putImageScanningConfiguration(args: PutImageScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageScanningConfigurationCommandOutput) => void): void;
343
225
  /**
344
- * @public
345
- * <p>Updates the image tag mutability settings for the specified repository. For more
346
- * information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html">Image tag
347
- * mutability</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
226
+ * @see {@link PutImageTagMutabilityCommand}
348
227
  */
349
228
  putImageTagMutability(args: PutImageTagMutabilityCommandInput, options?: __HttpHandlerOptions): Promise<PutImageTagMutabilityCommandOutput>;
350
229
  putImageTagMutability(args: PutImageTagMutabilityCommandInput, cb: (err: any, data?: PutImageTagMutabilityCommandOutput) => void): void;
351
230
  putImageTagMutability(args: PutImageTagMutabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageTagMutabilityCommandOutput) => void): void;
352
231
  /**
353
- * @public
354
- * <p>Creates or updates the lifecycle policy for the specified repository. For more
355
- * information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html">Lifecycle policy
356
- * template</a>.</p>
232
+ * @see {@link PutLifecyclePolicyCommand}
357
233
  */
358
234
  putLifecyclePolicy(args: PutLifecyclePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutLifecyclePolicyCommandOutput>;
359
235
  putLifecyclePolicy(args: PutLifecyclePolicyCommandInput, cb: (err: any, data?: PutLifecyclePolicyCommandOutput) => void): void;
360
236
  putLifecyclePolicy(args: PutLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLifecyclePolicyCommandOutput) => void): void;
361
237
  /**
362
- * @public
363
- * <p>Creates or updates the permissions policy for your registry.</p>
364
- * <p>A registry policy is used to specify permissions for another Amazon Web Services account and is used
365
- * when configuring cross-account replication. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html">Registry permissions</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
238
+ * @see {@link PutRegistryPolicyCommand}
366
239
  */
367
240
  putRegistryPolicy(args: PutRegistryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutRegistryPolicyCommandOutput>;
368
241
  putRegistryPolicy(args: PutRegistryPolicyCommandInput, cb: (err: any, data?: PutRegistryPolicyCommandOutput) => void): void;
369
242
  putRegistryPolicy(args: PutRegistryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRegistryPolicyCommandOutput) => void): void;
370
243
  /**
371
- * @public
372
- * <p>Creates or updates the scanning configuration for your private registry.</p>
244
+ * @see {@link PutRegistryScanningConfigurationCommand}
373
245
  */
374
246
  putRegistryScanningConfiguration(args: PutRegistryScanningConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutRegistryScanningConfigurationCommandOutput>;
375
247
  putRegistryScanningConfiguration(args: PutRegistryScanningConfigurationCommandInput, cb: (err: any, data?: PutRegistryScanningConfigurationCommandOutput) => void): void;
376
248
  putRegistryScanningConfiguration(args: PutRegistryScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRegistryScanningConfigurationCommandOutput) => void): void;
377
249
  /**
378
- * @public
379
- * <p>Creates or updates the replication configuration for a registry. The existing
380
- * replication configuration for a repository can be retrieved with the <a>DescribeRegistry</a> API action. The first time the
381
- * PutReplicationConfiguration API is called, a service-linked IAM role is created in
382
- * your account for the replication process. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html">Using
383
- * service-linked roles for Amazon ECR</a> in the
384
- * <i>Amazon Elastic Container Registry User Guide</i>.</p>
385
- * <note>
386
- * <p>When configuring cross-account replication, the destination account must grant the
387
- * source account permission to replicate. This permission is controlled using a
388
- * registry permissions policy. For more information, see <a>PutRegistryPolicy</a>.</p>
389
- * </note>
250
+ * @see {@link PutReplicationConfigurationCommand}
390
251
  */
391
252
  putReplicationConfiguration(args: PutReplicationConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutReplicationConfigurationCommandOutput>;
392
253
  putReplicationConfiguration(args: PutReplicationConfigurationCommandInput, cb: (err: any, data?: PutReplicationConfigurationCommandOutput) => void): void;
393
254
  putReplicationConfiguration(args: PutReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutReplicationConfigurationCommandOutput) => void): void;
394
255
  /**
395
- * @public
396
- * <p>Applies a repository policy to the specified repository to control access permissions.
397
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html">Amazon ECR Repository
398
- * policies</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
256
+ * @see {@link SetRepositoryPolicyCommand}
399
257
  */
400
258
  setRepositoryPolicy(args: SetRepositoryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<SetRepositoryPolicyCommandOutput>;
401
259
  setRepositoryPolicy(args: SetRepositoryPolicyCommandInput, cb: (err: any, data?: SetRepositoryPolicyCommandOutput) => void): void;
402
260
  setRepositoryPolicy(args: SetRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetRepositoryPolicyCommandOutput) => void): void;
403
261
  /**
404
- * @public
405
- * <p>Starts an image vulnerability scan. An image scan can only be started once per 24
406
- * hours on an individual image. This limit includes if an image was scanned on initial
407
- * push. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html">Image scanning</a> in the
408
- * <i>Amazon Elastic Container Registry User Guide</i>.</p>
262
+ * @see {@link StartImageScanCommand}
409
263
  */
410
264
  startImageScan(args: StartImageScanCommandInput, options?: __HttpHandlerOptions): Promise<StartImageScanCommandOutput>;
411
265
  startImageScan(args: StartImageScanCommandInput, cb: (err: any, data?: StartImageScanCommandOutput) => void): void;
412
266
  startImageScan(args: StartImageScanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImageScanCommandOutput) => void): void;
413
267
  /**
414
- * @public
415
- * <p>Starts a preview of a lifecycle policy for the specified repository. This allows you
416
- * to see the results before associating the lifecycle policy with the repository.</p>
268
+ * @see {@link StartLifecyclePolicyPreviewCommand}
417
269
  */
418
270
  startLifecyclePolicyPreview(args: StartLifecyclePolicyPreviewCommandInput, options?: __HttpHandlerOptions): Promise<StartLifecyclePolicyPreviewCommandOutput>;
419
271
  startLifecyclePolicyPreview(args: StartLifecyclePolicyPreviewCommandInput, cb: (err: any, data?: StartLifecyclePolicyPreviewCommandOutput) => void): void;
420
272
  startLifecyclePolicyPreview(args: StartLifecyclePolicyPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLifecyclePolicyPreviewCommandOutput) => void): void;
421
273
  /**
422
- * @public
423
- * <p>Adds specified tags to a resource with the specified ARN. Existing tags on a resource
424
- * are not changed if they are not specified in the request parameters.</p>
274
+ * @see {@link TagResourceCommand}
425
275
  */
426
276
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
427
277
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
428
278
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
429
279
  /**
430
- * @public
431
- * <p>Deletes specified tags from a resource.</p>
280
+ * @see {@link UntagResourceCommand}
432
281
  */
433
282
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
434
283
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
435
284
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
436
285
  /**
437
- * @public
438
- * <p>Uploads an image layer part to Amazon ECR.</p>
439
- * <p>When an image is pushed, each new image layer is uploaded in parts. The maximum size
440
- * of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API
441
- * is called once per each new image layer part.</p>
442
- * <note>
443
- * <p>This operation is used by the Amazon ECR proxy and is not generally used by
444
- * customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p>
445
- * </note>
286
+ * @see {@link UploadLayerPartCommand}
446
287
  */
447
288
  uploadLayerPart(args: UploadLayerPartCommandInput, options?: __HttpHandlerOptions): Promise<UploadLayerPartCommandOutput>;
448
289
  uploadLayerPart(args: UploadLayerPartCommandInput, cb: (err: any, data?: UploadLayerPartCommandOutput) => void): void;
449
290
  uploadLayerPart(args: UploadLayerPartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadLayerPartCommandOutput) => void): void;
450
291
  }
292
+ /**
293
+ * @public
294
+ * <fullname>Amazon Elastic Container Registry</fullname>
295
+ * <p>Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the
296
+ * familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR
297
+ * provides a secure, scalable, and reliable registry for your Docker or Open Container
298
+ * Initiative (OCI) images. Amazon ECR supports private repositories with resource-based
299
+ * permissions using IAM so that specific users or Amazon EC2 instances can access
300
+ * repositories and images.</p>
301
+ * <p>Amazon ECR has service endpoints in each supported Region. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/ecr.html">Amazon ECR endpoints</a> in the
302
+ * <i>Amazon Web Services General Reference</i>.</p>
303
+ */
304
+ export declare class ECR extends ECRClient implements ECR {
305
+ }
@@ -164,7 +164,7 @@ import {
164
164
  UploadLayerPartCommandOutput,
165
165
  } from "./commands/UploadLayerPartCommand";
166
166
  import { ECRClient } from "./ECRClient";
167
- export declare class ECR extends ECRClient {
167
+ export interface ECR {
168
168
  batchCheckLayerAvailability(
169
169
  args: BatchCheckLayerAvailabilityCommandInput,
170
170
  options?: __HttpHandlerOptions
@@ -705,3 +705,4 @@ export declare class ECR extends ECRClient {
705
705
  cb: (err: any, data?: UploadLayerPartCommandOutput) => void
706
706
  ): void;
707
707
  }
708
+ export declare class ECR extends ECRClient implements ECR {}
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.315.0",
4
+ "version": "3.316.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",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.315.0",
24
+ "@aws-sdk/client-sts": "3.316.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.315.0",
26
+ "@aws-sdk/credential-provider-node": "3.316.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -40,14 +40,14 @@
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.315.0",
43
+ "@aws-sdk/smithy-client": "3.316.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.315.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.315.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.316.0",
51
51
  "@aws-sdk/util-endpoints": "3.310.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",