/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / ecrpublic.d.ts
ecrpublic.d.ts
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-base'; 7 interface Blob {} 8 declare class ECRPUBLIC extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: ECRPUBLIC.Types.ClientConfiguration) 13 config: Config & ECRPUBLIC.Types.ClientConfiguration; 14 /** 15 * Checks the availability of one or more image layers within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped. This operation is used by the Amazon ECR proxy and is not generally used 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: ECRPUBLIC.Types.BatchCheckLayerAvailabilityRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.BatchCheckLayerAvailabilityResponse) => void): Request<ECRPUBLIC.Types.BatchCheckLayerAvailabilityResponse, AWSError>; 18 /** 19 * Checks the availability of one or more image layers within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped. This operation is used by the Amazon ECR proxy and is not generally used 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: ECRPUBLIC.Types.BatchCheckLayerAvailabilityResponse) => void): Request<ECRPUBLIC.Types.BatchCheckLayerAvailabilityResponse, AWSError>; 22 /** 23 * Deletes a list of specified images within a repository in a public registry. Images are specified with either an 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: ECRPUBLIC.Types.BatchDeleteImageRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.BatchDeleteImageResponse) => void): Request<ECRPUBLIC.Types.BatchDeleteImageResponse, AWSError>; 26 /** 27 * Deletes a list of specified images within a repository in a public registry. Images are specified with either an 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: ECRPUBLIC.Types.BatchDeleteImageResponse) => void): Request<ECRPUBLIC.Types.BatchDeleteImageResponse, AWSError>; 30 /** 31 * Informs Amazon ECR that the image layer upload has completed for a specified public registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes. When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. 32 */ 33 completeLayerUpload(params: ECRPUBLIC.Types.CompleteLayerUploadRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.CompleteLayerUploadResponse) => void): Request<ECRPUBLIC.Types.CompleteLayerUploadResponse, AWSError>; 34 /** 35 * Informs Amazon ECR that the image layer upload has completed for a specified public registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes. When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. 36 */ 37 completeLayerUpload(callback?: (err: AWSError, data: ECRPUBLIC.Types.CompleteLayerUploadResponse) => void): Request<ECRPUBLIC.Types.CompleteLayerUploadResponse, AWSError>; 38 /** 39 * Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide. 40 */ 41 createRepository(params: ECRPUBLIC.Types.CreateRepositoryRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.CreateRepositoryResponse) => void): Request<ECRPUBLIC.Types.CreateRepositoryResponse, AWSError>; 42 /** 43 * Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide. 44 */ 45 createRepository(callback?: (err: AWSError, data: ECRPUBLIC.Types.CreateRepositoryResponse) => void): Request<ECRPUBLIC.Types.CreateRepositoryResponse, AWSError>; 46 /** 47 * Deletes a repository in a public registry. If the repository contains images, you must either delete all images in the repository or use the force option which deletes all images on your behalf before deleting the repository. 48 */ 49 deleteRepository(params: ECRPUBLIC.Types.DeleteRepositoryRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.DeleteRepositoryResponse) => void): Request<ECRPUBLIC.Types.DeleteRepositoryResponse, AWSError>; 50 /** 51 * Deletes a repository in a public registry. If the repository contains images, you must either delete all images in the repository or use the force option which deletes all images on your behalf before deleting the repository. 52 */ 53 deleteRepository(callback?: (err: AWSError, data: ECRPUBLIC.Types.DeleteRepositoryResponse) => void): Request<ECRPUBLIC.Types.DeleteRepositoryResponse, AWSError>; 54 /** 55 * Deletes the repository policy associated with the specified repository. 56 */ 57 deleteRepositoryPolicy(params: ECRPUBLIC.Types.DeleteRepositoryPolicyRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.DeleteRepositoryPolicyResponse) => void): Request<ECRPUBLIC.Types.DeleteRepositoryPolicyResponse, AWSError>; 58 /** 59 * Deletes the repository policy associated with the specified repository. 60 */ 61 deleteRepositoryPolicy(callback?: (err: AWSError, data: ECRPUBLIC.Types.DeleteRepositoryPolicyResponse) => void): Request<ECRPUBLIC.Types.DeleteRepositoryPolicyResponse, AWSError>; 62 /** 63 * Returns the image tag details for a repository in a public registry. 64 */ 65 describeImageTags(params: ECRPUBLIC.Types.DescribeImageTagsRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.DescribeImageTagsResponse) => void): Request<ECRPUBLIC.Types.DescribeImageTagsResponse, AWSError>; 66 /** 67 * Returns the image tag details for a repository in a public registry. 68 */ 69 describeImageTags(callback?: (err: AWSError, data: ECRPUBLIC.Types.DescribeImageTagsResponse) => void): Request<ECRPUBLIC.Types.DescribeImageTagsResponse, AWSError>; 70 /** 71 * Returns metadata about the images in a repository in a public registry. 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: ECRPUBLIC.Types.DescribeImagesRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.DescribeImagesResponse) => void): Request<ECRPUBLIC.Types.DescribeImagesResponse, AWSError>; 74 /** 75 * Returns metadata about the images in a repository in a public registry. 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: ECRPUBLIC.Types.DescribeImagesResponse) => void): Request<ECRPUBLIC.Types.DescribeImagesResponse, AWSError>; 78 /** 79 * Returns details for a public registry. 80 */ 81 describeRegistries(params: ECRPUBLIC.Types.DescribeRegistriesRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.DescribeRegistriesResponse) => void): Request<ECRPUBLIC.Types.DescribeRegistriesResponse, AWSError>; 82 /** 83 * Returns details for a public registry. 84 */ 85 describeRegistries(callback?: (err: AWSError, data: ECRPUBLIC.Types.DescribeRegistriesResponse) => void): Request<ECRPUBLIC.Types.DescribeRegistriesResponse, AWSError>; 86 /** 87 * Describes repositories in a public registry. 88 */ 89 describeRepositories(params: ECRPUBLIC.Types.DescribeRepositoriesRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.DescribeRepositoriesResponse) => void): Request<ECRPUBLIC.Types.DescribeRepositoriesResponse, AWSError>; 90 /** 91 * Describes repositories in a public registry. 92 */ 93 describeRepositories(callback?: (err: AWSError, data: ECRPUBLIC.Types.DescribeRepositoriesResponse) => void): Request<ECRPUBLIC.Types.DescribeRepositoriesResponse, AWSError>; 94 /** 95 * Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the ecr-public:GetAuthorizationToken and sts:GetServiceBearerToken permissions. 96 */ 97 getAuthorizationToken(params: ECRPUBLIC.Types.GetAuthorizationTokenRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.GetAuthorizationTokenResponse) => void): Request<ECRPUBLIC.Types.GetAuthorizationTokenResponse, AWSError>; 98 /** 99 * Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the ecr-public:GetAuthorizationToken and sts:GetServiceBearerToken permissions. 100 */ 101 getAuthorizationToken(callback?: (err: AWSError, data: ECRPUBLIC.Types.GetAuthorizationTokenResponse) => void): Request<ECRPUBLIC.Types.GetAuthorizationTokenResponse, AWSError>; 102 /** 103 * Retrieves catalog metadata for a public registry. 104 */ 105 getRegistryCatalogData(params: ECRPUBLIC.Types.GetRegistryCatalogDataRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.GetRegistryCatalogDataResponse) => void): Request<ECRPUBLIC.Types.GetRegistryCatalogDataResponse, AWSError>; 106 /** 107 * Retrieves catalog metadata for a public registry. 108 */ 109 getRegistryCatalogData(callback?: (err: AWSError, data: ECRPUBLIC.Types.GetRegistryCatalogDataResponse) => void): Request<ECRPUBLIC.Types.GetRegistryCatalogDataResponse, AWSError>; 110 /** 111 * Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery. 112 */ 113 getRepositoryCatalogData(params: ECRPUBLIC.Types.GetRepositoryCatalogDataRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.GetRepositoryCatalogDataResponse) => void): Request<ECRPUBLIC.Types.GetRepositoryCatalogDataResponse, AWSError>; 114 /** 115 * Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery. 116 */ 117 getRepositoryCatalogData(callback?: (err: AWSError, data: ECRPUBLIC.Types.GetRepositoryCatalogDataResponse) => void): Request<ECRPUBLIC.Types.GetRepositoryCatalogDataResponse, AWSError>; 118 /** 119 * Retrieves the repository policy for the specified repository. 120 */ 121 getRepositoryPolicy(params: ECRPUBLIC.Types.GetRepositoryPolicyRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.GetRepositoryPolicyResponse) => void): Request<ECRPUBLIC.Types.GetRepositoryPolicyResponse, AWSError>; 122 /** 123 * Retrieves the repository policy for the specified repository. 124 */ 125 getRepositoryPolicy(callback?: (err: AWSError, data: ECRPUBLIC.Types.GetRepositoryPolicyResponse) => void): Request<ECRPUBLIC.Types.GetRepositoryPolicyResponse, AWSError>; 126 /** 127 * Notifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. 128 */ 129 initiateLayerUpload(params: ECRPUBLIC.Types.InitiateLayerUploadRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.InitiateLayerUploadResponse) => void): Request<ECRPUBLIC.Types.InitiateLayerUploadResponse, AWSError>; 130 /** 131 * Notifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. 132 */ 133 initiateLayerUpload(callback?: (err: AWSError, data: ECRPUBLIC.Types.InitiateLayerUploadResponse) => void): Request<ECRPUBLIC.Types.InitiateLayerUploadResponse, AWSError>; 134 /** 135 * List the tags for an Amazon ECR Public resource. 136 */ 137 listTagsForResource(params: ECRPUBLIC.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.ListTagsForResourceResponse) => void): Request<ECRPUBLIC.Types.ListTagsForResourceResponse, AWSError>; 138 /** 139 * List the tags for an Amazon ECR Public resource. 140 */ 141 listTagsForResource(callback?: (err: AWSError, data: ECRPUBLIC.Types.ListTagsForResourceResponse) => void): Request<ECRPUBLIC.Types.ListTagsForResourceResponse, AWSError>; 142 /** 143 * Creates or updates the image manifest and tags associated with an image. When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. 144 */ 145 putImage(params: ECRPUBLIC.Types.PutImageRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.PutImageResponse) => void): Request<ECRPUBLIC.Types.PutImageResponse, AWSError>; 146 /** 147 * Creates or updates the image manifest and tags associated with an image. When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. 148 */ 149 putImage(callback?: (err: AWSError, data: ECRPUBLIC.Types.PutImageResponse) => void): Request<ECRPUBLIC.Types.PutImageResponse, AWSError>; 150 /** 151 * Create or updates the catalog data for a public registry. 152 */ 153 putRegistryCatalogData(params: ECRPUBLIC.Types.PutRegistryCatalogDataRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.PutRegistryCatalogDataResponse) => void): Request<ECRPUBLIC.Types.PutRegistryCatalogDataResponse, AWSError>; 154 /** 155 * Create or updates the catalog data for a public registry. 156 */ 157 putRegistryCatalogData(callback?: (err: AWSError, data: ECRPUBLIC.Types.PutRegistryCatalogDataResponse) => void): Request<ECRPUBLIC.Types.PutRegistryCatalogDataResponse, AWSError>; 158 /** 159 * Creates or updates the catalog data for a repository in a public registry. 160 */ 161 putRepositoryCatalogData(params: ECRPUBLIC.Types.PutRepositoryCatalogDataRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.PutRepositoryCatalogDataResponse) => void): Request<ECRPUBLIC.Types.PutRepositoryCatalogDataResponse, AWSError>; 162 /** 163 * Creates or updates the catalog data for a repository in a public registry. 164 */ 165 putRepositoryCatalogData(callback?: (err: AWSError, data: ECRPUBLIC.Types.PutRepositoryCatalogDataResponse) => void): Request<ECRPUBLIC.Types.PutRepositoryCatalogDataResponse, AWSError>; 166 /** 167 * Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide. 168 */ 169 setRepositoryPolicy(params: ECRPUBLIC.Types.SetRepositoryPolicyRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.SetRepositoryPolicyResponse) => void): Request<ECRPUBLIC.Types.SetRepositoryPolicyResponse, AWSError>; 170 /** 171 * Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide. 172 */ 173 setRepositoryPolicy(callback?: (err: AWSError, data: ECRPUBLIC.Types.SetRepositoryPolicyResponse) => void): Request<ECRPUBLIC.Types.SetRepositoryPolicyResponse, AWSError>; 174 /** 175 * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. 176 */ 177 tagResource(params: ECRPUBLIC.Types.TagResourceRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.TagResourceResponse) => void): Request<ECRPUBLIC.Types.TagResourceResponse, AWSError>; 178 /** 179 * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. 180 */ 181 tagResource(callback?: (err: AWSError, data: ECRPUBLIC.Types.TagResourceResponse) => void): Request<ECRPUBLIC.Types.TagResourceResponse, AWSError>; 182 /** 183 * Deletes specified tags from a resource. 184 */ 185 untagResource(params: ECRPUBLIC.Types.UntagResourceRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.UntagResourceResponse) => void): Request<ECRPUBLIC.Types.UntagResourceResponse, AWSError>; 186 /** 187 * Deletes specified tags from a resource. 188 */ 189 untagResource(callback?: (err: AWSError, data: ECRPUBLIC.Types.UntagResourceResponse) => void): Request<ECRPUBLIC.Types.UntagResourceResponse, AWSError>; 190 /** 191 * Uploads an image layer part to Amazon ECR. When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. 192 */ 193 uploadLayerPart(params: ECRPUBLIC.Types.UploadLayerPartRequest, callback?: (err: AWSError, data: ECRPUBLIC.Types.UploadLayerPartResponse) => void): Request<ECRPUBLIC.Types.UploadLayerPartResponse, AWSError>; 194 /** 195 * Uploads an image layer part to Amazon ECR. When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. 196 */ 197 uploadLayerPart(callback?: (err: AWSError, data: ECRPUBLIC.Types.UploadLayerPartResponse) => void): Request<ECRPUBLIC.Types.UploadLayerPartResponse, AWSError>; 198 } 199 declare namespace ECRPUBLIC { 200 export type AboutText = string; 201 export type Architecture = string; 202 export type ArchitectureList = Architecture[]; 203 export type Arn = string; 204 export interface AuthorizationData { 205 /** 206 * A base64-encoded string that contains authorization data for a public Amazon ECR registry. When the string is decoded, it is presented in the format user:password for public registry authentication using docker login. 207 */ 208 authorizationToken?: Base64; 209 /** 210 * The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours. 211 */ 212 expiresAt?: ExpirationTimestamp; 213 } 214 export type Base64 = string; 215 export interface BatchCheckLayerAvailabilityRequest { 216 /** 217 * The AWS account ID associated with the public registry that contains the image layers to check. If you do not specify a registry, the default public registry is assumed. 218 */ 219 registryId?: RegistryIdOrAlias; 220 /** 221 * The name of the repository that is associated with the image layers to check. 222 */ 223 repositoryName: RepositoryName; 224 /** 225 * The digests of the image layers to check. 226 */ 227 layerDigests: BatchedOperationLayerDigestList; 228 } 229 export interface BatchCheckLayerAvailabilityResponse { 230 /** 231 * A list of image layer objects corresponding to the image layer references in the request. 232 */ 233 layers?: LayerList; 234 /** 235 * Any failures associated with the call. 236 */ 237 failures?: LayerFailureList; 238 } 239 export interface BatchDeleteImageRequest { 240 /** 241 * The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default public registry is assumed. 242 */ 243 registryId?: RegistryId; 244 /** 245 * The repository in a public registry that contains the image to delete. 246 */ 247 repositoryName: RepositoryName; 248 /** 249 * A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest. 250 */ 251 imageIds: ImageIdentifierList; 252 } 253 export interface BatchDeleteImageResponse { 254 /** 255 * The image IDs of the deleted images. 256 */ 257 imageIds?: ImageIdentifierList; 258 /** 259 * Any failures associated with the call. 260 */ 261 failures?: ImageFailureList; 262 } 263 export type BatchedOperationLayerDigest = string; 264 export type BatchedOperationLayerDigestList = BatchedOperationLayerDigest[]; 265 export interface CompleteLayerUploadRequest { 266 /** 267 * The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default public registry is assumed. 268 */ 269 registryId?: RegistryIdOrAlias; 270 /** 271 * The name of the repository in a public registry to associate with the image layer. 272 */ 273 repositoryName: RepositoryName; 274 /** 275 * The upload ID from a previous InitiateLayerUpload operation to associate with the image layer. 276 */ 277 uploadId: UploadId; 278 /** 279 * The sha256 digest of the image layer. 280 */ 281 layerDigests: LayerDigestList; 282 } 283 export interface CompleteLayerUploadResponse { 284 /** 285 * The public registry ID associated with the request. 286 */ 287 registryId?: RegistryId; 288 /** 289 * The repository name associated with the request. 290 */ 291 repositoryName?: RepositoryName; 292 /** 293 * The upload ID associated with the layer. 294 */ 295 uploadId?: UploadId; 296 /** 297 * The sha256 digest of the image layer. 298 */ 299 layerDigest?: LayerDigest; 300 } 301 export interface CreateRepositoryRequest { 302 /** 303 * The name to use for the repository. This appears publicly in the Amazon ECR Public Gallery. 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). 304 */ 305 repositoryName: RepositoryName; 306 /** 307 * The details about the repository that are publicly visible in the Amazon ECR Public Gallery. 308 */ 309 catalogData?: RepositoryCatalogDataInput; 310 /** 311 * The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. 312 */ 313 tags?: TagList; 314 } 315 export interface CreateRepositoryResponse { 316 /** 317 * The repository that was created. 318 */ 319 repository?: Repository; 320 catalogData?: RepositoryCatalogData; 321 } 322 export type CreationTimestamp = Date; 323 export type DefaultRegistryAliasFlag = boolean; 324 export interface DeleteRepositoryPolicyRequest { 325 /** 326 * The AWS account ID associated with the public registry that contains the repository policy to delete. If you do not specify a registry, the default public registry is assumed. 327 */ 328 registryId?: RegistryId; 329 /** 330 * The name of the repository that is associated with the repository policy to delete. 331 */ 332 repositoryName: RepositoryName; 333 } 334 export interface DeleteRepositoryPolicyResponse { 335 /** 336 * The registry ID associated with the request. 337 */ 338 registryId?: RegistryId; 339 /** 340 * The repository name associated with the request. 341 */ 342 repositoryName?: RepositoryName; 343 /** 344 * The JSON repository policy that was deleted from the repository. 345 */ 346 policyText?: RepositoryPolicyText; 347 } 348 export interface DeleteRepositoryRequest { 349 /** 350 * The AWS account ID associated with the public registry that contains the repository to delete. If you do not specify a registry, the default public registry is assumed. 351 */ 352 registryId?: RegistryId; 353 /** 354 * The name of the repository to delete. 355 */ 356 repositoryName: RepositoryName; 357 /** 358 * If a repository contains images, forces the deletion. 359 */ 360 force?: ForceFlag; 361 } 362 export interface DeleteRepositoryResponse { 363 /** 364 * The repository that was deleted. 365 */ 366 repository?: Repository; 367 } 368 export interface DescribeImageTagsRequest { 369 /** 370 * The AWS account ID associated with the public registry that contains the repository in which to describe images. If you do not specify a registry, the default public registry is assumed. 371 */ 372 registryId?: RegistryId; 373 /** 374 * The name of the repository that contains the image tag details to describe. 375 */ 376 repositoryName: RepositoryName; 377 /** 378 * The nextToken value returned from a previous paginated DescribeImageTags 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. 379 */ 380 nextToken?: NextToken; 381 /** 382 * The maximum number of repository results returned by DescribeImageTags in paginated output. When this parameter is used, DescribeImageTags 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 DescribeImageTags request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageTags returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds. 383 */ 384 maxResults?: MaxResults; 385 } 386 export interface DescribeImageTagsResponse { 387 /** 388 * The image tag details for the images in the requested repository. 389 */ 390 imageTagDetails?: ImageTagDetailList; 391 /** 392 * The nextToken value to include in a future DescribeImageTags request. When the results of a DescribeImageTags 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. 393 */ 394 nextToken?: NextToken; 395 } 396 export interface DescribeImagesRequest { 397 /** 398 * The AWS account ID associated with the public registry that contains the repository in which to describe images. If you do not specify a registry, the default public registry is assumed. 399 */ 400 registryId?: RegistryId; 401 /** 402 * The repository that contains the images to describe. 403 */ 404 repositoryName: RepositoryName; 405 /** 406 * The list of image IDs for the requested repository. 407 */ 408 imageIds?: ImageIdentifierList; 409 /** 410 * 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. 411 */ 412 nextToken?: NextToken; 413 /** 414 * 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. 415 */ 416 maxResults?: MaxResults; 417 } 418 export interface DescribeImagesResponse { 419 /** 420 * A list of ImageDetail objects that contain data about the image. 421 */ 422 imageDetails?: ImageDetailList; 423 /** 424 * 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. 425 */ 426 nextToken?: NextToken; 427 } 428 export interface DescribeRegistriesRequest { 429 /** 430 * The nextToken value returned from a previous paginated DescribeRegistries 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. 431 */ 432 nextToken?: NextToken; 433 /** 434 * The maximum number of repository results returned by DescribeRegistries in paginated output. When this parameter is used, DescribeRegistries 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 DescribeRegistries request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRegistries returns up to 100 results and a nextToken value, if applicable. 435 */ 436 maxResults?: MaxResults; 437 } 438 export interface DescribeRegistriesResponse { 439 /** 440 * An object containing the details for a public registry. 441 */ 442 registries: RegistryList; 443 /** 444 * 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. 445 */ 446 nextToken?: NextToken; 447 } 448 export interface DescribeRepositoriesRequest { 449 /** 450 * The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed. 451 */ 452 registryId?: RegistryId; 453 /** 454 * A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described. 455 */ 456 repositoryNames?: RepositoryNameList; 457 /** 458 * 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. 459 */ 460 nextToken?: NextToken; 461 /** 462 * 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. 463 */ 464 maxResults?: MaxResults; 465 } 466 export interface DescribeRepositoriesResponse { 467 /** 468 * A list of repository objects corresponding to valid repositories. 469 */ 470 repositories?: RepositoryList; 471 /** 472 * 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. 473 */ 474 nextToken?: NextToken; 475 } 476 export type ExpirationTimestamp = Date; 477 export type ForceFlag = boolean; 478 export interface GetAuthorizationTokenRequest { 479 } 480 export interface GetAuthorizationTokenResponse { 481 /** 482 * An authorization token data object that corresponds to a public registry. 483 */ 484 authorizationData?: AuthorizationData; 485 } 486 export interface GetRegistryCatalogDataRequest { 487 } 488 export interface GetRegistryCatalogDataResponse { 489 /** 490 * The catalog metadata for the public registry. 491 */ 492 registryCatalogData: RegistryCatalogData; 493 } 494 export interface GetRepositoryCatalogDataRequest { 495 /** 496 * The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed. 497 */ 498 registryId?: RegistryId; 499 /** 500 * The name of the repository to retrieve the catalog metadata for. 501 */ 502 repositoryName: RepositoryName; 503 } 504 export interface GetRepositoryCatalogDataResponse { 505 /** 506 * The catalog metadata for the repository. 507 */ 508 catalogData?: RepositoryCatalogData; 509 } 510 export interface GetRepositoryPolicyRequest { 511 /** 512 * The AWS account ID associated with the public registry that contains the repository. If you do not specify a registry, the default public registry is assumed. 513 */ 514 registryId?: RegistryId; 515 /** 516 * The name of the repository with the policy to retrieve. 517 */ 518 repositoryName: RepositoryName; 519 } 520 export interface GetRepositoryPolicyResponse { 521 /** 522 * The registry ID associated with the request. 523 */ 524 registryId?: RegistryId; 525 /** 526 * The repository name associated with the request. 527 */ 528 repositoryName?: RepositoryName; 529 /** 530 * The repository policy text associated with the repository. The policy text will be in JSON format. 531 */ 532 policyText?: RepositoryPolicyText; 533 } 534 export interface Image { 535 /** 536 * The AWS account ID associated with the registry containing the image. 537 */ 538 registryId?: RegistryIdOrAlias; 539 /** 540 * The name of the repository associated with the image. 541 */ 542 repositoryName?: RepositoryName; 543 /** 544 * An object containing the image tag and image digest associated with an image. 545 */ 546 imageId?: ImageIdentifier; 547 /** 548 * The image manifest associated with the image. 549 */ 550 imageManifest?: ImageManifest; 551 /** 552 * The manifest media type of the image. 553 */ 554 imageManifestMediaType?: MediaType; 555 } 556 export interface ImageDetail { 557 /** 558 * The AWS account ID associated with the public registry to which this image belongs. 559 */ 560 registryId?: RegistryId; 561 /** 562 * The name of the repository to which this image belongs. 563 */ 564 repositoryName?: RepositoryName; 565 /** 566 * The sha256 digest of the image manifest. 567 */ 568 imageDigest?: ImageDigest; 569 /** 570 * The list of tags associated with this image. 571 */ 572 imageTags?: ImageTagList; 573 /** 574 * The size, in bytes, of the image in the repository. If the image is a manifest list, this will be the max size of all manifests in the list. 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. 575 */ 576 imageSizeInBytes?: ImageSizeInBytes; 577 /** 578 * The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository. 579 */ 580 imagePushedAt?: PushTimestamp; 581 /** 582 * The media type of the image manifest. 583 */ 584 imageManifestMediaType?: MediaType; 585 /** 586 * The artifact media type of the image. 587 */ 588 artifactMediaType?: MediaType; 589 } 590 export type ImageDetailList = ImageDetail[]; 591 export type ImageDigest = string; 592 export interface ImageFailure { 593 /** 594 * The image ID associated with the failure. 595 */ 596 imageId?: ImageIdentifier; 597 /** 598 * The code associated with the failure. 599 */ 600 failureCode?: ImageFailureCode; 601 /** 602 * The reason for the failure. 603 */ 604 failureReason?: ImageFailureReason; 605 } 606 export type ImageFailureCode = "InvalidImageDigest"|"InvalidImageTag"|"ImageTagDoesNotMatchDigest"|"ImageNotFound"|"MissingDigestAndTag"|"ImageReferencedByManifestList"|"KmsError"|string; 607 export type ImageFailureList = ImageFailure[]; 608 export type ImageFailureReason = string; 609 export interface ImageIdentifier { 610 /** 611 * The sha256 digest of the image manifest. 612 */ 613 imageDigest?: ImageDigest; 614 /** 615 * The tag used for the image. 616 */ 617 imageTag?: ImageTag; 618 } 619 export type ImageIdentifierList = ImageIdentifier[]; 620 export type ImageManifest = string; 621 export type ImageSizeInBytes = number; 622 export type ImageTag = string; 623 export interface ImageTagDetail { 624 /** 625 * The tag associated with the image. 626 */ 627 imageTag?: ImageTag; 628 /** 629 * The time stamp indicating when the image tag was created. 630 */ 631 createdAt?: CreationTimestamp; 632 /** 633 * An object that describes the details of an image. 634 */ 635 imageDetail?: ReferencedImageDetail; 636 } 637 export type ImageTagDetailList = ImageTagDetail[]; 638 export type ImageTagList = ImageTag[]; 639 export interface InitiateLayerUploadRequest { 640 /** 641 * The AWS account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default public registry is assumed. 642 */ 643 registryId?: RegistryIdOrAlias; 644 /** 645 * The name of the repository to which you intend to upload layers. 646 */ 647 repositoryName: RepositoryName; 648 } 649 export interface InitiateLayerUploadResponse { 650 /** 651 * The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations. 652 */ 653 uploadId?: UploadId; 654 /** 655 * The size, in bytes, that Amazon ECR expects future layer part uploads to be. 656 */ 657 partSize?: PartSize; 658 } 659 export interface Layer { 660 /** 661 * The sha256 digest of the image layer. 662 */ 663 layerDigest?: LayerDigest; 664 /** 665 * The availability status of the image layer. 666 */ 667 layerAvailability?: LayerAvailability; 668 /** 669 * The size, in bytes, of the image layer. 670 */ 671 layerSize?: LayerSizeInBytes; 672 /** 673 * 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. 674 */ 675 mediaType?: MediaType; 676 } 677 export type LayerAvailability = "AVAILABLE"|"UNAVAILABLE"|string; 678 export type LayerDigest = string; 679 export type LayerDigestList = LayerDigest[]; 680 export interface LayerFailure { 681 /** 682 * The layer digest associated with the failure. 683 */ 684 layerDigest?: BatchedOperationLayerDigest; 685 /** 686 * The failure code associated with the failure. 687 */ 688 failureCode?: LayerFailureCode; 689 /** 690 * The reason for the failure. 691 */ 692 failureReason?: LayerFailureReason; 693 } 694 export type LayerFailureCode = "InvalidLayerDigest"|"MissingLayerDigest"|string; 695 export type LayerFailureList = LayerFailure[]; 696 export type LayerFailureReason = string; 697 export type LayerList = Layer[]; 698 export type LayerPartBlob = Buffer|Uint8Array|Blob|string; 699 export type LayerSizeInBytes = number; 700 export interface ListTagsForResourceRequest { 701 /** 702 * The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resource is an Amazon ECR Public repository. 703 */ 704 resourceArn: Arn; 705 } 706 export interface ListTagsForResourceResponse { 707 /** 708 * The tags for the resource. 709 */ 710 tags?: TagList; 711 } 712 export type LogoImageBlob = Buffer|Uint8Array|Blob|string; 713 export type MarketplaceCertified = boolean; 714 export type MaxResults = number; 715 export type MediaType = string; 716 export type NextToken = string; 717 export type OperatingSystem = string; 718 export type OperatingSystemList = OperatingSystem[]; 719 export type PartSize = number; 720 export type PrimaryRegistryAliasFlag = boolean; 721 export type PushTimestamp = Date; 722 export interface PutImageRequest { 723 /** 724 * The AWS account ID associated with the public registry that contains the repository in which to put the image. If you do not specify a registry, the default public registry is assumed. 725 */ 726 registryId?: RegistryIdOrAlias; 727 /** 728 * The name of the repository in which to put the image. 729 */ 730 repositoryName: RepositoryName; 731 /** 732 * The image manifest corresponding to the image to be uploaded. 733 */ 734 imageManifest: ImageManifest; 735 /** 736 * The media type of the image manifest. If you push an image manifest that does not contain the mediaType field, you must specify the imageManifestMediaType in the request. 737 */ 738 imageManifestMediaType?: MediaType; 739 /** 740 * The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats. 741 */ 742 imageTag?: ImageTag; 743 /** 744 * The image digest of the image manifest corresponding to the image. 745 */ 746 imageDigest?: ImageDigest; 747 } 748 export interface PutImageResponse { 749 /** 750 * Details of the image uploaded. 751 */ 752 image?: Image; 753 } 754 export interface PutRegistryCatalogDataRequest { 755 /** 756 * The display name for a public registry. The display name is shown as the repository author in the Amazon ECR Public Gallery. The registry display name is only publicly visible in the Amazon ECR Public Gallery for verified accounts. 757 */ 758 displayName?: RegistryDisplayName; 759 } 760 export interface PutRegistryCatalogDataResponse { 761 /** 762 * The catalog data for the public registry. 763 */ 764 registryCatalogData: RegistryCatalogData; 765 } 766 export interface PutRepositoryCatalogDataRequest { 767 /** 768 * The AWS account ID associated with the public registry the repository is in. If you do not specify a registry, the default public registry is assumed. 769 */ 770 registryId?: RegistryId; 771 /** 772 * The name of the repository to create or update the catalog data for. 773 */ 774 repositoryName: RepositoryName; 775 /** 776 * An object containing the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery. 777 */ 778 catalogData: RepositoryCatalogDataInput; 779 } 780 export interface PutRepositoryCatalogDataResponse { 781 /** 782 * The catalog data for the repository. 783 */ 784 catalogData?: RepositoryCatalogData; 785 } 786 export interface ReferencedImageDetail { 787 /** 788 * The sha256 digest of the image manifest. 789 */ 790 imageDigest?: ImageDigest; 791 /** 792 * The size, in bytes, of the image in the repository. If the image is a manifest list, this will be the max size of all manifests in the list. 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. 793 */ 794 imageSizeInBytes?: ImageSizeInBytes; 795 /** 796 * The date and time, expressed in standard JavaScript date format, at which the current image tag was pushed to the repository. 797 */ 798 imagePushedAt?: PushTimestamp; 799 /** 800 * The media type of the image manifest. 801 */ 802 imageManifestMediaType?: MediaType; 803 /** 804 * The artifact media type of the image. 805 */ 806 artifactMediaType?: MediaType; 807 } 808 export interface Registry { 809 /** 810 * The AWS account ID associated with the registry. If you do not specify a registry, the default public registry is assumed. 811 */ 812 registryId: RegistryId; 813 /** 814 * The Amazon Resource Name (ARN) of the public registry. 815 */ 816 registryArn: Arn; 817 /** 818 * The URI of a public registry. The URI contains a universal prefix and the registry alias. 819 */ 820 registryUri: Url; 821 /** 822 * Whether the account is verified. This indicates whether the account is an AWS Marketplace vendor. If an account is verified, each public repository will received a verified account badge on the Amazon ECR Public Gallery. 823 */ 824 verified: RegistryVerified; 825 /** 826 * An array of objects representing the aliases for a public registry. 827 */ 828 aliases: RegistryAliasList; 829 } 830 export interface RegistryAlias { 831 /** 832 * The name of the registry alias. 833 */ 834 name: RegistryAliasName; 835 /** 836 * The status of the registry alias. 837 */ 838 status: RegistryAliasStatus; 839 /** 840 * Whether or not the registry alias is the primary alias for the registry. If true, the alias is the primary registry alias and is displayed in both the repository URL and the image URI used in the docker pull commands on the Amazon ECR Public Gallery. A registry alias that is not the primary registry alias can be used in the repository URI in a docker pull command. 841 */ 842 primaryRegistryAlias: PrimaryRegistryAliasFlag; 843 /** 844 * Whether or not the registry alias is the default alias for the registry. When the first public repository is created, your public registry is assigned a default registry alias. 845 */ 846 defaultRegistryAlias: DefaultRegistryAliasFlag; 847 } 848 export type RegistryAliasList = RegistryAlias[]; 849 export type RegistryAliasName = string; 850 export type RegistryAliasStatus = "ACTIVE"|"PENDING"|"REJECTED"|string; 851 export interface RegistryCatalogData { 852 /** 853 * The display name for a public registry. This appears on the Amazon ECR Public Gallery. Only accounts that have the verified account badge can have a registry display name. 854 */ 855 displayName?: RegistryDisplayName; 856 } 857 export type RegistryDisplayName = string; 858 export type RegistryId = string; 859 export type RegistryIdOrAlias = string; 860 export type RegistryList = Registry[]; 861 export type RegistryVerified = boolean; 862 export interface Repository { 863 /** 864 * 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. 865 */ 866 repositoryArn?: Arn; 867 /** 868 * The AWS account ID associated with the public registry that contains the repository. 869 */ 870 registryId?: RegistryId; 871 /** 872 * The name of the repository. 873 */ 874 repositoryName?: RepositoryName; 875 /** 876 * The URI for the repository. You can use this URI for container image push and pull operations. 877 */ 878 repositoryUri?: Url; 879 /** 880 * The date and time, in JavaScript date format, when the repository was created. 881 */ 882 createdAt?: CreationTimestamp; 883 } 884 export interface RepositoryCatalogData { 885 /** 886 * The short description of the repository. 887 */ 888 description?: RepositoryDescription; 889 /** 890 * The architecture tags that are associated with the repository. Only supported operating system tags appear publicly in the Amazon ECR Public Gallery. For more information, see RepositoryCatalogDataInput. 891 */ 892 architectures?: ArchitectureList; 893 /** 894 * The operating system tags that are associated with the repository. Only supported operating system tags appear publicly in the Amazon ECR Public Gallery. For more information, see RepositoryCatalogDataInput. 895 */ 896 operatingSystems?: OperatingSystemList; 897 /** 898 * The URL containing the logo associated with the repository. 899 */ 900 logoUrl?: ResourceUrl; 901 /** 902 * The longform description of the contents of the repository. This text appears in the repository details on the Amazon ECR Public Gallery. 903 */ 904 aboutText?: AboutText; 905 /** 906 * The longform usage details of the contents of the repository. The usage text provides context for users of the repository. 907 */ 908 usageText?: UsageText; 909 /** 910 * Whether or not the repository is certified by AWS Marketplace. 911 */ 912 marketplaceCertified?: MarketplaceCertified; 913 } 914 export interface RepositoryCatalogDataInput { 915 /** 916 * A short description of the contents of the repository. This text appears in both the image details and also when searching for repositories on the Amazon ECR Public Gallery. 917 */ 918 description?: RepositoryDescription; 919 /** 920 * The system architecture that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported architectures will appear as badges on the repository and are used as search filters. Linux Windows If an unsupported tag is added to your repository catalog data, it will be associated with the repository and can be retrieved using the API but will not be discoverable in the Amazon ECR Public Gallery. 921 */ 922 architectures?: ArchitectureList; 923 /** 924 * The operating systems that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported operating systems will appear as badges on the repository and are used as search filters. ARM ARM 64 x86 x86-64 If an unsupported tag is added to your repository catalog data, it will be associated with the repository and can be retrieved using the API but will not be discoverable in the Amazon ECR Public Gallery. 925 */ 926 operatingSystems?: OperatingSystemList; 927 /** 928 * The base64-encoded repository logo payload. The repository logo is only publicly visible in the Amazon ECR Public Gallery for verified accounts. 929 */ 930 logoImageBlob?: LogoImageBlob; 931 /** 932 * A detailed description of the contents of the repository. It is publicly visible in the Amazon ECR Public Gallery. The text must be in markdown format. 933 */ 934 aboutText?: AboutText; 935 /** 936 * Detailed information on how to use the contents of the repository. It is publicly visible in the Amazon ECR Public Gallery. The usage text provides context, support information, and additional usage details for users of the repository. The text must be in markdown format. 937 */ 938 usageText?: UsageText; 939 } 940 export type RepositoryDescription = string; 941 export type RepositoryList = Repository[]; 942 export type RepositoryName = string; 943 export type RepositoryNameList = RepositoryName[]; 944 export type RepositoryPolicyText = string; 945 export type ResourceUrl = string; 946 export interface SetRepositoryPolicyRequest { 947 /** 948 * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default public registry is assumed. 949 */ 950 registryId?: RegistryId; 951 /** 952 * The name of the repository to receive the policy. 953 */ 954 repositoryName: RepositoryName; 955 /** 956 * The JSON repository policy text to apply to the repository. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide. 957 */ 958 policyText: RepositoryPolicyText; 959 /** 960 * 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. 961 */ 962 force?: ForceFlag; 963 } 964 export interface SetRepositoryPolicyResponse { 965 /** 966 * The registry ID associated with the request. 967 */ 968 registryId?: RegistryId; 969 /** 970 * The repository name associated with the request. 971 */ 972 repositoryName?: RepositoryName; 973 /** 974 * The JSON repository policy text applied to the repository. 975 */ 976 policyText?: RepositoryPolicyText; 977 } 978 export interface Tag { 979 /** 980 * 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. 981 */ 982 Key?: TagKey; 983 /** 984 * The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). 985 */ 986 Value?: TagValue; 987 } 988 export type TagKey = string; 989 export type TagKeyList = TagKey[]; 990 export type TagList = Tag[]; 991 export interface TagResourceRequest { 992 /** 993 * The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resource is an Amazon ECR Public repository. 994 */ 995 resourceArn: Arn; 996 /** 997 * 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. 998 */ 999 tags: TagList; 1000 } 1001 export interface TagResourceResponse { 1002 } 1003 export type TagValue = string; 1004 export interface UntagResourceRequest { 1005 /** 1006 * The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resource is an Amazon ECR Public repository. 1007 */ 1008 resourceArn: Arn; 1009 /** 1010 * The keys of the tags to be removed. 1011 */ 1012 tagKeys: TagKeyList; 1013 } 1014 export interface UntagResourceResponse { 1015 } 1016 export type UploadId = string; 1017 export interface UploadLayerPartRequest { 1018 /** 1019 * The AWS account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default public registry is assumed. 1020 */ 1021 registryId?: RegistryIdOrAlias; 1022 /** 1023 * The name of the repository to which you are uploading layer parts. 1024 */ 1025 repositoryName: RepositoryName; 1026 /** 1027 * The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload. 1028 */ 1029 uploadId: UploadId; 1030 /** 1031 * The position of the first byte of the layer part witin the overall image layer. 1032 */ 1033 partFirstByte: PartSize; 1034 /** 1035 * The position of the last byte of the layer part within the overall image layer. 1036 */ 1037 partLastByte: PartSize; 1038 /** 1039 * The base64-encoded layer part payload. 1040 */ 1041 layerPartBlob: LayerPartBlob; 1042 } 1043 export interface UploadLayerPartResponse { 1044 /** 1045 * The registry ID associated with the request. 1046 */ 1047 registryId?: RegistryId; 1048 /** 1049 * The repository name associated with the request. 1050 */ 1051 repositoryName?: RepositoryName; 1052 /** 1053 * The upload ID associated with the request. 1054 */ 1055 uploadId?: UploadId; 1056 /** 1057 * The integer value of the last byte received in the request. 1058 */ 1059 lastByteReceived?: PartSize; 1060 } 1061 export type Url = string; 1062 export type UsageText = string; 1063 /** 1064 * 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. 1065 */ 1066 export type apiVersion = "2020-10-30"|"latest"|string; 1067 export interface ClientApiVersions { 1068 /** 1069 * 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. 1070 */ 1071 apiVersion?: apiVersion; 1072 } 1073 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1074 /** 1075 * Contains interfaces for use with the ECRPUBLIC client. 1076 */ 1077 export import Types = ECRPUBLIC; 1078 } 1079 export = ECRPUBLIC;