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 |
|
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 | }
|
215 | declare namespace ECR {
|
216 | export type Arn = string;
|
217 | export interface AuthorizationData {
|
218 | |
219 |
|
220 |
|
221 | authorizationToken?: Base64;
|
222 | |
223 |
|
224 |
|
225 | expiresAt?: ExpirationTimestamp;
|
226 | |
227 |
|
228 |
|
229 | proxyEndpoint?: ProxyEndpoint;
|
230 | }
|
231 | export type AuthorizationDataList = AuthorizationData[];
|
232 | export type Base64 = string;
|
233 | export interface BatchCheckLayerAvailabilityRequest {
|
234 | |
235 |
|
236 |
|
237 | registryId?: RegistryId;
|
238 | |
239 |
|
240 |
|
241 | repositoryName: RepositoryName;
|
242 | |
243 |
|
244 |
|
245 | layerDigests: BatchedOperationLayerDigestList;
|
246 | }
|
247 | export interface BatchCheckLayerAvailabilityResponse {
|
248 | |
249 |
|
250 |
|
251 | layers?: LayerList;
|
252 | |
253 |
|
254 |
|
255 | failures?: LayerFailureList;
|
256 | }
|
257 | export interface BatchDeleteImageRequest {
|
258 | |
259 |
|
260 |
|
261 | registryId?: RegistryId;
|
262 | |
263 |
|
264 |
|
265 | repositoryName: RepositoryName;
|
266 | |
267 |
|
268 |
|
269 | imageIds: ImageIdentifierList;
|
270 | }
|
271 | export interface BatchDeleteImageResponse {
|
272 | |
273 |
|
274 |
|
275 | imageIds?: ImageIdentifierList;
|
276 | |
277 |
|
278 |
|
279 | failures?: ImageFailureList;
|
280 | }
|
281 | export interface BatchGetImageRequest {
|
282 | |
283 |
|
284 |
|
285 | registryId?: RegistryId;
|
286 | |
287 |
|
288 |
|
289 | repositoryName: RepositoryName;
|
290 | |
291 |
|
292 |
|
293 | imageIds: ImageIdentifierList;
|
294 | |
295 |
|
296 |
|
297 | acceptedMediaTypes?: MediaTypeList;
|
298 | }
|
299 | export interface BatchGetImageResponse {
|
300 | |
301 |
|
302 |
|
303 | images?: ImageList;
|
304 | |
305 |
|
306 |
|
307 | failures?: ImageFailureList;
|
308 | }
|
309 | export type BatchedOperationLayerDigest = string;
|
310 | export type BatchedOperationLayerDigestList = BatchedOperationLayerDigest[];
|
311 | export interface CompleteLayerUploadRequest {
|
312 | |
313 |
|
314 |
|
315 | registryId?: RegistryId;
|
316 | |
317 |
|
318 |
|
319 | repositoryName: RepositoryName;
|
320 | |
321 |
|
322 |
|
323 | uploadId: UploadId;
|
324 | |
325 |
|
326 |
|
327 | layerDigests: LayerDigestList;
|
328 | }
|
329 | export interface CompleteLayerUploadResponse {
|
330 | |
331 |
|
332 |
|
333 | registryId?: RegistryId;
|
334 | |
335 |
|
336 |
|
337 | repositoryName?: RepositoryName;
|
338 | |
339 |
|
340 |
|
341 | uploadId?: UploadId;
|
342 | |
343 |
|
344 |
|
345 | layerDigest?: LayerDigest;
|
346 | }
|
347 | export interface CreateRepositoryRequest {
|
348 | |
349 |
|
350 |
|
351 | repositoryName: RepositoryName;
|
352 | |
353 |
|
354 |
|
355 | tags?: TagList;
|
356 | }
|
357 | export interface CreateRepositoryResponse {
|
358 | |
359 |
|
360 |
|
361 | repository?: Repository;
|
362 | }
|
363 | export type CreationTimestamp = Date;
|
364 | export interface DeleteLifecyclePolicyRequest {
|
365 | |
366 |
|
367 |
|
368 | registryId?: RegistryId;
|
369 | |
370 |
|
371 |
|
372 | repositoryName: RepositoryName;
|
373 | }
|
374 | export interface DeleteLifecyclePolicyResponse {
|
375 | |
376 |
|
377 |
|
378 | registryId?: RegistryId;
|
379 | |
380 |
|
381 |
|
382 | repositoryName?: RepositoryName;
|
383 | |
384 |
|
385 |
|
386 | lifecyclePolicyText?: LifecyclePolicyText;
|
387 | |
388 |
|
389 |
|
390 | lastEvaluatedAt?: EvaluationTimestamp;
|
391 | }
|
392 | export interface DeleteRepositoryPolicyRequest {
|
393 | |
394 |
|
395 |
|
396 | registryId?: RegistryId;
|
397 | |
398 |
|
399 |
|
400 | repositoryName: RepositoryName;
|
401 | }
|
402 | export interface DeleteRepositoryPolicyResponse {
|
403 | |
404 |
|
405 |
|
406 | registryId?: RegistryId;
|
407 | |
408 |
|
409 |
|
410 | repositoryName?: RepositoryName;
|
411 | |
412 |
|
413 |
|
414 | policyText?: RepositoryPolicyText;
|
415 | }
|
416 | export interface DeleteRepositoryRequest {
|
417 | |
418 |
|
419 |
|
420 | registryId?: RegistryId;
|
421 | |
422 |
|
423 |
|
424 | repositoryName: RepositoryName;
|
425 | |
426 |
|
427 |
|
428 | force?: ForceFlag;
|
429 | }
|
430 | export interface DeleteRepositoryResponse {
|
431 | |
432 |
|
433 |
|
434 | repository?: Repository;
|
435 | }
|
436 | export interface DescribeImagesFilter {
|
437 | |
438 |
|
439 |
|
440 | tagStatus?: TagStatus;
|
441 | }
|
442 | export interface DescribeImagesRequest {
|
443 | |
444 |
|
445 |
|
446 | registryId?: RegistryId;
|
447 | |
448 |
|
449 |
|
450 | repositoryName: RepositoryName;
|
451 | |
452 |
|
453 |
|
454 | imageIds?: ImageIdentifierList;
|
455 | |
456 |
|
457 |
|
458 | nextToken?: NextToken;
|
459 | |
460 |
|
461 |
|
462 | maxResults?: MaxResults;
|
463 | |
464 |
|
465 |
|
466 | filter?: DescribeImagesFilter;
|
467 | }
|
468 | export interface DescribeImagesResponse {
|
469 | |
470 |
|
471 |
|
472 | imageDetails?: ImageDetailList;
|
473 | |
474 |
|
475 |
|
476 | nextToken?: NextToken;
|
477 | }
|
478 | export interface DescribeRepositoriesRequest {
|
479 | |
480 |
|
481 |
|
482 | registryId?: RegistryId;
|
483 | |
484 |
|
485 |
|
486 | repositoryNames?: RepositoryNameList;
|
487 | |
488 |
|
489 |
|
490 | nextToken?: NextToken;
|
491 | |
492 |
|
493 |
|
494 | maxResults?: MaxResults;
|
495 | }
|
496 | export interface DescribeRepositoriesResponse {
|
497 | |
498 |
|
499 |
|
500 | repositories?: RepositoryList;
|
501 | |
502 |
|
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 |
|
513 |
|
514 | registryIds?: GetAuthorizationTokenRegistryIdList;
|
515 | }
|
516 | export interface GetAuthorizationTokenResponse {
|
517 | |
518 |
|
519 |
|
520 | authorizationData?: AuthorizationDataList;
|
521 | }
|
522 | export interface GetDownloadUrlForLayerRequest {
|
523 | |
524 |
|
525 |
|
526 | registryId?: RegistryId;
|
527 | |
528 |
|
529 |
|
530 | repositoryName: RepositoryName;
|
531 | |
532 |
|
533 |
|
534 | layerDigest: LayerDigest;
|
535 | }
|
536 | export interface GetDownloadUrlForLayerResponse {
|
537 | |
538 |
|
539 |
|
540 | downloadUrl?: Url;
|
541 | |
542 |
|
543 |
|
544 | layerDigest?: LayerDigest;
|
545 | }
|
546 | export interface GetLifecyclePolicyPreviewRequest {
|
547 | |
548 |
|
549 |
|
550 | registryId?: RegistryId;
|
551 | |
552 |
|
553 |
|
554 | repositoryName: RepositoryName;
|
555 | |
556 |
|
557 |
|
558 | imageIds?: ImageIdentifierList;
|
559 | |
560 |
|
561 |
|
562 | nextToken?: NextToken;
|
563 | |
564 |
|
565 |
|
566 | maxResults?: LifecyclePreviewMaxResults;
|
567 | |
568 |
|
569 |
|
570 | filter?: LifecyclePolicyPreviewFilter;
|
571 | }
|
572 | export interface GetLifecyclePolicyPreviewResponse {
|
573 | |
574 |
|
575 |
|
576 | registryId?: RegistryId;
|
577 | |
578 |
|
579 |
|
580 | repositoryName?: RepositoryName;
|
581 | |
582 |
|
583 |
|
584 | lifecyclePolicyText?: LifecyclePolicyText;
|
585 | |
586 |
|
587 |
|
588 | status?: LifecyclePolicyPreviewStatus;
|
589 | |
590 |
|
591 |
|
592 | nextToken?: NextToken;
|
593 | |
594 |
|
595 |
|
596 | previewResults?: LifecyclePolicyPreviewResultList;
|
597 | |
598 |
|
599 |
|
600 | summary?: LifecyclePolicyPreviewSummary;
|
601 | }
|
602 | export interface GetLifecyclePolicyRequest {
|
603 | |
604 |
|
605 |
|
606 | registryId?: RegistryId;
|
607 | |
608 |
|
609 |
|
610 | repositoryName: RepositoryName;
|
611 | }
|
612 | export interface GetLifecyclePolicyResponse {
|
613 | |
614 |
|
615 |
|
616 | registryId?: RegistryId;
|
617 | |
618 |
|
619 |
|
620 | repositoryName?: RepositoryName;
|
621 | |
622 |
|
623 |
|
624 | lifecyclePolicyText?: LifecyclePolicyText;
|
625 | |
626 |
|
627 |
|
628 | lastEvaluatedAt?: EvaluationTimestamp;
|
629 | }
|
630 | export interface GetRepositoryPolicyRequest {
|
631 | |
632 |
|
633 |
|
634 | registryId?: RegistryId;
|
635 | |
636 |
|
637 |
|
638 | repositoryName: RepositoryName;
|
639 | }
|
640 | export interface GetRepositoryPolicyResponse {
|
641 | |
642 |
|
643 |
|
644 | registryId?: RegistryId;
|
645 | |
646 |
|
647 |
|
648 | repositoryName?: RepositoryName;
|
649 | |
650 |
|
651 |
|
652 | policyText?: RepositoryPolicyText;
|
653 | }
|
654 | export interface Image {
|
655 | |
656 |
|
657 |
|
658 | registryId?: RegistryId;
|
659 | |
660 |
|
661 |
|
662 | repositoryName?: RepositoryName;
|
663 | |
664 |
|
665 |
|
666 | imageId?: ImageIdentifier;
|
667 | |
668 |
|
669 |
|
670 | imageManifest?: ImageManifest;
|
671 | }
|
672 | export type ImageActionType = "EXPIRE"|string;
|
673 | export type ImageCount = number;
|
674 | export interface ImageDetail {
|
675 | |
676 |
|
677 |
|
678 | registryId?: RegistryId;
|
679 | |
680 |
|
681 |
|
682 | repositoryName?: RepositoryName;
|
683 | |
684 |
|
685 |
|
686 | imageDigest?: ImageDigest;
|
687 | |
688 |
|
689 |
|
690 | imageTags?: ImageTagList;
|
691 | |
692 |
|
693 |
|
694 | imageSizeInBytes?: ImageSizeInBytes;
|
695 | |
696 |
|
697 |
|
698 | imagePushedAt?: PushTimestamp;
|
699 | }
|
700 | export type ImageDetailList = ImageDetail[];
|
701 | export type ImageDigest = string;
|
702 | export interface ImageFailure {
|
703 | |
704 |
|
705 |
|
706 | imageId?: ImageIdentifier;
|
707 | |
708 |
|
709 |
|
710 | failureCode?: ImageFailureCode;
|
711 | |
712 |
|
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 |
|
722 |
|
723 | imageDigest?: ImageDigest;
|
724 | |
725 |
|
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 |
|
738 |
|
739 | registryId?: RegistryId;
|
740 | |
741 |
|
742 |
|
743 | repositoryName: RepositoryName;
|
744 | }
|
745 | export interface InitiateLayerUploadResponse {
|
746 | |
747 |
|
748 |
|
749 | uploadId?: UploadId;
|
750 | |
751 |
|
752 |
|
753 | partSize?: PartSize;
|
754 | }
|
755 | export interface Layer {
|
756 | |
757 |
|
758 |
|
759 | layerDigest?: LayerDigest;
|
760 | |
761 |
|
762 |
|
763 | layerAvailability?: LayerAvailability;
|
764 | |
765 |
|
766 |
|
767 | layerSize?: LayerSizeInBytes;
|
768 | |
769 |
|
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 |
|
779 |
|
780 | layerDigest?: BatchedOperationLayerDigest;
|
781 | |
782 |
|
783 |
|
784 | failureCode?: LayerFailureCode;
|
785 | |
786 |
|
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 |
|
799 |
|
800 | tagStatus?: TagStatus;
|
801 | }
|
802 | export interface LifecyclePolicyPreviewResult {
|
803 | |
804 |
|
805 |
|
806 | imageTags?: ImageTagList;
|
807 | |
808 |
|
809 |
|
810 | imageDigest?: ImageDigest;
|
811 | |
812 |
|
813 |
|
814 | imagePushedAt?: PushTimestamp;
|
815 | |
816 |
|
817 |
|
818 | action?: LifecyclePolicyRuleAction;
|
819 | |
820 |
|
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 |
|
829 |
|
830 | expiringImageTotalCount?: ImageCount;
|
831 | }
|
832 | export interface LifecyclePolicyRuleAction {
|
833 | |
834 |
|
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 |
|
844 |
|
845 | tagStatus?: TagStatus;
|
846 | }
|
847 | export interface ListImagesRequest {
|
848 | |
849 |
|
850 |
|
851 | registryId?: RegistryId;
|
852 | |
853 |
|
854 |
|
855 | repositoryName: RepositoryName;
|
856 | |
857 |
|
858 |
|
859 | nextToken?: NextToken;
|
860 | |
861 |
|
862 |
|
863 | maxResults?: MaxResults;
|
864 | |
865 |
|
866 |
|
867 | filter?: ListImagesFilter;
|
868 | }
|
869 | export interface ListImagesResponse {
|
870 | |
871 |
|
872 |
|
873 | imageIds?: ImageIdentifierList;
|
874 | |
875 |
|
876 |
|
877 | nextToken?: NextToken;
|
878 | }
|
879 | export interface ListTagsForResourceRequest {
|
880 | |
881 |
|
882 |
|
883 | resourceArn: Arn;
|
884 | }
|
885 | export interface ListTagsForResourceResponse {
|
886 | |
887 |
|
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 |
|
901 |
|
902 | registryId?: RegistryId;
|
903 | |
904 |
|
905 |
|
906 | repositoryName: RepositoryName;
|
907 | |
908 |
|
909 |
|
910 | imageManifest: ImageManifest;
|
911 | |
912 |
|
913 |
|
914 | imageTag?: ImageTag;
|
915 | }
|
916 | export interface PutImageResponse {
|
917 | |
918 |
|
919 |
|
920 | image?: Image;
|
921 | }
|
922 | export interface PutLifecyclePolicyRequest {
|
923 | |
924 |
|
925 |
|
926 | registryId?: RegistryId;
|
927 | |
928 |
|
929 |
|
930 | repositoryName: RepositoryName;
|
931 | |
932 |
|
933 |
|
934 | lifecyclePolicyText: LifecyclePolicyText;
|
935 | }
|
936 | export interface PutLifecyclePolicyResponse {
|
937 | |
938 |
|
939 |
|
940 | registryId?: RegistryId;
|
941 | |
942 |
|
943 |
|
944 | repositoryName?: RepositoryName;
|
945 | |
946 |
|
947 |
|
948 | lifecyclePolicyText?: LifecyclePolicyText;
|
949 | }
|
950 | export type RegistryId = string;
|
951 | export interface Repository {
|
952 | |
953 |
|
954 |
|
955 | repositoryArn?: Arn;
|
956 | |
957 |
|
958 |
|
959 | registryId?: RegistryId;
|
960 | |
961 |
|
962 |
|
963 | repositoryName?: RepositoryName;
|
964 | |
965 |
|
966 |
|
967 | repositoryUri?: Url;
|
968 | |
969 |
|
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 |
|
980 |
|
981 | registryId?: RegistryId;
|
982 | |
983 |
|
984 |
|
985 | repositoryName: RepositoryName;
|
986 | |
987 |
|
988 |
|
989 | policyText: RepositoryPolicyText;
|
990 | |
991 |
|
992 |
|
993 | force?: ForceFlag;
|
994 | }
|
995 | export interface SetRepositoryPolicyResponse {
|
996 | |
997 |
|
998 |
|
999 | registryId?: RegistryId;
|
1000 | |
1001 |
|
1002 |
|
1003 | repositoryName?: RepositoryName;
|
1004 | |
1005 |
|
1006 |
|
1007 | policyText?: RepositoryPolicyText;
|
1008 | }
|
1009 | export interface StartLifecyclePolicyPreviewRequest {
|
1010 | |
1011 |
|
1012 |
|
1013 | registryId?: RegistryId;
|
1014 | |
1015 |
|
1016 |
|
1017 | repositoryName: RepositoryName;
|
1018 | |
1019 |
|
1020 |
|
1021 | lifecyclePolicyText?: LifecyclePolicyText;
|
1022 | }
|
1023 | export interface StartLifecyclePolicyPreviewResponse {
|
1024 | |
1025 |
|
1026 |
|
1027 | registryId?: RegistryId;
|
1028 | |
1029 |
|
1030 |
|
1031 | repositoryName?: RepositoryName;
|
1032 | |
1033 |
|
1034 |
|
1035 | lifecyclePolicyText?: LifecyclePolicyText;
|
1036 | |
1037 |
|
1038 |
|
1039 | status?: LifecyclePolicyPreviewStatus;
|
1040 | }
|
1041 | export interface Tag {
|
1042 | |
1043 |
|
1044 |
|
1045 | Key?: TagKey;
|
1046 | |
1047 |
|
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 |
|
1057 |
|
1058 | resourceArn: Arn;
|
1059 | |
1060 |
|
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 |
|
1071 |
|
1072 | resourceArn: Arn;
|
1073 | |
1074 |
|
1075 |
|
1076 | tagKeys: TagKeyList;
|
1077 | }
|
1078 | export interface UntagResourceResponse {
|
1079 | }
|
1080 | export type UploadId = string;
|
1081 | export interface UploadLayerPartRequest {
|
1082 | |
1083 |
|
1084 |
|
1085 | registryId?: RegistryId;
|
1086 | |
1087 |
|
1088 |
|
1089 | repositoryName: RepositoryName;
|
1090 | |
1091 |
|
1092 |
|
1093 | uploadId: UploadId;
|
1094 | |
1095 |
|
1096 |
|
1097 | partFirstByte: PartSize;
|
1098 | |
1099 |
|
1100 |
|
1101 | partLastByte: PartSize;
|
1102 | |
1103 |
|
1104 |
|
1105 | layerPartBlob: LayerPartBlob;
|
1106 | }
|
1107 | export interface UploadLayerPartResponse {
|
1108 | |
1109 |
|
1110 |
|
1111 | registryId?: RegistryId;
|
1112 | |
1113 |
|
1114 |
|
1115 | repositoryName?: RepositoryName;
|
1116 | |
1117 |
|
1118 |
|
1119 | uploadId?: UploadId;
|
1120 | |
1121 |
|
1122 |
|
1123 | lastByteReceived?: PartSize;
|
1124 | }
|
1125 | export type Url = string;
|
1126 | |
1127 |
|
1128 |
|
1129 | export type apiVersion = "2015-09-21"|"latest"|string;
|
1130 | export interface ClientApiVersions {
|
1131 | |
1132 |
|
1133 |
|
1134 | apiVersion?: apiVersion;
|
1135 | }
|
1136 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
1137 | |
1138 |
|
1139 |
|
1140 | export import Types = ECR;
|
1141 | }
|
1142 | export = ECR;
|