💾 Archived View for gmi.noulin.net › gitRepositories › git-off › file › src › node_modules › aws-sdk… captured on 2023-01-29 at 11:51:27. Gemini links have been rewritten to link to archived content
-=-=-=-=-=-=-
ecr.d.ts (39046B)
1 import {Request} from '../lib/request';
2 import {Response} from '../lib/response';
3 import {AWSError} from '../lib/error';
4 import {Service} from '../lib/service';
5 import {ServiceConfigurationOptions} from '../lib/service';
6 import {ConfigBase as Config} from '../lib/config';
7 interface Blob {}
8 declare 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. 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. 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.
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.
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 * Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed. 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. 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 * Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed. 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. 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 an existing image repository. If a repository contains images, you must use the force option to delete it.
56 */
57 deleteRepository(params: ECR.Types.DeleteRepositoryRequest, callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryResponse) => void): Request<ECR.Types.DeleteRepositoryResponse, AWSError>;
58 /**
59 * Deletes an existing image repository. If a repository contains images, you must use the force option to delete it.
60 */
61 deleteRepository(callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryResponse) => void): Request<ECR.Types.DeleteRepositoryResponse, AWSError>;
62 /**
63 * Deletes the repository policy from a specified repository.
64 */
65 deleteRepositoryPolicy(params: ECR.Types.DeleteRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryPolicyResponse) => void): Request<ECR.Types.DeleteRepositoryPolicyResponse, AWSError>;
66 /**
67 * Deletes the repository policy from a specified repository.
68 */
69 deleteRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryPolicyResponse) => void): Request<ECR.Types.DeleteRepositoryPolicyResponse, AWSError>;
70 /**
71 * Returns metadata about the images in a repository, including image size 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.
72 */
73 describeImages(params: ECR.Types.DescribeImagesRequest, callback?: (err: AWSError, data: ECR.Types.DescribeImagesResponse) => void): Request<ECR.Types.DescribeImagesResponse, AWSError>;
74 /**
75 * Returns metadata about the images in a repository, including image size 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.
76 */
77 describeImages(callback?: (err: AWSError, data: ECR.Types.DescribeImagesResponse) => void): Request<ECR.Types.DescribeImagesResponse, AWSError>;
78 /**
79 * Describes image repositories in a registry.
80 */
81 describeRepositories(params: ECR.Types.DescribeRepositoriesRequest, callback?: (err: AWSError, data: ECR.Types.DescribeRepositoriesResponse) => void): Request<ECR.Types.DescribeRepositoriesResponse, AWSError>;
82 /**
83 * Describes image repositories in a registry.
84 */
85 describeRepositories(callback?: (err: AWSError, data: ECR.Types.DescribeRepositoriesResponse) => void): Request<ECR.Types.DescribeRepositoriesResponse, AWSError>;
86 /**
87 * 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.
88 */
89 getAuthorizationToken(params: ECR.Types.GetAuthorizationTokenRequest, callback?: (err: AWSError, data: ECR.Types.GetAuthorizationTokenResponse) => void): Request<ECR.Types.GetAuthorizationTokenResponse, AWSError>;
90 /**
91 * 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.
92 */
93 getAuthorizationToken(callback?: (err: AWSError, data: ECR.Types.GetAuthorizationTokenResponse) => void): Request<ECR.Types.GetAuthorizationTokenResponse, AWSError>;
94 /**
95 * 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. Use the docker CLI to pull, tag, and push images.
96 */
97 getDownloadUrlForLayer(params: ECR.Types.GetDownloadUrlForLayerRequest, callback?: (err: AWSError, data: ECR.Types.GetDownloadUrlForLayerResponse) => void): Request<ECR.Types.GetDownloadUrlForLayerResponse, AWSError>;
98 /**
99 * 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. Use the docker CLI to pull, tag, and push images.
100 */
101 getDownloadUrlForLayer(callback?: (err: AWSError, data: ECR.Types.GetDownloadUrlForLayerResponse) => void): Request<ECR.Types.GetDownloadUrlForLayerResponse, AWSError>;
102 /**
103 * Retrieves the repository policy for a specified repository.
104 */
105 getRepositoryPolicy(params: ECR.Types.GetRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.GetRepositoryPolicyResponse) => void): Request<ECR.Types.GetRepositoryPolicyResponse, AWSError>;
106 /**
107 * Retrieves the repository policy for a specified repository.
108 */
109 getRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.GetRepositoryPolicyResponse) => void): Request<ECR.Types.GetRepositoryPolicyResponse, AWSError>;
110 /**
111 * 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. Use the docker CLI to pull, tag, and push images.
112 */
113 initiateLayerUpload(params: ECR.Types.InitiateLayerUploadRequest, callback?: (err: AWSError, data: ECR.Types.InitiateLayerUploadResponse) => void): Request<ECR.Types.InitiateLayerUploadResponse, AWSError>;
114 /**
115 * 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. Use the docker CLI to pull, tag, and push images.
116 */
117 initiateLayerUpload(callback?: (err: AWSError, data: ECR.Types.InitiateLayerUploadResponse) => void): Request<ECR.Types.InitiateLayerUploadResponse, AWSError>;
118 /**
119 * 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.
120 */
121 listImages(params: ECR.Types.ListImagesRequest, callback?: (err: AWSError, data: ECR.Types.ListImagesResponse) => void): Request<ECR.Types.ListImagesResponse, AWSError>;
122 /**
123 * 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.
124 */
125 listImages(callback?: (err: AWSError, data: ECR.Types.ListImagesResponse) => void): Request<ECR.Types.ListImagesResponse, AWSError>;
126 /**
127 * Creates or updates the image manifest associated with an image. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the docker CLI to pull, tag, and push images.
128 */
129 putImage(params: ECR.Types.PutImageRequest, callback?: (err: AWSError, data: ECR.Types.PutImageResponse) => void): Request<ECR.Types.PutImageResponse, AWSError>;
130 /**
131 * Creates or updates the image manifest associated with an image. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the docker CLI to pull, tag, and push images.
132 */
133 putImage(callback?: (err: AWSError, data: ECR.Types.PutImageResponse) => void): Request<ECR.Types.PutImageResponse, AWSError>;
134 /**
135 * Applies a repository policy on a specified repository to control access permissions.
136 */
137 setRepositoryPolicy(params: ECR.Types.SetRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.SetRepositoryPolicyResponse) => void): Request<ECR.Types.SetRepositoryPolicyResponse, AWSError>;
138 /**
139 * Applies a repository policy on a specified repository to control access permissions.
140 */
141 setRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.SetRepositoryPolicyResponse) => void): Request<ECR.Types.SetRepositoryPolicyResponse, AWSError>;
142 /**
143 * 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. Use the docker CLI to pull, tag, and push images.
144 */
145 uploadLayerPart(params: ECR.Types.UploadLayerPartRequest, callback?: (err: AWSError, data: ECR.Types.UploadLayerPartResponse) => void): Request<ECR.Types.UploadLayerPartResponse, AWSError>;
146 /**
147 * 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. Use the docker CLI to pull, tag, and push images.
148 */
149 uploadLayerPart(callback?: (err: AWSError, data: ECR.Types.UploadLayerPartResponse) => void): Request<ECR.Types.UploadLayerPartResponse, AWSError>;
150 }
151 declare namespace ECR.Types {
152 export type Arn = string;
153 export interface AuthorizationData {
154 /**
155 * 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.
156 */
157 authorizationToken?: Base64;
158 /**
159 * The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.
160 */
161 expiresAt?: ExpirationTimestamp;
162 /**
163 * 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..
164 */
165 proxyEndpoint?: ProxyEndpoint;
166 }
167 export type AuthorizationDataList = AuthorizationData[];
168 export type Base64 = string;
169 export interface BatchCheckLayerAvailabilityRequest {
170 /**
171 * 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.
172 */
173 registryId?: RegistryId;
174 /**
175 * The name of the repository that is associated with the image layers to check.
176 */
177 repositoryName: RepositoryName;
178 /**
179 * The digests of the image layers to check.
180 */
181 layerDigests: BatchedOperationLayerDigestList;
182 }
183 export interface BatchCheckLayerAvailabilityResponse {
184 /**
185 * A list of image layer objects corresponding to the image layer references in the request.
186 */
187 layers?: LayerList;
188 /**
189 * Any failures associated with the call.
190 */
191 failures?: LayerFailureList;
192 }
193 export interface BatchDeleteImageRequest {
194 /**
195 * 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.
196 */
197 registryId?: RegistryId;
198 /**
199 * The repository that contains the image to delete.
200 */
201 repositoryName: RepositoryName;
202 /**
203 * A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.
204 */
205 imageIds: ImageIdentifierList;
206 }
207 export interface BatchDeleteImageResponse {
208 /**
209 * The image IDs of the deleted images.
210 */
211 imageIds?: ImageIdentifierList;
212 /**
213 * Any failures associated with the call.
214 */
215 failures?: ImageFailureList;
216 }
217 export interface BatchGetImageRequest {
218 /**
219 * 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.
220 */
221 registryId?: RegistryId;
222 /**
223 * The repository that contains the images to describe.
224 */
225 repositoryName: RepositoryName;
226 /**
227 * A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.
228 */
229 imageIds: ImageIdentifierList;
230 }
231 export interface BatchGetImageResponse {
232 /**
233 * A list of image objects corresponding to the image references in the request.
234 */
235 images?: ImageList;
236 /**
237 * Any failures associated with the call.
238 */
239 failures?: ImageFailureList;
240 }
241 export type BatchedOperationLayerDigest = string;
242 export type BatchedOperationLayerDigestList = BatchedOperationLayerDigest[];
243 export interface CompleteLayerUploadRequest {
244 /**
245 * 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.
246 */
247 registryId?: RegistryId;
248 /**
249 * The name of the repository to associate with the image layer.
250 */
251 repositoryName: RepositoryName;
252 /**
253 * The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.
254 */
255 uploadId: UploadId;
256 /**
257 * The sha256 digest of the image layer.
258 */
259 layerDigests: LayerDigestList;
260 }
261 export interface CompleteLayerUploadResponse {
262 /**
263 * The registry ID associated with the request.
264 */
265 registryId?: RegistryId;
266 /**
267 * The repository name associated with the request.
268 */
269 repositoryName?: RepositoryName;
270 /**
271 * The upload ID associated with the layer.
272 */
273 uploadId?: UploadId;
274 /**
275 * The sha256 digest of the image layer.
276 */
277 layerDigest?: LayerDigest;
278 }
279 export interface CreateRepositoryRequest {
280 /**
281 * 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).
282 */
283 repositoryName: RepositoryName;
284 }
285 export interface CreateRepositoryResponse {
286 /**
287 * The repository that was created.
288 */
289 repository?: Repository;
290 }
291 export type CreationTimestamp = Date;
292 export interface DeleteRepositoryPolicyRequest {
293 /**
294 * 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.
295 */
296 registryId?: RegistryId;
297 /**
298 * The name of the repository that is associated with the repository policy to delete.
299 */
300 repositoryName: RepositoryName;
301 }
302 export interface DeleteRepositoryPolicyResponse {
303 /**
304 * The registry ID associated with the request.
305 */
306 registryId?: RegistryId;
307 /**
308 * The repository name associated with the request.
309 */
310 repositoryName?: RepositoryName;
311 /**
312 * The JSON repository policy that was deleted from the repository.
313 */
314 policyText?: RepositoryPolicyText;
315 }
316 export interface DeleteRepositoryRequest {
317 /**
318 * 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.
319 */
320 registryId?: RegistryId;
321 /**
322 * The name of the repository to delete.
323 */
324 repositoryName: RepositoryName;
325 /**
326 * Force the deletion of the repository if it contains images.
327 */
328 force?: ForceFlag;
329 }
330 export interface DeleteRepositoryResponse {
331 /**
332 * The repository that was deleted.
333 */
334 repository?: Repository;
335 }
336 export interface DescribeImagesFilter {
337 /**
338 * The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED or UNTAGGED.
339 */
340 tagStatus?: TagStatus;
341 }
342 export interface DescribeImagesRequest {
343 /**
344 * 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.
345 */
346 registryId?: RegistryId;
347 /**
348 * A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
349 */
350 repositoryName: RepositoryName;
351 /**
352 * The list of image IDs for the requested repository.
353 */
354 imageIds?: ImageIdentifierList;
355 /**
356 * 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.
357 */
358 nextToken?: NextToken;
359 /**
360 * 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 100. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable.
361 */
362 maxResults?: MaxResults;
363 /**
364 * The filter key and value with which to filter your DescribeImages results.
365 */
366 filter?: DescribeImagesFilter;
367 }
368 export interface DescribeImagesResponse {
369 /**
370 * A list of ImageDetail objects that contain data about the image.
371 */
372 imageDetails?: ImageDetailList;
373 /**
374 * 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.
375 */
376 nextToken?: NextToken;
377 }
378 export interface DescribeRepositoriesRequest {
379 /**
380 * 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.
381 */
382 registryId?: RegistryId;
383 /**
384 * A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
385 */
386 repositoryNames?: RepositoryNameList;
387 /**
388 * 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 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.
389 */
390 nextToken?: NextToken;
391 /**
392 * 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 100. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable.
393 */
394 maxResults?: MaxResults;
395 }
396 export interface DescribeRepositoriesResponse {
397 /**
398 * A list of repository objects corresponding to valid repositories.
399 */
400 repositories?: RepositoryList;
401 /**
402 * 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.
403 */
404 nextToken?: NextToken;
405 }
406 export type ExceptionMessage = string;
407 export type ExpirationTimestamp = Date;
408 export type ForceFlag = boolean;
409 export type GetAuthorizationTokenRegistryIdList = RegistryId[];
410 export interface GetAuthorizationTokenRequest {
411 /**
412 * 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.
413 */
414 registryIds?: GetAuthorizationTokenRegistryIdList;
415 }
416 export interface GetAuthorizationTokenResponse {
417 /**
418 * A list of authorization token data objects that correspond to the registryIds values in the request.
419 */
420 authorizationData?: AuthorizationDataList;
421 }
422 export interface GetDownloadUrlForLayerRequest {
423 /**
424 * 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.
425 */
426 registryId?: RegistryId;
427 /**
428 * The name of the repository that is associated with the image layer to download.
429 */
430 repositoryName: RepositoryName;
431 /**
432 * The digest of the image layer to download.
433 */
434 layerDigest: LayerDigest;
435 }
436 export interface GetDownloadUrlForLayerResponse {
437 /**
438 * The pre-signed Amazon S3 download URL for the requested layer.
439 */
440 downloadUrl?: Url;
441 /**
442 * The digest of the image layer to download.
443 */
444 layerDigest?: LayerDigest;
445 }
446 export interface GetRepositoryPolicyRequest {
447 /**
448 * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
449 */
450 registryId?: RegistryId;
451 /**
452 * The name of the repository whose policy you want to retrieve.
453 */
454 repositoryName: RepositoryName;
455 }
456 export interface GetRepositoryPolicyResponse {
457 /**
458 * The registry ID associated with the request.
459 */
460 registryId?: RegistryId;
461 /**
462 * The repository name associated with the request.
463 */
464 repositoryName?: RepositoryName;
465 /**
466 * The JSON repository policy text associated with the repository.
467 */
468 policyText?: RepositoryPolicyText;
469 }
470 export interface Image {
471 /**
472 * The AWS account ID associated with the registry containing the image.
473 */
474 registryId?: RegistryId;
475 /**
476 * The name of the repository associated with the image.
477 */
478 repositoryName?: RepositoryName;
479 /**
480 * An object containing the image tag and image digest associated with an image.
481 */
482 imageId?: ImageIdentifier;
483 /**
484 * The image manifest associated with the image.
485 */
486 imageManifest?: ImageManifest;
487 }
488 export interface ImageDetail {
489 /**
490 * The AWS account ID associated with the registry to which this image belongs.
491 */
492 registryId?: RegistryId;
493 /**
494 * The name of the repository to which this image belongs.
495 */
496 repositoryName?: RepositoryName;
497 /**
498 * The sha256 digest of the image manifest.
499 */
500 imageDigest?: ImageDigest;
501 /**
502 * The list of tags associated with this image.
503 */
504 imageTags?: ImageTagList;
505 /**
506 * 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.
507 */
508 imageSizeInBytes?: ImageSizeInBytes;
509 /**
510 * The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
511 */
512 imagePushedAt?: PushTimestamp;
513 }
514 export type ImageDetailList = ImageDetail[];
515 export type ImageDigest = string;
516 export interface ImageFailure {
517 /**
518 * The image ID associated with the failure.
519 */
520 imageId?: ImageIdentifier;
521 /**
522 * The code associated with the failure.
523 */
524 failureCode?: ImageFailureCode;
525 /**
526 * The reason for the failure.
527 */
528 failureReason?: ImageFailureReason;
529 }
530 export type ImageFailureCode = "InvalidImageDigest"|"InvalidImageTag"|"ImageTagDoesNotMatchDigest"|"ImageNotFound"|"MissingDigestAndTag"|string;
531 export type ImageFailureList = ImageFailure[];
532 export type ImageFailureReason = string;
533 export interface ImageIdentifier {
534 /**
535 * The sha256 digest of the image manifest.
536 */
537 imageDigest?: ImageDigest;
538 /**
539 * The tag used for the image.
540 */
541 imageTag?: ImageTag;
542 }
543 export type ImageIdentifierList = ImageIdentifier[];
544 export type ImageList = Image[];
545 export type ImageManifest = string;
546 export type ImageSizeInBytes = number;
547 export type ImageTag = string;
548 export type ImageTagList = ImageTag[];
549 export interface InitiateLayerUploadRequest {
550 /**
551 * The AWS account ID associated with the registry that you intend to upload layers to. If you do not specify a registry, the default registry is assumed.
552 */
553 registryId?: RegistryId;
554 /**
555 * The name of the repository that you intend to upload layers to.
556 */
557 repositoryName: RepositoryName;
558 }
559 export interface InitiateLayerUploadResponse {
560 /**
561 * The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.
562 */
563 uploadId?: UploadId;
564 /**
565 * The size, in bytes, that Amazon ECR expects future layer part uploads to be.
566 */
567 partSize?: PartSize;
568 }
569 export interface Layer {
570 /**
571 * The sha256 digest of the image layer.
572 */
573 layerDigest?: LayerDigest;
574 /**
575 * The availability status of the image layer. Valid values are AVAILABLE and UNAVAILABLE.
576 */
577 layerAvailability?: LayerAvailability;
578 /**
579 * The size, in bytes, of the image layer.
580 */
581 layerSize?: LayerSizeInBytes;
582 }
583 export type LayerAvailability = "AVAILABLE"|"UNAVAILABLE"|string;
584 export type LayerDigest = string;
585 export type LayerDigestList = LayerDigest[];
586 export interface LayerFailure {
587 /**
588 * The layer digest associated with the failure.
589 */
590 layerDigest?: BatchedOperationLayerDigest;
591 /**
592 * The failure code associated with the failure.
593 */
594 failureCode?: LayerFailureCode;
595 /**
596 * The reason for the failure.
597 */
598 failureReason?: LayerFailureReason;
599 }
600 export type LayerFailureCode = "InvalidLayerDigest"|"MissingLayerDigest"|string;
601 export type LayerFailureList = LayerFailure[];
602 export type LayerFailureReason = string;
603 export type LayerList = Layer[];
604 export type LayerPartBlob = Buffer|Uint8Array|Blob|string;
605 export type LayerSizeInBytes = number;
606 export interface ListImagesFilter {
607 /**
608 * The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED or UNTAGGED.
609 */
610 tagStatus?: TagStatus;
611 }
612 export interface ListImagesRequest {
613 /**
614 * The AWS account ID associated with the registry that contains the repository to list images in. If you do not specify a registry, the default registry is assumed.
615 */
616 registryId?: RegistryId;
617 /**
618 * The repository whose image IDs are to be listed.
619 */
620 repositoryName: RepositoryName;
621 /**
622 * 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.
623 */
624 nextToken?: NextToken;
625 /**
626 * 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 100. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.
627 */
628 maxResults?: MaxResults;
629 /**
630 * The filter key and value with which to filter your ListImages results.
631 */
632 filter?: ListImagesFilter;
633 }
634 export interface ListImagesResponse {
635 /**
636 * The list of image IDs for the requested repository.
637 */
638 imageIds?: ImageIdentifierList;
639 /**
640 * 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.
641 */
642 nextToken?: NextToken;
643 }
644 export type MaxResults = number;
645 export type NextToken = string;
646 export type PartSize = number;
647 export type ProxyEndpoint = string;
648 export type PushTimestamp = Date;
649 export interface PutImageRequest {
650 /**
651 * 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.
652 */
653 registryId?: RegistryId;
654 /**
655 * The name of the repository in which to put the image.
656 */
657 repositoryName: RepositoryName;
658 /**
659 * The image manifest corresponding to the image to be uploaded.
660 */
661 imageManifest: ImageManifest;
662 }
663 export interface PutImageResponse {
664 /**
665 * Details of the image uploaded.
666 */
667 image?: Image;
668 }
669 export type RegistryId = string;
670 export interface Repository {
671 /**
672 * The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, the AWS account ID of the repository owner, the repository namespace, and then the repository name. For example, arn:aws:ecr:region:012345678910:repository/test.
673 */
674 repositoryArn?: Arn;
675 /**
676 * The AWS account ID associated with the registry that contains the repository.
677 */
678 registryId?: RegistryId;
679 /**
680 * The name of the repository.
681 */
682 repositoryName?: RepositoryName;
683 /**
684 * The URI for the repository. You can use this URI for Docker push and pull operations.
685 */
686 repositoryUri?: Url;
687 /**
688 * The date and time, in JavaScript date/time format, when the repository was created.
689 */
690 createdAt?: CreationTimestamp;
691 }
692 export type RepositoryList = Repository[];
693 export type RepositoryName = string;
694 export type RepositoryNameList = RepositoryName[];
695 export type RepositoryPolicyText = string;
696 export interface SetRepositoryPolicyRequest {
697 /**
698 * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
699 */
700 registryId?: RegistryId;
701 /**
702 * The name of the repository to receive the policy.
703 */
704 repositoryName: RepositoryName;
705 /**
706 * The JSON repository policy text to apply to the repository.
707 */
708 policyText: RepositoryPolicyText;
709 /**
710 * 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.
711 */
712 force?: ForceFlag;
713 }
714 export interface SetRepositoryPolicyResponse {
715 /**
716 * The registry ID associated with the request.
717 */
718 registryId?: RegistryId;
719 /**
720 * The repository name associated with the request.
721 */
722 repositoryName?: RepositoryName;
723 /**
724 * The JSON repository policy text applied to the repository.
725 */
726 policyText?: RepositoryPolicyText;
727 }
728 export type TagStatus = "TAGGED"|"UNTAGGED"|string;
729 export type UploadId = string;
730 export interface UploadLayerPartRequest {
731 /**
732 * The AWS account ID associated with the registry that you are uploading layer parts to. If you do not specify a registry, the default registry is assumed.
733 */
734 registryId?: RegistryId;
735 /**
736 * The name of the repository that you are uploading layer parts to.
737 */
738 repositoryName: RepositoryName;
739 /**
740 * The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.
741 */
742 uploadId: UploadId;
743 /**
744 * The integer value of the first byte of the layer part.
745 */
746 partFirstByte: PartSize;
747 /**
748 * The integer value of the last byte of the layer part.
749 */
750 partLastByte: PartSize;
751 /**
752 * The base64-encoded layer part payload.
753 */
754 layerPartBlob: LayerPartBlob;
755 }
756 export interface UploadLayerPartResponse {
757 /**
758 * The registry ID associated with the request.
759 */
760 registryId?: RegistryId;
761 /**
762 * The repository name associated with the request.
763 */
764 repositoryName?: RepositoryName;
765 /**
766 * The upload ID associated with the request.
767 */
768 uploadId?: UploadId;
769 /**
770 * The integer value of the last byte received in the request.
771 */
772 lastByteReceived?: PartSize;
773 }
774 export type Url = string;
775 /**
776 * 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.
777 */
778 export type apiVersion = "2015-09-21"|"latest"|string;
779 export interface ClientApiVersions {
780 /**
781 * 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.
782 */
783 apiVersion?: apiVersion;
784 }
785 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
786 }
787 export = ECR;