|
1 | 1 | { |
2 | 2 | "version": "2.0", |
3 | | - "service": "<fullname>Amazon Elastic Container Registry</fullname> <p>Amazon Elastic Container Registry (Amazon ECR) is a managed Docker registry service. Customers can use the familiar Docker CLI to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon ECR supports private Docker repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images. Developers can use the Docker CLI to author and manage images.</p>", |
| 3 | + "service": "<fullname>Amazon Elastic Container Registry</fullname> <p>Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports private repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images.</p>", |
4 | 4 | "operations": { |
5 | 5 | "BatchCheckLayerAvailability": "<p>Checks the availability of one or more image layers in a repository.</p> <p>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.</p> <note> <p>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 <code>docker</code> CLI to pull, tag, and push images.</p> </note>", |
6 | 6 | "BatchDeleteImage": "<p>Deletes a list of specified images within a repository. Images are specified with either an <code>imageTag</code> or <code>imageDigest</code>.</p> <p>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.</p> <p>You can completely delete an image (and all of its tags) by specifying the image's digest in your request.</p>", |
|
224 | 224 | "refs": { |
225 | 225 | } |
226 | 226 | }, |
| 227 | + "EncryptionConfiguration": { |
| 228 | + "base": "<p>The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.</p> <p>By default, when no encryption configuration is set or the <code>AES256</code> encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.</p> <p>For more control over the encryption of the contents of your repository, you can use server-side encryption with customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) to encrypt your images. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html\">Amazon ECR encryption at rest</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>", |
| 229 | + "refs": { |
| 230 | + "CreateRepositoryRequest$encryptionConfiguration": "<p>The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.</p>", |
| 231 | + "Repository$encryptionConfiguration": "<p>The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.</p>" |
| 232 | + } |
| 233 | + }, |
| 234 | + "EncryptionType": { |
| 235 | + "base": null, |
| 236 | + "refs": { |
| 237 | + "EncryptionConfiguration$encryptionType": "<p>The encryption type to use.</p> <p>If you use the <code>KMS</code> encryption type, the contents of the repository will be encrypted using server-side encryption with customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with CMKs Stored in AWS Key Management Service (SSE-KMS)</a> in the <i>Amazon Simple Storage Service Console Developer Guide.</i>.</p> <p>If you use the <code>AES256</code> encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html\">Protecting Data Using Server-Side Encryption with Amazon S3-Managed Encryption Keys (SSE-S3)</a> in the <i>Amazon Simple Storage Service Console Developer Guide.</i>.</p>" |
| 238 | + } |
| 239 | + }, |
227 | 240 | "EvaluationTimestamp": { |
228 | 241 | "base": null, |
229 | 242 | "refs": { |
|
243 | 256 | "InvalidLayerPartException$message": "<p>The error message associated with the exception.</p>", |
244 | 257 | "InvalidParameterException$message": "<p>The error message associated with the exception.</p>", |
245 | 258 | "InvalidTagParameterException$message": null, |
| 259 | + "KmsException$message": null, |
246 | 260 | "LayerAlreadyExistsException$message": "<p>The error message associated with the exception.</p>", |
247 | 261 | "LayerInaccessibleException$message": "<p>The error message associated with the exception.</p>", |
248 | 262 | "LayerPartTooSmallException$message": "<p>The error message associated with the exception.</p>", |
|
509 | 523 | "ImageScanningConfiguration": { |
510 | 524 | "base": "<p>The image scanning configuration for a repository.</p>", |
511 | 525 | "refs": { |
512 | | - "CreateRepositoryRequest$imageScanningConfiguration": "<p>The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.</p>", |
| 526 | + "CreateRepositoryRequest$imageScanningConfiguration": "<p>The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.</p>", |
513 | 527 | "PutImageScanningConfigurationRequest$imageScanningConfiguration": "<p>The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.</p>", |
514 | 528 | "PutImageScanningConfigurationResponse$imageScanningConfiguration": "<p>The image scanning configuration setting for the repository.</p>", |
515 | 529 | "Repository$imageScanningConfiguration": null |
|
526 | 540 | "refs": { |
527 | 541 | "ImageIdentifier$imageTag": "<p>The tag used for the image.</p>", |
528 | 542 | "ImageTagList$member": null, |
529 | | - "PutImageRequest$imageTag": "<p>The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or OCI formats.</p>" |
| 543 | + "PutImageRequest$imageTag": "<p>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.</p>" |
530 | 544 | } |
531 | 545 | }, |
532 | 546 | "ImageTagAlreadyExistsException": { |
|
580 | 594 | "refs": { |
581 | 595 | } |
582 | 596 | }, |
| 597 | + "KmsError": { |
| 598 | + "base": null, |
| 599 | + "refs": { |
| 600 | + "KmsException$kmsError": "<p>The error code returned by AWS KMS.</p>" |
| 601 | + } |
| 602 | + }, |
| 603 | + "KmsException": { |
| 604 | + "base": "<p>The operation failed due to a KMS exception.</p>", |
| 605 | + "refs": { |
| 606 | + } |
| 607 | + }, |
| 608 | + "KmsKey": { |
| 609 | + "base": null, |
| 610 | + "refs": { |
| 611 | + "EncryptionConfiguration$kmsKey": "<p>If you use the <code>KMS</code> encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.</p>" |
| 612 | + } |
| 613 | + }, |
583 | 614 | "Layer": { |
584 | 615 | "base": "<p>An object representing an Amazon ECR image layer.</p>", |
585 | 616 | "refs": { |
|
682 | 713 | } |
683 | 714 | }, |
684 | 715 | "LifecyclePolicyPreviewInProgressException": { |
685 | | - "base": "<p>The previous lifecycle policy preview request has not completed. Please try again later.</p>", |
| 716 | + "base": "<p>The previous lifecycle policy preview request has not completed. Wait and try again.</p>", |
686 | 717 | "refs": { |
687 | 718 | } |
688 | 719 | }, |
|
1193 | 1224 | } |
1194 | 1225 | }, |
1195 | 1226 | "UploadNotFoundException": { |
1196 | | - "base": "<p>The upload could not be found, or the specified upload id is not valid for this repository.</p>", |
| 1227 | + "base": "<p>The upload could not be found, or the specified upload ID is not valid for this repository.</p>", |
1197 | 1228 | "refs": { |
1198 | 1229 | } |
1199 | 1230 | }, |
|
1202 | 1233 | "refs": { |
1203 | 1234 | "GetDownloadUrlForLayerResponse$downloadUrl": "<p>The pre-signed Amazon S3 download URL for the requested layer.</p>", |
1204 | 1235 | "ImageScanFinding$uri": "<p>A link containing additional details about the security vulnerability.</p>", |
1205 | | - "Repository$repositoryUri": "<p>The URI for the repository. You can use this URI for Docker <code>push</code> or <code>pull</code> operations.</p>" |
| 1236 | + "Repository$repositoryUri": "<p>The URI for the repository. You can use this URI for container image <code>push</code> and <code>pull</code> operations.</p>" |
1206 | 1237 | } |
1207 | 1238 | }, |
1208 | 1239 | "VulnerabilitySourceUpdateTimestamp": { |
|
0 commit comments