UNPKG

55.5 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class ECR extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: ECR.Types.ClientConfiguration)
13 config: Config & ECR.Types.ClientConfiguration;
14 /**
15 * Check the availability of multiple image layers in a specified registry and repository. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
16 */
17 batchCheckLayerAvailability(params: ECR.Types.BatchCheckLayerAvailabilityRequest, callback?: (err: AWSError, data: ECR.Types.BatchCheckLayerAvailabilityResponse) => void): Request<ECR.Types.BatchCheckLayerAvailabilityResponse, AWSError>;
18 /**
19 * Check the availability of multiple image layers in a specified registry and repository. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
20 */
21 batchCheckLayerAvailability(callback?: (err: AWSError, data: ECR.Types.BatchCheckLayerAvailabilityResponse) => void): Request<ECR.Types.BatchCheckLayerAvailabilityResponse, AWSError>;
22 /**
23 * Deletes a list of specified images within a specified repository. Images are specified with either imageTag or imageDigest. You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository. You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
24 */
25 batchDeleteImage(params: ECR.Types.BatchDeleteImageRequest, callback?: (err: AWSError, data: ECR.Types.BatchDeleteImageResponse) => void): Request<ECR.Types.BatchDeleteImageResponse, AWSError>;
26 /**
27 * Deletes a list of specified images within a specified repository. Images are specified with either imageTag or imageDigest. You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository. You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
28 */
29 batchDeleteImage(callback?: (err: AWSError, data: ECR.Types.BatchDeleteImageResponse) => void): Request<ECR.Types.BatchDeleteImageResponse, AWSError>;
30 /**
31 * Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest.
32 */
33 batchGetImage(params: ECR.Types.BatchGetImageRequest, callback?: (err: AWSError, data: ECR.Types.BatchGetImageResponse) => void): Request<ECR.Types.BatchGetImageResponse, AWSError>;
34 /**
35 * Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest.
36 */
37 batchGetImage(callback?: (err: AWSError, data: ECR.Types.BatchGetImageResponse) => void): Request<ECR.Types.BatchGetImageResponse, AWSError>;
38 /**
39 * Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
40 */
41 completeLayerUpload(params: ECR.Types.CompleteLayerUploadRequest, callback?: (err: AWSError, data: ECR.Types.CompleteLayerUploadResponse) => void): Request<ECR.Types.CompleteLayerUploadResponse, AWSError>;
42 /**
43 * Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
44 */
45 completeLayerUpload(callback?: (err: AWSError, data: ECR.Types.CompleteLayerUploadResponse) => void): Request<ECR.Types.CompleteLayerUploadResponse, AWSError>;
46 /**
47 * Creates an image repository.
48 */
49 createRepository(params: ECR.Types.CreateRepositoryRequest, callback?: (err: AWSError, data: ECR.Types.CreateRepositoryResponse) => void): Request<ECR.Types.CreateRepositoryResponse, AWSError>;
50 /**
51 * Creates an image repository.
52 */
53 createRepository(callback?: (err: AWSError, data: ECR.Types.CreateRepositoryResponse) => void): Request<ECR.Types.CreateRepositoryResponse, AWSError>;
54 /**
55 * Deletes the specified lifecycle policy.
56 */
57 deleteLifecyclePolicy(params: ECR.Types.DeleteLifecyclePolicyRequest, callback?: (err: AWSError, data: ECR.Types.DeleteLifecyclePolicyResponse) => void): Request<ECR.Types.DeleteLifecyclePolicyResponse, AWSError>;
58 /**
59 * Deletes the specified lifecycle policy.
60 */
61 deleteLifecyclePolicy(callback?: (err: AWSError, data: ECR.Types.DeleteLifecyclePolicyResponse) => void): Request<ECR.Types.DeleteLifecyclePolicyResponse, AWSError>;
62 /**
63 * Deletes an existing image repository. If a repository contains images, you must use the force option to delete it.
64 */
65 deleteRepository(params: ECR.Types.DeleteRepositoryRequest, callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryResponse) => void): Request<ECR.Types.DeleteRepositoryResponse, AWSError>;
66 /**
67 * Deletes an existing image repository. If a repository contains images, you must use the force option to delete it.
68 */
69 deleteRepository(callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryResponse) => void): Request<ECR.Types.DeleteRepositoryResponse, AWSError>;
70 /**
71 * Deletes the repository policy from a specified repository.
72 */
73 deleteRepositoryPolicy(params: ECR.Types.DeleteRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryPolicyResponse) => void): Request<ECR.Types.DeleteRepositoryPolicyResponse, AWSError>;
74 /**
75 * Deletes the repository policy from a specified repository.
76 */
77 deleteRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryPolicyResponse) => void): Request<ECR.Types.DeleteRepositoryPolicyResponse, AWSError>;
78 /**
79 * Returns metadata about the images in a repository, including image size, image tags, and creation date. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
80 */
81 describeImages(params: ECR.Types.DescribeImagesRequest, callback?: (err: AWSError, data: ECR.Types.DescribeImagesResponse) => void): Request<ECR.Types.DescribeImagesResponse, AWSError>;
82 /**
83 * Returns metadata about the images in a repository, including image size, image tags, and creation date. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
84 */
85 describeImages(callback?: (err: AWSError, data: ECR.Types.DescribeImagesResponse) => void): Request<ECR.Types.DescribeImagesResponse, AWSError>;
86 /**
87 * Describes image repositories in a registry.
88 */
89 describeRepositories(params: ECR.Types.DescribeRepositoriesRequest, callback?: (err: AWSError, data: ECR.Types.DescribeRepositoriesResponse) => void): Request<ECR.Types.DescribeRepositoriesResponse, AWSError>;
90 /**
91 * Describes image repositories in a registry.
92 */
93 describeRepositories(callback?: (err: AWSError, data: ECR.Types.DescribeRepositoriesResponse) => void): Request<ECR.Types.DescribeRepositoriesResponse, AWSError>;
94 /**
95 * Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed. The authorizationToken returned for each registry specified is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an aws ecr get-login command that simplifies the login process.
96 */
97 getAuthorizationToken(params: ECR.Types.GetAuthorizationTokenRequest, callback?: (err: AWSError, data: ECR.Types.GetAuthorizationTokenResponse) => void): Request<ECR.Types.GetAuthorizationTokenResponse, AWSError>;
98 /**
99 * Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed. The authorizationToken returned for each registry specified is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an aws ecr get-login command that simplifies the login process.
100 */
101 getAuthorizationToken(callback?: (err: AWSError, data: ECR.Types.GetAuthorizationTokenResponse) => void): Request<ECR.Types.GetAuthorizationTokenResponse, AWSError>;
102 /**
103 * Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
104 */
105 getDownloadUrlForLayer(params: ECR.Types.GetDownloadUrlForLayerRequest, callback?: (err: AWSError, data: ECR.Types.GetDownloadUrlForLayerResponse) => void): Request<ECR.Types.GetDownloadUrlForLayerResponse, AWSError>;
106 /**
107 * Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
108 */
109 getDownloadUrlForLayer(callback?: (err: AWSError, data: ECR.Types.GetDownloadUrlForLayerResponse) => void): Request<ECR.Types.GetDownloadUrlForLayerResponse, AWSError>;
110 /**
111 * Retrieves the specified lifecycle policy.
112 */
113 getLifecyclePolicy(params: ECR.Types.GetLifecyclePolicyRequest, callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyResponse) => void): Request<ECR.Types.GetLifecyclePolicyResponse, AWSError>;
114 /**
115 * Retrieves the specified lifecycle policy.
116 */
117 getLifecyclePolicy(callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyResponse) => void): Request<ECR.Types.GetLifecyclePolicyResponse, AWSError>;
118 /**
119 * Retrieves the results of the specified lifecycle policy preview request.
120 */
121 getLifecyclePolicyPreview(params: ECR.Types.GetLifecyclePolicyPreviewRequest, callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyPreviewResponse) => void): Request<ECR.Types.GetLifecyclePolicyPreviewResponse, AWSError>;
122 /**
123 * Retrieves the results of the specified lifecycle policy preview request.
124 */
125 getLifecyclePolicyPreview(callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyPreviewResponse) => void): Request<ECR.Types.GetLifecyclePolicyPreviewResponse, AWSError>;
126 /**
127 * Retrieves the repository policy for a specified repository.
128 */
129 getRepositoryPolicy(params: ECR.Types.GetRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.GetRepositoryPolicyResponse) => void): Request<ECR.Types.GetRepositoryPolicyResponse, AWSError>;
130 /**
131 * Retrieves the repository policy for a specified repository.
132 */
133 getRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.GetRepositoryPolicyResponse) => void): Request<ECR.Types.GetRepositoryPolicyResponse, AWSError>;
134 /**
135 * Notify Amazon ECR that you intend to upload an image layer. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
136 */
137 initiateLayerUpload(params: ECR.Types.InitiateLayerUploadRequest, callback?: (err: AWSError, data: ECR.Types.InitiateLayerUploadResponse) => void): Request<ECR.Types.InitiateLayerUploadResponse, AWSError>;
138 /**
139 * Notify Amazon ECR that you intend to upload an image layer. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
140 */
141 initiateLayerUpload(callback?: (err: AWSError, data: ECR.Types.InitiateLayerUploadResponse) => void): Request<ECR.Types.InitiateLayerUploadResponse, AWSError>;
142 /**
143 * Lists all the image IDs for a given repository. You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.
144 */
145 listImages(params: ECR.Types.ListImagesRequest, callback?: (err: AWSError, data: ECR.Types.ListImagesResponse) => void): Request<ECR.Types.ListImagesResponse, AWSError>;
146 /**
147 * Lists all the image IDs for a given repository. You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.
148 */
149 listImages(callback?: (err: AWSError, data: ECR.Types.ListImagesResponse) => void): Request<ECR.Types.ListImagesResponse, AWSError>;
150 /**
151 * List the tags for an Amazon ECR resource.
152 */
153 listTagsForResource(params: ECR.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ECR.Types.ListTagsForResourceResponse) => void): Request<ECR.Types.ListTagsForResourceResponse, AWSError>;
154 /**
155 * List the tags for an Amazon ECR resource.
156 */
157 listTagsForResource(callback?: (err: AWSError, data: ECR.Types.ListTagsForResourceResponse) => void): Request<ECR.Types.ListTagsForResourceResponse, AWSError>;
158 /**
159 * Creates or updates the image manifest and tags associated with an image. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
160 */
161 putImage(params: ECR.Types.PutImageRequest, callback?: (err: AWSError, data: ECR.Types.PutImageResponse) => void): Request<ECR.Types.PutImageResponse, AWSError>;
162 /**
163 * Creates or updates the image manifest and tags associated with an image. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
164 */
165 putImage(callback?: (err: AWSError, data: ECR.Types.PutImageResponse) => void): Request<ECR.Types.PutImageResponse, AWSError>;
166 /**
167 * Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template.
168 */
169 putLifecyclePolicy(params: ECR.Types.PutLifecyclePolicyRequest, callback?: (err: AWSError, data: ECR.Types.PutLifecyclePolicyResponse) => void): Request<ECR.Types.PutLifecyclePolicyResponse, AWSError>;
170 /**
171 * Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template.
172 */
173 putLifecyclePolicy(callback?: (err: AWSError, data: ECR.Types.PutLifecyclePolicyResponse) => void): Request<ECR.Types.PutLifecyclePolicyResponse, AWSError>;
174 /**
175 * Applies a repository policy on a specified repository to control access permissions.
176 */
177 setRepositoryPolicy(params: ECR.Types.SetRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.SetRepositoryPolicyResponse) => void): Request<ECR.Types.SetRepositoryPolicyResponse, AWSError>;
178 /**
179 * Applies a repository policy on a specified repository to control access permissions.
180 */
181 setRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.SetRepositoryPolicyResponse) => void): Request<ECR.Types.SetRepositoryPolicyResponse, AWSError>;
182 /**
183 * Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.
184 */
185 startLifecyclePolicyPreview(params: ECR.Types.StartLifecyclePolicyPreviewRequest, callback?: (err: AWSError, data: ECR.Types.StartLifecyclePolicyPreviewResponse) => void): Request<ECR.Types.StartLifecyclePolicyPreviewResponse, AWSError>;
186 /**
187 * Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.
188 */
189 startLifecyclePolicyPreview(callback?: (err: AWSError, data: ECR.Types.StartLifecyclePolicyPreviewResponse) => void): Request<ECR.Types.StartLifecyclePolicyPreviewResponse, AWSError>;
190 /**
191 * Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
192 */
193 tagResource(params: ECR.Types.TagResourceRequest, callback?: (err: AWSError, data: ECR.Types.TagResourceResponse) => void): Request<ECR.Types.TagResourceResponse, AWSError>;
194 /**
195 * Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
196 */
197 tagResource(callback?: (err: AWSError, data: ECR.Types.TagResourceResponse) => void): Request<ECR.Types.TagResourceResponse, AWSError>;
198 /**
199 * Deletes specified tags from a resource.
200 */
201 untagResource(params: ECR.Types.UntagResourceRequest, callback?: (err: AWSError, data: ECR.Types.UntagResourceResponse) => void): Request<ECR.Types.UntagResourceResponse, AWSError>;
202 /**
203 * Deletes specified tags from a resource.
204 */
205 untagResource(callback?: (err: AWSError, data: ECR.Types.UntagResourceResponse) => void): Request<ECR.Types.UntagResourceResponse, AWSError>;
206 /**
207 * Uploads an image layer part to Amazon ECR. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
208 */
209 uploadLayerPart(params: ECR.Types.UploadLayerPartRequest, callback?: (err: AWSError, data: ECR.Types.UploadLayerPartResponse) => void): Request<ECR.Types.UploadLayerPartResponse, AWSError>;
210 /**
211 * Uploads an image layer part to Amazon ECR. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
212 */
213 uploadLayerPart(callback?: (err: AWSError, data: ECR.Types.UploadLayerPartResponse) => void): Request<ECR.Types.UploadLayerPartResponse, AWSError>;
214}
215declare namespace ECR {
216 export type Arn = string;
217 export interface AuthorizationData {
218 /**
219 * A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format user:password for private registry authentication using docker login.
220 */
221 authorizationToken?: Base64;
222 /**
223 * The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.
224 */
225 expiresAt?: ExpirationTimestamp;
226 /**
227 * The registry URL to use for this authorization token in a docker login command. The Amazon ECR registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example, https://012345678910.dkr.ecr.us-east-1.amazonaws.com..
228 */
229 proxyEndpoint?: ProxyEndpoint;
230 }
231 export type AuthorizationDataList = AuthorizationData[];
232 export type Base64 = string;
233 export interface BatchCheckLayerAvailabilityRequest {
234 /**
235 * The AWS account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed.
236 */
237 registryId?: RegistryId;
238 /**
239 * The name of the repository that is associated with the image layers to check.
240 */
241 repositoryName: RepositoryName;
242 /**
243 * The digests of the image layers to check.
244 */
245 layerDigests: BatchedOperationLayerDigestList;
246 }
247 export interface BatchCheckLayerAvailabilityResponse {
248 /**
249 * A list of image layer objects corresponding to the image layer references in the request.
250 */
251 layers?: LayerList;
252 /**
253 * Any failures associated with the call.
254 */
255 failures?: LayerFailureList;
256 }
257 export interface BatchDeleteImageRequest {
258 /**
259 * The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.
260 */
261 registryId?: RegistryId;
262 /**
263 * The repository that contains the image to delete.
264 */
265 repositoryName: RepositoryName;
266 /**
267 * A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.
268 */
269 imageIds: ImageIdentifierList;
270 }
271 export interface BatchDeleteImageResponse {
272 /**
273 * The image IDs of the deleted images.
274 */
275 imageIds?: ImageIdentifierList;
276 /**
277 * Any failures associated with the call.
278 */
279 failures?: ImageFailureList;
280 }
281 export interface BatchGetImageRequest {
282 /**
283 * The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.
284 */
285 registryId?: RegistryId;
286 /**
287 * The repository that contains the images to describe.
288 */
289 repositoryName: RepositoryName;
290 /**
291 * A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.
292 */
293 imageIds: ImageIdentifierList;
294 /**
295 * The accepted media types for the request. Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json
296 */
297 acceptedMediaTypes?: MediaTypeList;
298 }
299 export interface BatchGetImageResponse {
300 /**
301 * A list of image objects corresponding to the image references in the request.
302 */
303 images?: ImageList;
304 /**
305 * Any failures associated with the call.
306 */
307 failures?: ImageFailureList;
308 }
309 export type BatchedOperationLayerDigest = string;
310 export type BatchedOperationLayerDigestList = BatchedOperationLayerDigest[];
311 export interface CompleteLayerUploadRequest {
312 /**
313 * The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.
314 */
315 registryId?: RegistryId;
316 /**
317 * The name of the repository to associate with the image layer.
318 */
319 repositoryName: RepositoryName;
320 /**
321 * The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.
322 */
323 uploadId: UploadId;
324 /**
325 * The sha256 digest of the image layer.
326 */
327 layerDigests: LayerDigestList;
328 }
329 export interface CompleteLayerUploadResponse {
330 /**
331 * The registry ID associated with the request.
332 */
333 registryId?: RegistryId;
334 /**
335 * The repository name associated with the request.
336 */
337 repositoryName?: RepositoryName;
338 /**
339 * The upload ID associated with the layer.
340 */
341 uploadId?: UploadId;
342 /**
343 * The sha256 digest of the image layer.
344 */
345 layerDigest?: LayerDigest;
346 }
347 export interface CreateRepositoryRequest {
348 /**
349 * The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).
350 */
351 repositoryName: RepositoryName;
352 /**
353 *
354 */
355 tags?: TagList;
356 }
357 export interface CreateRepositoryResponse {
358 /**
359 * The repository that was created.
360 */
361 repository?: Repository;
362 }
363 export type CreationTimestamp = Date;
364 export interface DeleteLifecyclePolicyRequest {
365 /**
366 * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
367 */
368 registryId?: RegistryId;
369 /**
370 * The name of the repository.
371 */
372 repositoryName: RepositoryName;
373 }
374 export interface DeleteLifecyclePolicyResponse {
375 /**
376 * The registry ID associated with the request.
377 */
378 registryId?: RegistryId;
379 /**
380 * The repository name associated with the request.
381 */
382 repositoryName?: RepositoryName;
383 /**
384 * The JSON lifecycle policy text.
385 */
386 lifecyclePolicyText?: LifecyclePolicyText;
387 /**
388 * The time stamp of the last time that the lifecycle policy was run.
389 */
390 lastEvaluatedAt?: EvaluationTimestamp;
391 }
392 export interface DeleteRepositoryPolicyRequest {
393 /**
394 * The AWS account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed.
395 */
396 registryId?: RegistryId;
397 /**
398 * The name of the repository that is associated with the repository policy to delete.
399 */
400 repositoryName: RepositoryName;
401 }
402 export interface DeleteRepositoryPolicyResponse {
403 /**
404 * The registry ID associated with the request.
405 */
406 registryId?: RegistryId;
407 /**
408 * The repository name associated with the request.
409 */
410 repositoryName?: RepositoryName;
411 /**
412 * The JSON repository policy that was deleted from the repository.
413 */
414 policyText?: RepositoryPolicyText;
415 }
416 export interface DeleteRepositoryRequest {
417 /**
418 * The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.
419 */
420 registryId?: RegistryId;
421 /**
422 * The name of the repository to delete.
423 */
424 repositoryName: RepositoryName;
425 /**
426 * If a repository contains images, forces the deletion.
427 */
428 force?: ForceFlag;
429 }
430 export interface DeleteRepositoryResponse {
431 /**
432 * The repository that was deleted.
433 */
434 repository?: Repository;
435 }
436 export interface DescribeImagesFilter {
437 /**
438 * The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED or UNTAGGED.
439 */
440 tagStatus?: TagStatus;
441 }
442 export interface DescribeImagesRequest {
443 /**
444 * The AWS account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.
445 */
446 registryId?: RegistryId;
447 /**
448 * A list of repositories to describe.
449 */
450 repositoryName: RepositoryName;
451 /**
452 * The list of image IDs for the requested repository.
453 */
454 imageIds?: ImageIdentifierList;
455 /**
456 * The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify images with imageIds.
457 */
458 nextToken?: NextToken;
459 /**
460 * The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.
461 */
462 maxResults?: MaxResults;
463 /**
464 * The filter key and value with which to filter your DescribeImages results.
465 */
466 filter?: DescribeImagesFilter;
467 }
468 export interface DescribeImagesResponse {
469 /**
470 * A list of ImageDetail objects that contain data about the image.
471 */
472 imageDetails?: ImageDetailList;
473 /**
474 * The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
475 */
476 nextToken?: NextToken;
477 }
478 export interface DescribeRepositoriesRequest {
479 /**
480 * The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.
481 */
482 registryId?: RegistryId;
483 /**
484 * A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
485 */
486 repositoryNames?: RepositoryNameList;
487 /**
488 * The nextToken value returned from a previous paginated DescribeRepositories request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify repositories with repositoryNames. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
489 */
490 nextToken?: NextToken;
491 /**
492 * The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.
493 */
494 maxResults?: MaxResults;
495 }
496 export interface DescribeRepositoriesResponse {
497 /**
498 * A list of repository objects corresponding to valid repositories.
499 */
500 repositories?: RepositoryList;
501 /**
502 * The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
503 */
504 nextToken?: NextToken;
505 }
506 export type EvaluationTimestamp = Date;
507 export type ExpirationTimestamp = Date;
508 export type ForceFlag = boolean;
509 export type GetAuthorizationTokenRegistryIdList = RegistryId[];
510 export interface GetAuthorizationTokenRequest {
511 /**
512 * A list of AWS account IDs that are associated with the registries for which to get authorization tokens. If you do not specify a registry, the default registry is assumed.
513 */
514 registryIds?: GetAuthorizationTokenRegistryIdList;
515 }
516 export interface GetAuthorizationTokenResponse {
517 /**
518 * A list of authorization token data objects that correspond to the registryIds values in the request.
519 */
520 authorizationData?: AuthorizationDataList;
521 }
522 export interface GetDownloadUrlForLayerRequest {
523 /**
524 * The AWS account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.
525 */
526 registryId?: RegistryId;
527 /**
528 * The name of the repository that is associated with the image layer to download.
529 */
530 repositoryName: RepositoryName;
531 /**
532 * The digest of the image layer to download.
533 */
534 layerDigest: LayerDigest;
535 }
536 export interface GetDownloadUrlForLayerResponse {
537 /**
538 * The pre-signed Amazon S3 download URL for the requested layer.
539 */
540 downloadUrl?: Url;
541 /**
542 * The digest of the image layer to download.
543 */
544 layerDigest?: LayerDigest;
545 }
546 export interface GetLifecyclePolicyPreviewRequest {
547 /**
548 * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
549 */
550 registryId?: RegistryId;
551 /**
552 * The name of the repository.
553 */
554 repositoryName: RepositoryName;
555 /**
556 * The list of imageIDs to be included.
557 */
558 imageIds?: ImageIdentifierList;
559 /**
560 * The nextToken value returned from a previous paginated&#x2028; GetLifecyclePolicyPreviewRequest request where maxResults was used and the&#x2028; results exceeded the value of that parameter. Pagination continues from the end of the&#x2028; previous results that returned the nextToken value. This value is&#x2028; null when there are no more results to return. This option cannot be used when you specify images with imageIds.
561 */
562 nextToken?: NextToken;
563 /**
564 * The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in&#x2028; paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns&#x2028; maxResults results in a single page along with a nextToken&#x2028; response element. The remaining results of the initial request can be seen by sending&#x2028; another GetLifecyclePolicyPreviewRequest request with the returned nextToken&#x2028; value. This value can be between 1 and 1000. If this&#x2028; parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to&#x2028; 100 results and a nextToken value, if&#x2028; applicable. This option cannot be used when you specify images with imageIds.
565 */
566 maxResults?: LifecyclePreviewMaxResults;
567 /**
568 * An optional parameter that filters results based on image tag status and all tags, if tagged.
569 */
570 filter?: LifecyclePolicyPreviewFilter;
571 }
572 export interface GetLifecyclePolicyPreviewResponse {
573 /**
574 * The registry ID associated with the request.
575 */
576 registryId?: RegistryId;
577 /**
578 * The repository name associated with the request.
579 */
580 repositoryName?: RepositoryName;
581 /**
582 * The JSON lifecycle policy text.
583 */
584 lifecyclePolicyText?: LifecyclePolicyText;
585 /**
586 * The status of the lifecycle policy preview request.
587 */
588 status?: LifecyclePolicyPreviewStatus;
589 /**
590 * The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
591 */
592 nextToken?: NextToken;
593 /**
594 * The results of the lifecycle policy preview request.
595 */
596 previewResults?: LifecyclePolicyPreviewResultList;
597 /**
598 * The list of images that is returned as a result of the action.
599 */
600 summary?: LifecyclePolicyPreviewSummary;
601 }
602 export interface GetLifecyclePolicyRequest {
603 /**
604 * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
605 */
606 registryId?: RegistryId;
607 /**
608 * The name of the repository.
609 */
610 repositoryName: RepositoryName;
611 }
612 export interface GetLifecyclePolicyResponse {
613 /**
614 * The registry ID associated with the request.
615 */
616 registryId?: RegistryId;
617 /**
618 * The repository name associated with the request.
619 */
620 repositoryName?: RepositoryName;
621 /**
622 * The JSON lifecycle policy text.
623 */
624 lifecyclePolicyText?: LifecyclePolicyText;
625 /**
626 * The time stamp of the last time that the lifecycle policy was run.
627 */
628 lastEvaluatedAt?: EvaluationTimestamp;
629 }
630 export interface GetRepositoryPolicyRequest {
631 /**
632 * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
633 */
634 registryId?: RegistryId;
635 /**
636 * The name of the repository with the policy to retrieve.
637 */
638 repositoryName: RepositoryName;
639 }
640 export interface GetRepositoryPolicyResponse {
641 /**
642 * The registry ID associated with the request.
643 */
644 registryId?: RegistryId;
645 /**
646 * The repository name associated with the request.
647 */
648 repositoryName?: RepositoryName;
649 /**
650 * The JSON repository policy text associated with the repository.
651 */
652 policyText?: RepositoryPolicyText;
653 }
654 export interface Image {
655 /**
656 * The AWS account ID associated with the registry containing the image.
657 */
658 registryId?: RegistryId;
659 /**
660 * The name of the repository associated with the image.
661 */
662 repositoryName?: RepositoryName;
663 /**
664 * An object containing the image tag and image digest associated with an image.
665 */
666 imageId?: ImageIdentifier;
667 /**
668 * The image manifest associated with the image.
669 */
670 imageManifest?: ImageManifest;
671 }
672 export type ImageActionType = "EXPIRE"|string;
673 export type ImageCount = number;
674 export interface ImageDetail {
675 /**
676 * The AWS account ID associated with the registry to which this image belongs.
677 */
678 registryId?: RegistryId;
679 /**
680 * The name of the repository to which this image belongs.
681 */
682 repositoryName?: RepositoryName;
683 /**
684 * The sha256 digest of the image manifest.
685 */
686 imageDigest?: ImageDigest;
687 /**
688 * The list of tags associated with this image.
689 */
690 imageTags?: ImageTagList;
691 /**
692 * The size, in bytes, of the image in the repository. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
693 */
694 imageSizeInBytes?: ImageSizeInBytes;
695 /**
696 * The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
697 */
698 imagePushedAt?: PushTimestamp;
699 }
700 export type ImageDetailList = ImageDetail[];
701 export type ImageDigest = string;
702 export interface ImageFailure {
703 /**
704 * The image ID associated with the failure.
705 */
706 imageId?: ImageIdentifier;
707 /**
708 * The code associated with the failure.
709 */
710 failureCode?: ImageFailureCode;
711 /**
712 * The reason for the failure.
713 */
714 failureReason?: ImageFailureReason;
715 }
716 export type ImageFailureCode = "InvalidImageDigest"|"InvalidImageTag"|"ImageTagDoesNotMatchDigest"|"ImageNotFound"|"MissingDigestAndTag"|string;
717 export type ImageFailureList = ImageFailure[];
718 export type ImageFailureReason = string;
719 export interface ImageIdentifier {
720 /**
721 * The sha256 digest of the image manifest.
722 */
723 imageDigest?: ImageDigest;
724 /**
725 * The tag used for the image.
726 */
727 imageTag?: ImageTag;
728 }
729 export type ImageIdentifierList = ImageIdentifier[];
730 export type ImageList = Image[];
731 export type ImageManifest = string;
732 export type ImageSizeInBytes = number;
733 export type ImageTag = string;
734 export type ImageTagList = ImageTag[];
735 export interface InitiateLayerUploadRequest {
736 /**
737 * The AWS account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed.
738 */
739 registryId?: RegistryId;
740 /**
741 * The name of the repository to which you intend to upload layers.
742 */
743 repositoryName: RepositoryName;
744 }
745 export interface InitiateLayerUploadResponse {
746 /**
747 * The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.
748 */
749 uploadId?: UploadId;
750 /**
751 * The size, in bytes, that Amazon ECR expects future layer part uploads to be.
752 */
753 partSize?: PartSize;
754 }
755 export interface Layer {
756 /**
757 * The sha256 digest of the image layer.
758 */
759 layerDigest?: LayerDigest;
760 /**
761 * The availability status of the image layer.
762 */
763 layerAvailability?: LayerAvailability;
764 /**
765 * The size, in bytes, of the image layer.
766 */
767 layerSize?: LayerSizeInBytes;
768 /**
769 * The media type of the layer, such as application/vnd.docker.image.rootfs.diff.tar.gzip or application/vnd.oci.image.layer.v1.tar+gzip.
770 */
771 mediaType?: MediaType;
772 }
773 export type LayerAvailability = "AVAILABLE"|"UNAVAILABLE"|string;
774 export type LayerDigest = string;
775 export type LayerDigestList = LayerDigest[];
776 export interface LayerFailure {
777 /**
778 * The layer digest associated with the failure.
779 */
780 layerDigest?: BatchedOperationLayerDigest;
781 /**
782 * The failure code associated with the failure.
783 */
784 failureCode?: LayerFailureCode;
785 /**
786 * The reason for the failure.
787 */
788 failureReason?: LayerFailureReason;
789 }
790 export type LayerFailureCode = "InvalidLayerDigest"|"MissingLayerDigest"|string;
791 export type LayerFailureList = LayerFailure[];
792 export type LayerFailureReason = string;
793 export type LayerList = Layer[];
794 export type LayerPartBlob = Buffer|Uint8Array|Blob|string;
795 export type LayerSizeInBytes = number;
796 export interface LifecyclePolicyPreviewFilter {
797 /**
798 * The tag status of the image.
799 */
800 tagStatus?: TagStatus;
801 }
802 export interface LifecyclePolicyPreviewResult {
803 /**
804 * The list of tags associated with this image.
805 */
806 imageTags?: ImageTagList;
807 /**
808 * The sha256 digest of the image manifest.
809 */
810 imageDigest?: ImageDigest;
811 /**
812 * The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
813 */
814 imagePushedAt?: PushTimestamp;
815 /**
816 * The type of action to be taken.
817 */
818 action?: LifecyclePolicyRuleAction;
819 /**
820 * The priority of the applied rule.
821 */
822 appliedRulePriority?: LifecyclePolicyRulePriority;
823 }
824 export type LifecyclePolicyPreviewResultList = LifecyclePolicyPreviewResult[];
825 export type LifecyclePolicyPreviewStatus = "IN_PROGRESS"|"COMPLETE"|"EXPIRED"|"FAILED"|string;
826 export interface LifecyclePolicyPreviewSummary {
827 /**
828 * The number of expiring images.
829 */
830 expiringImageTotalCount?: ImageCount;
831 }
832 export interface LifecyclePolicyRuleAction {
833 /**
834 * The type of action to be taken.
835 */
836 type?: ImageActionType;
837 }
838 export type LifecyclePolicyRulePriority = number;
839 export type LifecyclePolicyText = string;
840 export type LifecyclePreviewMaxResults = number;
841 export interface ListImagesFilter {
842 /**
843 * The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED or UNTAGGED.
844 */
845 tagStatus?: TagStatus;
846 }
847 export interface ListImagesRequest {
848 /**
849 * The AWS account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.
850 */
851 registryId?: RegistryId;
852 /**
853 * The repository with image IDs to be listed.
854 */
855 repositoryName: RepositoryName;
856 /**
857 * The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
858 */
859 nextToken?: NextToken;
860 /**
861 * The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.
862 */
863 maxResults?: MaxResults;
864 /**
865 * The filter key and value with which to filter your ListImages results.
866 */
867 filter?: ListImagesFilter;
868 }
869 export interface ListImagesResponse {
870 /**
871 * The list of image IDs for the requested repository.
872 */
873 imageIds?: ImageIdentifierList;
874 /**
875 * The nextToken value to include in a future ListImages request. When the results of a ListImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
876 */
877 nextToken?: NextToken;
878 }
879 export interface ListTagsForResourceRequest {
880 /**
881 * The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the only supported resource is an Amazon ECR repository.
882 */
883 resourceArn: Arn;
884 }
885 export interface ListTagsForResourceResponse {
886 /**
887 * The tags for the resource.
888 */
889 tags?: TagList;
890 }
891 export type MaxResults = number;
892 export type MediaType = string;
893 export type MediaTypeList = MediaType[];
894 export type NextToken = string;
895 export type PartSize = number;
896 export type ProxyEndpoint = string;
897 export type PushTimestamp = Date;
898 export interface PutImageRequest {
899 /**
900 * The AWS account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.
901 */
902 registryId?: RegistryId;
903 /**
904 * The name of the repository in which to put the image.
905 */
906 repositoryName: RepositoryName;
907 /**
908 * The image manifest corresponding to the image to be uploaded.
909 */
910 imageManifest: ImageManifest;
911 /**
912 * The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or OCI formats.
913 */
914 imageTag?: ImageTag;
915 }
916 export interface PutImageResponse {
917 /**
918 * Details of the image uploaded.
919 */
920 image?: Image;
921 }
922 export interface PutLifecyclePolicyRequest {
923 /**
924 * The AWS account ID associated with the registry that contains the repository. If you do&#x2028; not specify a registry, the default registry is assumed.
925 */
926 registryId?: RegistryId;
927 /**
928 * The name of the repository to receive the policy.
929 */
930 repositoryName: RepositoryName;
931 /**
932 * The JSON repository policy text to apply to the repository.
933 */
934 lifecyclePolicyText: LifecyclePolicyText;
935 }
936 export interface PutLifecyclePolicyResponse {
937 /**
938 * The registry ID associated with the request.
939 */
940 registryId?: RegistryId;
941 /**
942 * The repository name associated with the request.
943 */
944 repositoryName?: RepositoryName;
945 /**
946 * The JSON repository policy text.
947 */
948 lifecyclePolicyText?: LifecyclePolicyText;
949 }
950 export type RegistryId = string;
951 export interface Repository {
952 /**
953 * The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, AWS account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test.
954 */
955 repositoryArn?: Arn;
956 /**
957 * The AWS account ID associated with the registry that contains the repository.
958 */
959 registryId?: RegistryId;
960 /**
961 * The name of the repository.
962 */
963 repositoryName?: RepositoryName;
964 /**
965 * The URI for the repository. You can use this URI for Docker push or pull operations.
966 */
967 repositoryUri?: Url;
968 /**
969 * The date and time, in JavaScript date format, when the repository was created.
970 */
971 createdAt?: CreationTimestamp;
972 }
973 export type RepositoryList = Repository[];
974 export type RepositoryName = string;
975 export type RepositoryNameList = RepositoryName[];
976 export type RepositoryPolicyText = string;
977 export interface SetRepositoryPolicyRequest {
978 /**
979 * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
980 */
981 registryId?: RegistryId;
982 /**
983 * The name of the repository to receive the policy.
984 */
985 repositoryName: RepositoryName;
986 /**
987 * The JSON repository policy text to apply to the repository.
988 */
989 policyText: RepositoryPolicyText;
990 /**
991 * If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental repository lock outs.
992 */
993 force?: ForceFlag;
994 }
995 export interface SetRepositoryPolicyResponse {
996 /**
997 * The registry ID associated with the request.
998 */
999 registryId?: RegistryId;
1000 /**
1001 * The repository name associated with the request.
1002 */
1003 repositoryName?: RepositoryName;
1004 /**
1005 * The JSON repository policy text applied to the repository.
1006 */
1007 policyText?: RepositoryPolicyText;
1008 }
1009 export interface StartLifecyclePolicyPreviewRequest {
1010 /**
1011 * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
1012 */
1013 registryId?: RegistryId;
1014 /**
1015 * The name of the repository to be evaluated.
1016 */
1017 repositoryName: RepositoryName;
1018 /**
1019 * The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.
1020 */
1021 lifecyclePolicyText?: LifecyclePolicyText;
1022 }
1023 export interface StartLifecyclePolicyPreviewResponse {
1024 /**
1025 * The registry ID associated with the request.
1026 */
1027 registryId?: RegistryId;
1028 /**
1029 * The repository name associated with the request.
1030 */
1031 repositoryName?: RepositoryName;
1032 /**
1033 * The JSON repository policy text.
1034 */
1035 lifecyclePolicyText?: LifecyclePolicyText;
1036 /**
1037 * The status of the lifecycle policy preview request.
1038 */
1039 status?: LifecyclePolicyPreviewStatus;
1040 }
1041 export interface Tag {
1042 /**
1043 * One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
1044 */
1045 Key?: TagKey;
1046 /**
1047 * The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
1048 */
1049 Value?: TagValue;
1050 }
1051 export type TagKey = string;
1052 export type TagKeyList = TagKey[];
1053 export type TagList = Tag[];
1054 export interface TagResourceRequest {
1055 /**
1056 * The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.
1057 */
1058 resourceArn: Arn;
1059 /**
1060 * The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
1061 */
1062 tags: TagList;
1063 }
1064 export interface TagResourceResponse {
1065 }
1066 export type TagStatus = "TAGGED"|"UNTAGGED"|"ANY"|string;
1067 export type TagValue = string;
1068 export interface UntagResourceRequest {
1069 /**
1070 * The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository.
1071 */
1072 resourceArn: Arn;
1073 /**
1074 * The keys of the tags to be removed.
1075 */
1076 tagKeys: TagKeyList;
1077 }
1078 export interface UntagResourceResponse {
1079 }
1080 export type UploadId = string;
1081 export interface UploadLayerPartRequest {
1082 /**
1083 * The AWS account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed.
1084 */
1085 registryId?: RegistryId;
1086 /**
1087 * The name of the repository to which you are uploading layer parts.
1088 */
1089 repositoryName: RepositoryName;
1090 /**
1091 * The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.
1092 */
1093 uploadId: UploadId;
1094 /**
1095 * The integer value of the first byte of the layer part.
1096 */
1097 partFirstByte: PartSize;
1098 /**
1099 * The integer value of the last byte of the layer part.
1100 */
1101 partLastByte: PartSize;
1102 /**
1103 * The base64-encoded layer part payload.
1104 */
1105 layerPartBlob: LayerPartBlob;
1106 }
1107 export interface UploadLayerPartResponse {
1108 /**
1109 * The registry ID associated with the request.
1110 */
1111 registryId?: RegistryId;
1112 /**
1113 * The repository name associated with the request.
1114 */
1115 repositoryName?: RepositoryName;
1116 /**
1117 * The upload ID associated with the request.
1118 */
1119 uploadId?: UploadId;
1120 /**
1121 * The integer value of the last byte received in the request.
1122 */
1123 lastByteReceived?: PartSize;
1124 }
1125 export type Url = string;
1126 /**
1127 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1128 */
1129 export type apiVersion = "2015-09-21"|"latest"|string;
1130 export interface ClientApiVersions {
1131 /**
1132 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1133 */
1134 apiVersion?: apiVersion;
1135 }
1136 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1137 /**
1138 * Contains interfaces for use with the ECR client.
1139 */
1140 export import Types = ECR;
1141}
1142export = ECR;